Top Description Methods
org.hibernate.transform

public Interface TupleSubsetResultTransformer

extends ResultTransformer
Known Direct Implementers
org.hibernate.transform.AliasedTupleSubsetResultTransformer, org.hibernate.transform.DistinctRootEntityResultTransformer, org.hibernate.transform.PassThroughResultTransformer, org.hibernate.transform.RootEntityResultTransformer

A ResultTransformer that operates on "well-defined" and consistent subset of a tuple's elements. "Well-defined" means that:
  1. the indexes of tuple elements accessed by a TupleSubsetResultTransformer depends only on the aliases and the number of elements in the tuple; i.e, it does not depend on the value of the tuple being transformed;
  2. any tuple elements included in the transformed value are unmodified by the transformation;
  3. transforming equivalent tuples with the same aliases multiple times results in transformed values that are equivalent;
  4. the result of transforming the tuple subset (only those elements accessed by the transformer) using only the corresponding aliases is equivalent to transforming the full tuple with the full array of aliases;
  5. the result of transforming a tuple with non-accessed tuple elements and corresponding aliases set to null is equivalent to transforming the full tuple with the full array of aliases;
Author
Gail Badner

Method Summary

Modifier and TypeMethod and Description
public boolean[]

Returns:

array with the i-th element indicating whether the i-th element of the tuple is included in the transformed value.
includeInTransform
(String[]
- the aliases that correspond to the tuple
aliases
,
int
- the number of elements in the tuple
tupleLength
)

Returns an array with the i-th element indicating whether the i-th element of the tuple is included in the transformed value.

public boolean

Returns:

true, if the transformed value is a single element of the tuple; false, otherwise.
isTransformedValueATupleElement
(String[]
- the aliases that correspond to the tuple
aliases
,
int
- the number of elements in the tuple
tupleLength
)

When a tuple is transformed, is the result a single element of the tuple?

Inherited from org.hibernate.transform.ResultTransformer:
transformListtransformTuple

Method Detail

includeInTransformback to summary
public boolean[] includeInTransform(String[] aliases, int tupleLength)

Returns an array with the i-th element indicating whether the i-th element of the tuple is included in the transformed value.

Parameters
aliases:String[]

- the aliases that correspond to the tuple

tupleLength:int

- the number of elements in the tuple

Returns:boolean[]

array with the i-th element indicating whether the i-th element of the tuple is included in the transformed value.

isTransformedValueATupleElementback to summary
public boolean isTransformedValueATupleElement(String[] aliases, int tupleLength)

When a tuple is transformed, is the result a single element of the tuple?

Parameters
aliases:String[]

- the aliases that correspond to the tuple

tupleLength:int

- the number of elements in the tuple

Returns:boolean

true, if the transformed value is a single element of the tuple; false, otherwise.