Hibernate ORM - hibernate-core 5.6.15.Final · org.hibernate.transform.CacheableResultTransformer

Modifier and Type	Field and Description
private static final PassThroughResultTransformer	ACTUAL_TRANSFORMER
private final int[]	includeInTransformIndex
private final boolean[]	includeInTuple
private final int	tupleLength
private final int	tupleSubsetLength

Access	Constructor and Description
private	CacheableResultTransformer(boolean[] includeInTuple, boolean[] includeInTransform)

Method Summary

Modifier and Type	Method and Description
public static CacheableResultTransformer	Returns: a CacheableResultTransformer that is used to transform tuples to a value(s) that can be cached. create(ResultTransformer - result transformer that will ultimately be be used (after caching results) transformer, String[] - the aliases that correspond to the tuple; if it is non-null, its length must equal the number of true elements in includeInTuple[] aliases, boolean[] - array with the i-th element indicating whether the i-th expression returned by a query is included in the tuple; the number of true values equals the length of the tuple that will be transformed; must be non-null includeInTuple) Returns a CacheableResultTransformer that is used to transform tuples to a value(s) that can be cached.
private static CacheableResultTransformer	Returns: a CacheableResultTransformer that is used to transform tuples to a value(s) that can be cached. create(TupleSubsetResultTransformer - a tuple subset result transformer; must be non-null; transformer, String[] - the aliases that correspond to the tuple; if it is non-null, its length must equal the number of true elements in includeInTuple[] aliases, boolean[] - array with the i-th element indicating whether the i-th expression returned by a query is included in the tuple; the number of true values equals the length of the tuple that will be transformed; must be non-null includeInTuple) Returns a CacheableResultTransformer that is used to transform tuples to a value(s) that can be cached.
private static CacheableResultTransformer	Returns: a CacheableResultTransformer that is used to transform tuples to a value(s) that can be cached. create(boolean[] - array with the i-th element indicating whether the i-th expression returned by a query is included in the tuple; the number of true values equals the length of the tuple that will be transformed; must be non-null includeInTuple) Returns a CacheableResultTransformer that is used to transform tuples to a value(s) that can be cached.
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public Type[]	getCachedResultTypes(Type[] tupleResultTypes)
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
private <T> T[]	index(Class<? extends T[]> clazz, T[] objects)
public List<E>	Returns: transformedResults, with each element re-transformed (if necessary) retransformResults(List<E> - results that were previously transformed transformedResults, String[] - the aliases that correspond to the untransformed tuple; aliases, ResultTransformer - the transformer for the re-transformation transformer, boolean[] indicates the indexes of includeInTuple) Re-transforms, if necessary, a List of values previously transformed by this (or an equivalent) CacheableResultTransformer.
public List<E>	transformList(List<E> The result. list) Implements org.hibernate.transform.ResultTransformer.transformList. Here we have an opportunity to perform transformation on the query result as a whole.
public Object	transformTuple(Object[] The result elements tuple, String[] The result aliases ("parallel" array to tuple) aliases) Implements org.hibernate.transform.ResultTransformer.transformTuple. Tuples are the elements making up each "row" of the query result.
private <T> T[]	unindex(Class<? extends T[]> clazz, T[] objects)
public List<E>	Returns: results, with each element untransformed (if necessary) untransformToTuples(List<E> - results that were previously transformed results) Untransforms, if necessary, a List of values previously transformed by this (or an equivalent) CacheableResultTransformer.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

ACTUAL_TRANSFORMER	back to summary
private static final PassThroughResultTransformer ACTUAL_TRANSFORMER

includeInTransformIndex	back to summary
private final int[] includeInTransformIndex

includeInTuple	back to summary
private final boolean[] includeInTuple

tupleLength	back to summary
private final int tupleLength

tupleSubsetLength	back to summary
private final int tupleSubsetLength

CacheableResultTransformer	back to summary
private CacheableResultTransformer(boolean[] includeInTuple, boolean[] includeInTransform)

Method Detail

create	back to summary
public static CacheableResultTransformer create(ResultTransformer transformer, String[] aliases, boolean[] includeInTuple) Returns a CacheableResultTransformer that is used to transform tuples to a value(s) that can be cached. Parameters transformer:ResultTransformer - result transformer that will ultimately be be used (after caching results) aliases:String[] - the aliases that correspond to the tuple; if it is non-null, its length must equal the number of true elements in includeInTuple[] includeInTuple:boolean[] - array with the i-th element indicating whether the i-th expression returned by a query is included in the tuple; the number of true values equals the length of the tuple that will be transformed; must be non-null Returns:CacheableResultTransformer a CacheableResultTransformer that is used to transform tuples to a value(s) that can be cached.

create

back to summary

public static CacheableResultTransformer create(ResultTransformer transformer, String[] aliases, boolean[] includeInTuple)

Returns a CacheableResultTransformer that is used to transform tuples to a value(s) that can be cached.

Parameters

transformer:ResultTransformer: - result transformer that will ultimately be be used (after caching results)
aliases:String[]: - the aliases that correspond to the tuple; if it is non-null, its length must equal the number of true elements in includeInTuple[]
includeInTuple:boolean[]: - array with the i-th element indicating whether the i-th expression returned by a query is included in the tuple; the number of true values equals the length of the tuple that will be transformed; must be non-null

Returns:CacheableResultTransformer

a CacheableResultTransformer that is used to transform tuples to a value(s) that can be cached.

create	back to summary
private static CacheableResultTransformer create(TupleSubsetResultTransformer transformer, String[] aliases, boolean[] includeInTuple) Returns a CacheableResultTransformer that is used to transform tuples to a value(s) that can be cached. Parameters transformer:TupleSubsetResultTransformer - a tuple subset result transformer; must be non-null; aliases:String[] - the aliases that correspond to the tuple; if it is non-null, its length must equal the number of true elements in includeInTuple[] includeInTuple:boolean[] - array with the i-th element indicating whether the i-th expression returned by a query is included in the tuple; the number of true values equals the length of the tuple that will be transformed; must be non-null Returns:CacheableResultTransformer a CacheableResultTransformer that is used to transform tuples to a value(s) that can be cached.

create

back to summary

private static CacheableResultTransformer create(TupleSubsetResultTransformer transformer, String[] aliases, boolean[] includeInTuple)

Returns a CacheableResultTransformer that is used to transform tuples to a value(s) that can be cached.

Parameters

transformer:TupleSubsetResultTransformer: - a tuple subset result transformer; must be non-null;
aliases:String[]: - the aliases that correspond to the tuple; if it is non-null, its length must equal the number of true elements in includeInTuple[]
includeInTuple:boolean[]: - array with the i-th element indicating whether the i-th expression returned by a query is included in the tuple; the number of true values equals the length of the tuple that will be transformed; must be non-null

Returns:CacheableResultTransformer

a CacheableResultTransformer that is used to transform tuples to a value(s) that can be cached.

create	back to summary
private static CacheableResultTransformer create(boolean[] includeInTuple) Returns a CacheableResultTransformer that is used to transform tuples to a value(s) that can be cached. Parameters includeInTuple:boolean[] - array with the i-th element indicating whether the i-th expression returned by a query is included in the tuple; the number of true values equals the length of the tuple that will be transformed; must be non-null Returns:CacheableResultTransformer a CacheableResultTransformer that is used to transform tuples to a value(s) that can be cached.

create

back to summary

private static CacheableResultTransformer create(boolean[] includeInTuple)

Returns a CacheableResultTransformer that is used to transform tuples to a value(s) that can be cached.

Parameters

includeInTuple:boolean[]: - array with the i-th element indicating whether the i-th expression returned by a query is included in the tuple; the number of true values equals the length of the tuple that will be transformed; must be non-null

Returns:CacheableResultTransformer

a CacheableResultTransformer that is used to transform tuples to a value(s) that can be cached.

equals back to summary

equals	back to summary
public boolean equals(Object o) 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 o: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

public boolean equals(Object o)

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

o: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

getCachedResultTypes	back to summary
public Type[] getCachedResultTypes(Type[] tupleResultTypes)

hashCode back to summary

hashCode	back 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

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

index	back to summary
private <T> T[] index(Class<? extends T[]> clazz, T[] objects)

retransformResults	back to summary
public List<E> retransformResults(List<E> transformedResults, String[] aliases, ResultTransformer transformer, boolean[] includeInTuple) Re-transforms, if necessary, a List of values previously transformed by this (or an equivalent) CacheableResultTransformer. Each element of the list is re-transformed in place (i.e, List elements are replaced with re-transformed values) and the original List is returned. If re-transformation is unnecessary, the original List is returned unchanged. Parameters transformedResults:List<E> - results that were previously transformed aliases:String[] - the aliases that correspond to the untransformed tuple; transformer:ResultTransformer - the transformer for the re-transformation includeInTuple:boolean[] indicates the indexes of Returns:List<E> transformedResults, with each element re-transformed (if necessary) Annotations @SuppressWarnings:unchecked

retransformResults

back to summary

public List<E> retransformResults(List<E> transformedResults, String[] aliases, ResultTransformer transformer, boolean[] includeInTuple)

Re-transforms, if necessary, a List of values previously transformed by this (or an equivalent) CacheableResultTransformer. Each element of the list is re-transformed in place (i.e, List elements are replaced with re-transformed values) and the original List is returned.

If re-transformation is unnecessary, the original List is returned unchanged.

Parameters

transformedResults:List<E>: - results that were previously transformed
aliases:String[]: - the aliases that correspond to the untransformed tuple;
transformer:ResultTransformer: - the transformer for the re-transformation
includeInTuple:boolean[]: indicates the indexes of

Returns:List<E>

transformedResults, with each element re-transformed (if necessary)

Annotations

@SuppressWarnings:unchecked

transformList	back to summary
public List<E> transformList(List<E> list) Implements org.hibernate.transform.ResultTransformer.transformList. Doc from org.hibernate.transform.ResultTransformer.transformList. Here we have an opportunity to perform transformation on the query result as a whole. This might be useful to convert from one collection type to another or to remove duplicates from the result, etc. Parameters list:List<E> The result. Returns:List<E> The transformed result. Annotations @Override

transformList

back to summary

public List<E> transformList(List<E> list)

Implements org.hibernate.transform.ResultTransformer.transformList.

Doc from org.hibernate.transform.ResultTransformer.transformList.

Here we have an opportunity to perform transformation on the query result as a whole. This might be useful to convert from one collection type to another or to remove duplicates from the result, etc.

Parameters

list:List<E>: The result.

Returns:List<E>

The transformed result.

Annotations

@Override

transformTuple	back to summary
public Object transformTuple(Object[] tuple, String[] aliases) Implements org.hibernate.transform.ResultTransformer.transformTuple. Doc from org.hibernate.transform.ResultTransformer.transformTuple. Tuples are the elements making up each "row" of the query result. The contract here is to transform these elements into the final row. Parameters tuple:Object[] The result elements aliases:String[] The result aliases ("parallel" array to tuple) Returns:Object The transformed row. Annotations @Override

transformTuple

back to summary

public Object transformTuple(Object[] tuple, String[] aliases)

Implements org.hibernate.transform.ResultTransformer.transformTuple.

Doc from org.hibernate.transform.ResultTransformer.transformTuple.

Tuples are the elements making up each "row" of the query result. The contract here is to transform these elements into the final row.

Parameters

tuple:Object[]: The result elements
aliases:String[]: The result aliases ("parallel" array to tuple)

Returns:Object

The transformed row.

Annotations

@Override

unindex	back to summary
private <T> T[] unindex(Class<? extends T[]> clazz, T[] objects)

untransformToTuples	back to summary
public List<E> untransformToTuples(List<E> results) Untransforms, if necessary, a List of values previously transformed by this (or an equivalent) CacheableResultTransformer. Each element of the list is untransformed in place (i.e, List elements are replaced with untransformed values) and the original List is returned. If not unnecessary, the original List is returned unchanged. Note If transformed values are a subset of the original tuple, then, on return, elements corresponding to excluded tuple elements will be null. Parameters results:List<E> - results that were previously transformed Returns:List<E> results, with each element untransformed (if necessary) Annotations @SuppressWarnings:unchecked

untransformToTuples

back to summary

public List<E> untransformToTuples(List<E> results)

Untransforms, if necessary, a List of values previously transformed by this (or an equivalent) CacheableResultTransformer. Each element of the list is untransformed in place (i.e, List elements are replaced with untransformed values) and the original List is returned.

If not unnecessary, the original List is returned unchanged.

Note

If transformed values are a subset of the original tuple, then, on return, elements corresponding to excluded tuple elements will be null.

Parameters

results:List<E>: - results that were previously transformed

Returns:List<E>

results, with each element untransformed (if necessary)

Annotations

@SuppressWarnings:unchecked

public Class CacheableResultTransformer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail