Top Description Fields Constructors Methods
org.hibernate.loader.plan.build.internal.spaces

public abstract Class AbstractQuerySpace

extends Object
implements QuerySpace
Class Inheritance
All Implemented Interfaces
org.hibernate.loader.plan.spi.QuerySpace
Known Direct Subclasses
org.hibernate.loader.plan.build.internal.spaces.CollectionQuerySpaceImpl, org.hibernate.loader.plan.build.internal.spaces.AbstractExpandingSourceQuerySpace
Imports
java.util.ArrayList, .Collections, .List, org.hibernate.engine.spi.SessionFactoryImplementor, org.hibernate.loader.plan.build.spi.ExpandingQuerySpaces, org.hibernate.loader.plan.spi.Join, .QuerySpace, .QuerySpaces

Convenience base class for QuerySpace implementations.
Author
Steve Ebersole

Field Summary

Modifier and TypeField and Description
private final boolean
private final QuerySpace.Disposition
private List<Join>
private final ExpandingQuerySpaces
private final String

Constructor Summary

AccessConstructor and Description
public
AbstractQuerySpace(String uid, QuerySpace.Disposition disposition, ExpandingQuerySpaces querySpaces, boolean canJoinsBeRequired)

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true indicates joins can be required; false indicates they cannot.
canJoinsBeRequired
()

Can any joins created from here (with this as the left-hand side) be required joins?

public QuerySpace.Disposition
getDisposition()

Implements org.hibernate.loader.plan.spi.QuerySpace.getDisposition.

What type of QuerySpace (more-specific) is this?
protected ExpandingQuerySpaces
public Iterable<Join>
getJoins()

Implements org.hibernate.loader.plan.spi.QuerySpace.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 QuerySpaces

Returns:

The query spaces
getQuerySpaces
()

Implements org.hibernate.loader.plan.spi.QuerySpace.getQuerySpaces.

Provides subclasses access to the spaces to which this space belongs.
public String
getUid()

Implements org.hibernate.loader.plan.spi.QuerySpace.getUid.

The uid/alias which uniquely identifies this QuerySpace.
protected List<Join>
protected SessionFactoryImplementor
sessionFactory()

Deprecated as a consequence of SessionFactoryImplementor being deprecated.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

canJoinsBeRequiredback to summary
private final boolean canJoinsBeRequired
dispositionback to summary
private final QuerySpace.Disposition disposition
joinsback to summary
private List<Join> joins
querySpacesback to summary
private final ExpandingQuerySpaces querySpaces
uidback to summary
private final String uid

Constructor Detail

AbstractQuerySpaceback to summary
public AbstractQuerySpace(String uid, QuerySpace.Disposition disposition, ExpandingQuerySpaces querySpaces, boolean canJoinsBeRequired)

Method Detail

canJoinsBeRequiredback to summary
public boolean canJoinsBeRequired()

Can any joins created from here (with this as the left-hand side) be required joins?

Returns:boolean

true indicates joins can be required; false indicates they cannot.

getDispositionback to summary
public QuerySpace.Disposition getDisposition()

Implements org.hibernate.loader.plan.spi.QuerySpace.getDisposition.

Doc from org.hibernate.loader.plan.spi.QuerySpace.getDisposition.

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

Returns:QuerySpace.Disposition

The enum value representing the more-specific type of QuerySpace

Annotations
@Override
getExpandingQuerySpacesback to summary
protected ExpandingQuerySpaces getExpandingQuerySpaces()
getJoinsback to summary
public Iterable<Join> getJoins()

Implements org.hibernate.loader.plan.spi.QuerySpace.getJoins.

Doc from org.hibernate.loader.plan.spi.QuerySpace.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.

Annotations
@Override
getQuerySpacesback to summary
public QuerySpaces getQuerySpaces()

Implements org.hibernate.loader.plan.spi.QuerySpace.getQuerySpaces.

Provides subclasses access to the spaces to which this space belongs.

Returns:QuerySpaces

The query spaces

getUidback to summary
public String getUid()

Implements org.hibernate.loader.plan.spi.QuerySpace.getUid.

Doc from org.hibernate.loader.plan.spi.QuerySpace.getUid.

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

Returns:String

The uid

Annotations
@Override
internalGetJoinsback to summary
protected List<Join> internalGetJoins()
sessionFactoryback to summary
protected SessionFactoryImplementor sessionFactory()

Deprecated

as a consequence of SessionFactoryImplementor being deprecated. See corresponding docs for further information.