javax.persistence.criteria.PluralJoin - JPA interface
javax.persistence.criteria
Interface PluralJoin<Z,C,E>
- Superinterfaces:
-
Expression<E>
,FetchParent<Z,E>
,From<Z,E>
,Join<Z,E>
,Path<E>
,Selection<E>
,TupleElement<E>
- Subinterfaces:
-
CollectionJoin
,ListJoin
,MapJoin
,SetJoin
PluralJoin
interface defines functionality that is common to joins to all collection types. It is not intended to be used directly in query construction. - Since:
- JPA 2.0
- Parameters:
-
name
- alias
- Returns:
- selection item
- Since:
- JPA 2.0
- Parameters:
-
type
- intended type of the expression
- Returns:
- new expression of the given type
- Since:
- JPA 2.0
- Parameters:
-
attributeName
- name of the attribute for the target of the join
- Returns:
- the resulting fetch join
- Throws:
-
IllegalArgumentException
- if attribute of the given name does not exist
- Since:
- JPA 2.0
- Parameters:
-
attributeName
- name of the attribute for the target of the join -
jt
- join type
- Returns:
- the resulting fetch join
- Throws:
-
IllegalArgumentException
- if attribute of the given name does not exist
- Since:
- JPA 2.0
- Parameters:
-
attribute
- target of the join
- Returns:
- the resulting join
- Since:
- JPA 2.0
- Parameters:
-
attribute
- target of the join
- Returns:
- the resulting fetch join
- Since:
- JPA 2.0
- Parameters:
-
attribute
- target of the join -
jt
- join type
- Returns:
- the resulting join
- Since:
- JPA 2.0
- Parameters:
-
attribute
- target of the join -
jt
- join type
- Returns:
- the resulting fetch join
- Since:
- JPA 2.0
Note: Applications using the string-based API may need to specify the type resulting from the get
operation in order to avoid the use of Path
variables.
For example: CriteriaQuery q = cb.createQuery(Person.class); Root p = q.from(Person.class); q.select(p) .where(cb.isMember("joe", p. >get("nicknames"))); rather than: CriteriaQuery q = cb.createQuery(Person.class); Root p = q.from(Person.class); Path > nicknames = p.get("nicknames"); q.select(p) .where(cb.isMember("joe", nicknames));
- Parameters:
-
attributeName
- name of the attribute
- Returns:
- path corresponding to the referenced attribute
- Throws:
-
IllegalStateException
- if invoked on a path that corresponds to a basic type -
IllegalArgumentException
- if attribute of the given name does not otherwise exist
- Since:
- JPA 2.0
- Parameters:
-
map
- map-valued attribute
- Returns:
- expression corresponding to the referenced attribute
- Since:
- JPA 2.0
- Parameters:
-
collection
- collection-valued attribute
- Returns:
- expression corresponding to the referenced attribute
- Since:
- JPA 2.0
- Parameters:
-
attribute
- single-valued attribute
- Returns:
- path corresponding to the referenced attribute
- Since:
- JPA 2.0
- Returns:
- alias
- Since:
- JPA 2.0
- Returns:
- metamodel attribute corresponding to the join
- Since:
- JPA 2.0
- Returns:
- list of selection items
- Throws:
-
IllegalStateException
- if selection is not a compound selection
- Since:
- JPA 2.0
From
object from which the correlated From
object has been obtained through correlation (use of a Subquery
correlate
method). - Returns:
- the parent of the correlated From object
- Throws:
-
IllegalStateException
- if the From object has not been obtained through correlation
- Since:
- JPA 2.0
- Returns:
- fetch joins made from this type
- Since:
- JPA 2.0
- Returns:
- the Java type of the tuple element
- Since:
- JPA 2.0
- Returns:
- join type
- Since:
- JPA 2.0
- Returns:
- joins made from this type
- Since:
- JPA 2.0
- Returns:
- bindable object corresponding to the path
- Since:
- JPA 2.0
- Returns:
- metamodel collection-valued attribute corresponding to the target of the join
- Since:
- JPA 2.0
- Returns:
- parent
- Since:
- JPA 2.0
- Parameters:
-
values
- values to be tested against
- Returns:
- predicate testing for membership
- Since:
- JPA 2.0
- Parameters:
-
values
- collection of values to be tested against
- Returns:
- predicate testing for membership
- Since:
- JPA 2.0
- Parameters:
-
values
- expression corresponding to collection to be tested against
- Returns:
- predicate testing for membership
- Since:
- JPA 2.0
- Parameters:
-
values
- expressions to be tested against
- Returns:
- predicate testing for membership
- Since:
- JPA 2.0
- Returns:
- boolean indicating whether the selection is a compound selection
- Since:
- JPA 2.0
From
object has been obtained as a result of correlation (use of a Subquery
correlate
method). - Returns:
- boolean indicating whether the object has been obtained through correlation
- Since:
- JPA 2.0
- Returns:
- predicate testing whether the expression is not null
- Since:
- JPA 2.0
- Returns:
- predicate testing whether the expression is null
- Since:
- JPA 2.0
- Parameters:
-
attributeName
- name of the attribute for the target of the join
- Returns:
- the resulting join
- Throws:
-
IllegalArgumentException
- if attribute of the given name does not exist
- Since:
- JPA 2.0
- Parameters:
-
set
- target of the join
- Returns:
- the resulting join
- Since:
- JPA 2.0
- Parameters:
-
map
- target of the join
- Returns:
- the resulting join
- Since:
- JPA 2.0
- Parameters:
-
list
- target of the join
- Returns:
- the resulting join
- Since:
- JPA 2.0
- Parameters:
-
attributeName
- name of the attribute for the target of the join -
jt
- join type
- Returns:
- the resulting join
- Throws:
-
IllegalArgumentException
- if attribute of the given name does not exist
- Since:
- JPA 2.0
- Parameters:
-
attribute
- target of the join
- Returns:
- the resulting join
- Since:
- JPA 2.0
- Parameters:
-
collection
- target of the join
- Returns:
- the resulting join
- Since:
- JPA 2.0
- Parameters:
-
set
- target of the join -
jt
- join type
- Returns:
- the resulting join
- Since:
- JPA 2.0
- Parameters:
-
map
- target of the join -
jt
- join type
- Returns:
- the resulting join
- Since:
- JPA 2.0
- Parameters:
-
list
- target of the join -
jt
- join type
- Returns:
- the resulting join
- Since:
- JPA 2.0
- Parameters:
-
attribute
- target of the join -
jt
- join type
- Returns:
- the resulting join
- Since:
- JPA 2.0
- Parameters:
-
collection
- target of the join -
jt
- join type
- Returns:
- the resulting join
- Since:
- JPA 2.0
- Parameters:
-
attributeName
- name of the attribute for the target of the join
- Returns:
- the resulting join
- Throws:
-
IllegalArgumentException
- if attribute of the given name does not exist
- Since:
- JPA 2.0
- Parameters:
-
attributeName
- name of the attribute for the target of the join -
jt
- join type
- Returns:
- the resulting join
- Throws:
-
IllegalArgumentException
- if attribute of the given name does not exist
- Since:
- JPA 2.0
- Parameters:
-
attributeName
- name of the attribute for the target of the join
- Returns:
- the resulting join
- Throws:
-
IllegalArgumentException
- if attribute of the given name does not exist
- Since:
- JPA 2.0
- Parameters:
-
attributeName
- name of the attribute for the target of the join -
jt
- join type
- Returns:
- the resulting join
- Throws:
-
IllegalArgumentException
- if attribute of the given name does not exist
- Since:
- JPA 2.0
- Parameters:
-
attributeName
- name of the attribute for the target of the join
- Returns:
- the resulting join
- Throws:
-
IllegalArgumentException
- if attribute of the given name does not exist
- Since:
- JPA 2.0
- Parameters:
-
attributeName
- name of the attribute for the target of the join -
jt
- join type
- Returns:
- the resulting join
- Throws:
-
IllegalArgumentException
- if attribute of the given name does not exist
- Since:
- JPA 2.0
- Parameters:
-
attributeName
- name of the attribute for the target of the join
- Returns:
- the resulting join
- Throws:
-
IllegalArgumentException
- if attribute of the given name does not exist
- Since:
- JPA 2.0
- Parameters:
-
attributeName
- name of the attribute for the target of the join -
jt
- join type
- Returns:
- the resulting join
- Throws:
-
IllegalArgumentException
- if attribute of the given name does not exist
- Since:
- JPA 2.0
- Returns:
- expression corresponding to the type of the path
- Since:
- JPA 2.0