org.hibernate.loader.plan.spi

Interface QuerySpace

All Known Subinterfaces:

CollectionQuerySpace, CompositeQuerySpace, EntityQuerySpace, ExpandingCollectionQuerySpace, ExpandingCompositeQuerySpace, ExpandingEntityQuerySpace, ExpandingQuerySpace

All Known Implementing Classes:

AbstractExpandingSourceQuerySpace, AbstractQuerySpace, CollectionQuerySpaceImpl, CompositeQuerySpaceImpl, EntityQuerySpaceImpl

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).

Author:

Steve Ebersole

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	QuerySpace.Disposition Enumeration of the different types of QuerySpaces we can have.

Method Summary

Modifier and Type	Method and Description
QuerySpace.Disposition	getDisposition() What type of QuerySpace (more-specific) is this?
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 the PropertyMapping for this QuerySpace.
QuerySpaces	getQuerySpaces() Get the QuerySpaces object that is our owner.
String	getUid() The uid/alias which uniquely identifies this QuerySpace.
String[]	toAliasedColumns(String alias, String propertyName) Get the aliased column names for the specified property in the query space..

Method Detail

getUid

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 the QuerySpaces object that is our owner.

Returns:

The QuerySpaces containing this QuerySpace

getPropertyMapping

PropertyMapping getPropertyMapping()

Get the PropertyMapping for this QuerySpace.

Returns:

The PropertyMapping

toAliasedColumns

String[] toAliasedColumns(String alias,
                          String propertyName)

Get the aliased column names for the specified property in the query space..

Parameters:

alias - - the table alias

propertyName - - 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

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 that space.getJoins().forEach{ join -> join.getLeftHandSide() == space } is true for all.

Returns:

The joins which originate from this query space.