Top Description Inners Methods
org.hibernate.loader.plan.spi

public Interface QuerySpace

Known Direct Subinterfaces
org.hibernate.loader.plan.build.spi.ExpandingQuerySpace, org.hibernate.loader.plan.spi.CollectionQuerySpace, org.hibernate.loader.plan.spi.CompositeQuerySpace, org.hibernate.loader.plan.spi.EntityQuerySpace
Known Direct Implementers
org.hibernate.loader.plan.build.internal.spaces.AbstractQuerySpace
Imports
org.hibernate.persister.entity.PropertyMapping
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 and Inner Type Summary

Modifier and TypeClass and Description
public static enum
QuerySpace.Disposition

Enumeration of the different types of QuerySpaces we can have.

Method Summary

Modifier and TypeMethod and Description
public QuerySpace.Disposition

Returns:

The enum value representing the more-specific type of QuerySpace
getDisposition()

What type of QuerySpace (more-specific) is this?

public Iterable<Join>

Returns:

The joins which originate from this query space.
getJoins()

Obtain all joins which originate from this QuerySpace, in other words, all the joins which this QuerySpace is the left-hand-side of.

public PropertyMapping

Returns:

The PropertyMapping
getPropertyMapping()

Get the PropertyMapping for this QuerySpace.

public QuerySpaces

Returns:

The QuerySpaces containing this QuerySpace
getQuerySpaces()

Get the QuerySpaces object that is our owner.

public String

Returns:

The uid
getUid()

The uid/alias which uniquely identifies this QuerySpace.

public String[]

Returns:

the aliased column names for the specified property
toAliasedColumns(String
- the table alias
alias, String
- the property name
propertyName)

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

Method Detail

getDispositionback to summary
public QuerySpace.Disposition getDisposition()

What type of QuerySpace (more-specific) is this?

Returns:QuerySpace.Disposition

The enum value representing the more-specific type of QuerySpace

getJoinsback to summary
public 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:Iterable<Join>

The joins which originate from this query space.

getPropertyMappingback to summary
public PropertyMapping getPropertyMapping()

Get the PropertyMapping for this QuerySpace.

Returns:PropertyMapping

The PropertyMapping

getQuerySpacesback to summary
public QuerySpaces getQuerySpaces()

Get the QuerySpaces object that is our owner.

Returns:QuerySpaces

The QuerySpaces containing this QuerySpace

getUidback to summary
public String getUid()

The uid/alias which uniquely identifies this QuerySpace. Can be used to uniquely reference this QuerySpace elsewhere.

Returns:String

The uid

See Also
QuerySpaces#findQuerySpaceByUid(java.lang.String)
toAliasedColumnsback to summary
public String[] toAliasedColumns(String alias, String propertyName)

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

Parameters
alias:String

- the table alias

propertyName:String

- the property name

Returns:String[]

the aliased column names for the specified property

org.hibernate.loader.plan.spi back to summary

public final Enum QuerySpace.Disposition

extends Enum<QuerySpace.Disposition>
Class Inheritance
Enumeration of the different types of QuerySpaces we can have.

Field Summary

Modifier and TypeField and Description
public static final QuerySpace.Disposition
COLLECTION

We have a collection-based QuerySpace.

public static final QuerySpace.Disposition
COMPOSITE

We have a composition-based QuerySpace.

public static final QuerySpace.Disposition
ENTITY

We have an entity-based QuerySpace.

Constructor Summary

AccessConstructor and Description
private
Disposition()

Method Summary

Modifier and TypeMethod and Description
public static QuerySpace.Disposition
valueOf(String name)

public static QuerySpace.Disposition[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

COLLECTIONback to summary
public static final QuerySpace.Disposition COLLECTION

We have a collection-based QuerySpace. It is castable to CollectionQuerySpace for more details.

COMPOSITEback to summary
public static final QuerySpace.Disposition COMPOSITE

We have a composition-based QuerySpace. It is castable to CompositeQuerySpace for more details.

ENTITYback to summary
public static final QuerySpace.Disposition ENTITY

We have an entity-based QuerySpace. It is castable to EntityQuerySpace for more details.

Constructor Detail

Dispositionback to summary
private Disposition()

Method Detail

valueOfback to summary
public static QuerySpace.Disposition valueOf(String name)
valuesback to summary
public static QuerySpace.Disposition[] values()