javax.persistence.Tuple - JPA interface
javax.persistence
Interface Tuple
Interface for extracting the elements of a query result tuple.
- Since:
- JPA 2.0
- See Also:
-
TupleElement
Object get(int i)
Get the value of the element at the specified position in the result tuple. The first position is 0.
- Parameters:
-
i- position in result tuple
- Returns:
- value of the tuple element
- Throws:
-
IllegalArgumentException- if i exceeds length of result tuple
- Since:
- JPA 2.0
Object get(String alias)
Get the value of the tuple element to which the specified alias has been assigned.
- Parameters:
-
alias- alias assigned to tuple element
- Returns:
- value of the tuple element
- Throws:
-
IllegalArgumentException- if alias does not correspond to an element in the query result tuple
- Since:
- JPA 2.0
X get(int i, Class<X> type)
Get the value of the element at the specified position in the result tuple. The first position is 0.
- Parameters:
-
i- position in result tuple -
type- type of the tuple element
- Returns:
- value of the tuple element
- Throws:
-
IllegalArgumentException- if i exceeds length of result tuple or element cannot be assigned to the specified type
- Since:
- JPA 2.0
X get( TupleElement<X> tupleElement)
Get the value of the specified tuple element.
- Parameters:
-
tupleElement- tuple element
- Returns:
- value of tuple element
- Throws:
-
IllegalArgumentException- if tuple element does not correspond to an element in the query result tuple
- Since:
- JPA 2.0
X get(String alias, Class<X> type)
Get the value of the tuple element to which the specified alias has been assigned.
- Parameters:
-
alias- alias assigned to tuple element -
type- of the tuple element
- Returns:
- value of the tuple element
- Throws:
-
IllegalArgumentException- if alias does not correspond to an element in the query result tuple or element cannot be assigned to the specified type
- Since:
- JPA 2.0
List< TupleElement<?>> getElements()
Return the tuple elements.
- Returns:
- tuple elements
- Since:
- JPA 2.0
Object[] toArray()
Return the values of the result tuple elements as an array.
- Returns:
- tuple element values
- Since:
- JPA 2.0
