Package org.hibernate.loader.plan.spi
Interface QuerySpace
-
- All Known Subinterfaces:
CollectionQuerySpace
,CompositeQuerySpace
,EntityQuerySpace
,ExpandingCollectionQuerySpace
,ExpandingCompositeQuerySpace
,ExpandingEntityQuerySpace
,ExpandingQuerySpace
public interface QuerySpace
Defines a persister reference (either entity or collection) or a composite reference. In JPA terms this is an "abstract schema type" when discussing JPQL or JPA Criteria queries. This models a single source of attributes (and fetches).
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
QuerySpace.Disposition
Enumeration of the different types of QuerySpaces we can have.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description QuerySpace.Disposition
getDisposition()
What type of QuerySpace (more-specific) is this?java.lang.Iterable<Join>
getJoins()
Obtain all joins which originate from this QuerySpace, in other words, all the joins which this QuerySpace is the left-hand-side of.PropertyMapping
getPropertyMapping()
Get thePropertyMapping
for this QuerySpace.QuerySpaces
getQuerySpaces()
Get theQuerySpaces
object that is our owner.java.lang.String
getUid()
The uid/alias which uniquely identifies this QuerySpace.java.lang.String[]
toAliasedColumns(java.lang.String alias, java.lang.String propertyName)
Get the aliased column names for the specified property in the query space..
-
-
-
Method Detail
-
getUid
java.lang.String getUid()
The uid/alias which uniquely identifies this QuerySpace. Can be used to uniquely reference this QuerySpace elsewhere.- Returns:
- The uid
- See Also:
QuerySpaces.findQuerySpaceByUid(java.lang.String)
-
getQuerySpaces
QuerySpaces getQuerySpaces()
Get theQuerySpaces
object that is our owner.- Returns:
- The QuerySpaces containing this QuerySpace
-
getPropertyMapping
PropertyMapping getPropertyMapping()
Get thePropertyMapping
for this QuerySpace.- Returns:
- The PropertyMapping
-
toAliasedColumns
java.lang.String[] toAliasedColumns(java.lang.String alias, java.lang.String propertyName)
Get the aliased column names for the specified property in the query space..- Parameters:
alias
- - the table aliaspropertyName
- - the property name- Returns:
- the aliased column names for the specified property
-
getDisposition
QuerySpace.Disposition getDisposition()
What type of QuerySpace (more-specific) is this?- Returns:
- The enum value representing the more-specific type of QuerySpace
-
getJoins
java.lang.Iterable<Join> getJoins()
Obtain all joins which originate from this QuerySpace, in other words, all the joins which this QuerySpace is the left-hand-side of. For all the joins returned here,Join.getLeftHandSide()
should point back to this QuerySpace such thatspace.getJoins().forEach{ join -> join.getLeftHandSide() == space }
is true for all.- Returns:
- The joins which originate from this query space.
-
-