Top Description Inners Fields Constructors Methods
org.hibernate.engine.jdbc

public Class ResultSetWrapperProxy

extends Object
implements InvocationHandler
Class Inheritance
All Implemented Interfaces
java.lang.reflect.InvocationHandler
Annotations
@Deprecated
Static Imports
org.hibernate.internal.CoreLogging.messageLogger

Deprecated

(since 5.5) Scheduled for removal in 6.0 as ResultSet wrapping is no longer needed

A proxy for a ResultSet delegate, responsible for locally caching the columnName-to-columnIndex resolution that has been found to be inefficient in a few vendor's drivers (i.e., Oracle and Postgres).
Authors
Steve Ebersole, Gail Badner

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class

Field Summary

Modifier and TypeField and Description
private final ColumnNameCache
columnNameCache

Deprecated as a consequence of ColumnNameCache being deprecated.
private static final CoreMessageLogger
private static final Map<ResultSetWrapperProxy.ResultSetMethodKey, Method>
private final ResultSet
private static final SqlExceptionHelper

Constructor Summary

AccessConstructor and Description
private
ResultSetWrapperProxy(ResultSet rs, ColumnNameCache columnNameCache)

Deprecated as a consequence of ColumnNameCache being deprecated.

Method Summary

Modifier and TypeMethod and Description
private Object[]
buildColumnIndexMethodArgs(Object[] incomingArgs, Integer columnIndex)

private Integer

Returns:

The column index corresponding to the given column name.
findColumn
(String
The column name to resolve into an index.
columnName
)

Locate the column index corresponding to the given column name via the cache.

public static ResultSet

Returns:

The generated proxy.
generateProxy
(ResultSet
The resultSet to wrap.
resultSet
,
ColumnNameCache
The cache storing data for converting column names to column indexes.
columnNameCache
,
ServiceRegistry
Access to any needed services
serviceRegistry
)

Deprecated as a consequence of ColumnNameCache being deprecated.
Generates a proxy wrapping the ResultSet.
public Object
invoke(Object
the proxy instance that the method was invoked on
proxy
,
Method
the Method instance corresponding to the interface method invoked on the proxy instance. The declaring class of the Method object will be the interface that the method was declared in, which may be a superinterface of the proxy interface that the proxy class inherits the method through.
method
,
Object[]
an array of objects containing the values of the arguments passed in the method invocation on the proxy instance, or null if interface method takes no arguments. Arguments of primitive types are wrapped in instances of the appropriate primitive wrapper class, such as java.lang.Integer or java.lang.Boolean.
args
)

Implements java.lang.reflect.InvocationHandler.invoke.

Processes a method invocation on a proxy instance and returns the result.
private Object
invokeMethod(Method method, Object[] args)

private static boolean
private static Method

Returns:

The corresponding method passed the column index.
locateCorrespondingColumnIndexMethod
(Method
The method passed the column name
columnNameMethod
)

For a given ResultSet method passed a column name, locate the corresponding method passed the same parameters but the column index.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

columnNameCacheback to summary
private final ColumnNameCache columnNameCache

Deprecated

as a consequence of ColumnNameCache being deprecated. See corresponding docs for further information.

LOGback to summary
private static final CoreMessageLogger LOG
NAME_TO_INDEX_METHOD_MAPPINGback to summary
private static final Map<ResultSetWrapperProxy.ResultSetMethodKey, Method> NAME_TO_INDEX_METHOD_MAPPING
rsback to summary
private final ResultSet rs
SQL_EXCEPTION_HELPERback to summary
private static final SqlExceptionHelper SQL_EXCEPTION_HELPER

Constructor Detail

ResultSetWrapperProxyback to summary
private ResultSetWrapperProxy(ResultSet rs, ColumnNameCache columnNameCache)

Deprecated

as a consequence of ColumnNameCache being deprecated. See corresponding docs for further information.

Method Detail

buildColumnIndexMethodArgsback to summary
private Object[] buildColumnIndexMethodArgs(Object[] incomingArgs, Integer columnIndex)
findColumnback to summary
private Integer findColumn(String columnName) throws SQLException

Locate the column index corresponding to the given column name via the cache.

Parameters
columnName:String

The column name to resolve into an index.

Returns:Integer

The column index corresponding to the given column name.

Exceptions
SQLException:
if the ResultSet object does not contain columnName or a database access error occurs
generateProxyback to summary
public static ResultSet generateProxy(ResultSet resultSet, ColumnNameCache columnNameCache, ServiceRegistry serviceRegistry)

Deprecated

as a consequence of ColumnNameCache being deprecated. See corresponding docs for further information.

Generates a proxy wrapping the ResultSet.

Parameters
resultSet:ResultSet

The resultSet to wrap.

columnNameCache:ColumnNameCache

The cache storing data for converting column names to column indexes.

serviceRegistry:ServiceRegistry

Access to any needed services

Returns:ResultSet

The generated proxy.

invokeback to summary
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable

Implements java.lang.reflect.InvocationHandler.invoke.

Doc from java.lang.reflect.InvocationHandler.invoke.

Processes a method invocation on a proxy instance and returns the result. This method will be invoked on an invocation handler when a method is invoked on a proxy instance that it is associated with.

Parameters
proxy:Object

the proxy instance that the method was invoked on

method:Method

the Method instance corresponding to the interface method invoked on the proxy instance. The declaring class of the Method object will be the interface that the method was declared in, which may be a superinterface of the proxy interface that the proxy class inherits the method through.

args:Object[]

an array of objects containing the values of the arguments passed in the method invocation on the proxy instance, or null if interface method takes no arguments. Arguments of primitive types are wrapped in instances of the appropriate primitive wrapper class, such as java.lang.Integer or java.lang.Boolean.

Returns:Object

the value to return from the method invocation on the proxy instance. If the declared return type of the interface method is a primitive type, then the value returned by this method must be an instance of the corresponding primitive wrapper class; otherwise, it must be a type assignable to the declared return type. If the value returned by this method is null and the interface method's return type is primitive, then a NullPointerException will be thrown by the method invocation on the proxy instance. If the value returned by this method is otherwise not compatible with the interface method's declared return type as described above, a ClassCastException will be thrown by the method invocation on the proxy instance.

Annotations
@Override
Exceptions
Throwable:
the exception to throw from the method invocation on the proxy instance. The exception's type must be assignable either to any of the exception types declared in the throws clause of the interface method or to the unchecked exception types java.lang.RuntimeException or java.lang.Error. If a checked exception is thrown by this method that is not assignable to any of the exception types declared in the throws clause of the interface method, then an UndeclaredThrowableException containing the exception that was thrown by this method will be thrown by the method invocation on the proxy instance.
invokeMethodback to summary
private Object invokeMethod(Method method, Object[] args) throws Throwable
isFirstArgColumnLabelback to summary
private static boolean isFirstArgColumnLabel(Method method)
locateCorrespondingColumnIndexMethodback to summary
private static Method locateCorrespondingColumnIndexMethod(Method columnNameMethod) throws NoSuchMethodException

For a given ResultSet method passed a column name, locate the corresponding method passed the same parameters but the column index.

Parameters
columnNameMethod:Method

The method passed the column name

Returns:Method

The corresponding method passed the column index.

Exceptions
NoSuchMethodException:
Should never happen, but...
org.hibernate.engine.jdbc back to summary

private Class ResultSetWrapperProxy.ResultSetMethodKey

extends Object
Class Inheritance
  • java.lang.Object
  • org.hibernate.engine.jdbc.ResultSetWrapperProxy.ResultSetMethodKey

Field Summary

Modifier and TypeField and Description
private String
private Class<?>[]

Constructor Summary

AccessConstructor and Description
public
ResultSetMethodKey(String methodName, Class<?>[] parameterTypes)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
obj
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

methodNameback to summary
private String methodName
parameterTypesback to summary
private Class<?>[] parameterTypes

Constructor Detail

ResultSetMethodKeyback to summary
public ResultSetMethodKey(String methodName, Class<?>[] parameterTypes)

Method Detail

equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override