Interface ExpandingQuerySpaces
-
- All Superinterfaces:
QuerySpaces
public interface ExpandingQuerySpaces extends QuerySpaces
Models a collection ofQuerySpace
references and exposes the ability to create anExpandingQuerySpace
for "returns" and fetches; used when building a load plan.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
generateImplicitUid()
Generate a unique ID to be used when creating anExpandingQuerySpace
.SessionFactoryImplementor
getSessionFactory()
Gets the session factory.ExpandingCollectionQuerySpace
makeCollectionQuerySpace(java.lang.String uid, CollectionPersister collectionPersister, boolean canJoinsBeRequired)
Create anExpandingCollectionQuerySpace
for a collection (that is not a "return") with the specified unique ID.ExpandingCompositeQuerySpace
makeCompositeQuerySpace(java.lang.String uid, org.hibernate.loader.plan.build.internal.spaces.CompositePropertyMapping compositePropertyMapping, boolean canJoinsBeRequired)
Create anExpandingCompositeQuerySpace
for a composite with the specified unique ID.ExpandingEntityQuerySpace
makeEntityQuerySpace(java.lang.String uid, EntityPersister entityPersister, boolean canJoinsBeRequired)
Create anExpandingEntityQuerySpace
for an entity (that is not a "return") with the specified unique ID.ExpandingCollectionQuerySpace
makeRootCollectionQuerySpace(java.lang.String uid, CollectionPersister collectionPersister)
Create anExpandingCollectionQuerySpace
for a collection "return" with the specified unique ID.ExpandingEntityQuerySpace
makeRootEntityQuerySpace(java.lang.String uid, EntityPersister entityPersister)
Create anExpandingEntityQuerySpace
for an entity "return" with the specified unique ID.-
Methods inherited from interface org.hibernate.loader.plan.spi.QuerySpaces
findQuerySpaceByUid, getQuerySpaceByUid, getRootQuerySpaces
-
-
-
-
Method Detail
-
generateImplicitUid
java.lang.String generateImplicitUid()
Generate a unique ID to be used when creating anExpandingQuerySpace
. Using this method to generate a unique ID ensures that this object does not contain aQuerySpace
with the returned unique ID.- Returns:
- The unique ID.
-
makeRootEntityQuerySpace
ExpandingEntityQuerySpace makeRootEntityQuerySpace(java.lang.String uid, EntityPersister entityPersister)
Create anExpandingEntityQuerySpace
for an entity "return" with the specified unique ID. The unique ID should be generated usinggenerateImplicitUid()
, A unique suffix may be added to the unique ID for an existingQuerySpace
. In this case, it is the caller's responsibility to ensure uniqueness.- Parameters:
uid
- The unique ID for the root entity query space.entityPersister
- The entity persister.- Returns:
- the
ExpandingEntityQuerySpace
with the specified unique ID. - Throws:
java.lang.IllegalStateException
- if there is already a query space with the specified unique ID.- See Also:
EntityReturn
-
makeEntityQuerySpace
ExpandingEntityQuerySpace makeEntityQuerySpace(java.lang.String uid, EntityPersister entityPersister, boolean canJoinsBeRequired)
Create anExpandingEntityQuerySpace
for an entity (that is not a "return") with the specified unique ID. The unique ID should be generated usinggenerateImplicitUid()
, A unique suffix may be added to the unique ID for an existingQuerySpace
. In this case, it is the caller's responsibility to ensure uniqueness.- Parameters:
uid
- The unique ID for the entity query space.entityPersister
- The entity persister.canJoinsBeRequired
-true
if joins added to the returned value can be required joins;false
, otherwise.- Returns:
- the
ExpandingEntityQuerySpace
with the specified unique ID. - Throws:
java.lang.IllegalStateException
- if there is already a query space with the specified unique ID.- See Also:
Join
-
makeRootCollectionQuerySpace
ExpandingCollectionQuerySpace makeRootCollectionQuerySpace(java.lang.String uid, CollectionPersister collectionPersister)
Create anExpandingCollectionQuerySpace
for a collection "return" with the specified unique ID. The unique ID should be generated usinggenerateImplicitUid()
, A unique suffix may be added to the unique ID for an existingQuerySpace
. In this case, it is the caller's responsibility to ensure uniqueness.- Parameters:
uid
- The unique ID for the root collection query space.collectionPersister
- The collection persister.- Returns:
- the
ExpandingCollectionQuerySpace
with the specified unique ID. - Throws:
java.lang.IllegalStateException
- if there is already a query space with the specified unique ID.- See Also:
CollectionReturn
-
makeCollectionQuerySpace
ExpandingCollectionQuerySpace makeCollectionQuerySpace(java.lang.String uid, CollectionPersister collectionPersister, boolean canJoinsBeRequired)
Create anExpandingCollectionQuerySpace
for a collection (that is not a "return") with the specified unique ID. The unique ID should be generated usinggenerateImplicitUid()
, A unique suffix may be added to the unique ID for an existingQuerySpace
. In this case, it is the caller's responsibility to ensure uniqueness.- Parameters:
uid
- The unique ID for the collection query space.collectionPersister
- The collection persister.canJoinsBeRequired
-true
if joins added to the returned value can be required joins;false
, otherwise.- Returns:
- the
ExpandingCollectionQuerySpace
with the specified unique ID. - Throws:
java.lang.IllegalStateException
- if there is already a query space with the specified unique ID.- See Also:
Join
-
makeCompositeQuerySpace
ExpandingCompositeQuerySpace makeCompositeQuerySpace(java.lang.String uid, org.hibernate.loader.plan.build.internal.spaces.CompositePropertyMapping compositePropertyMapping, boolean canJoinsBeRequired)
Create anExpandingCompositeQuerySpace
for a composite with the specified unique ID. The unique ID should be generated usinggenerateImplicitUid()
, A unique suffix may be added to the unique ID for an existingQuerySpace
. In this case, it is the caller's responsibility to ensure uniqueness.- Parameters:
uid
- The unique ID for the composite query space.compositePropertyMapping
- The composite property mapping.canJoinsBeRequired
-true
if joins added to the returned value can be required joins;false
, otherwise.- Returns:
- the
ExpandingCompositeQuerySpace
with the specified unique ID. - Throws:
java.lang.IllegalStateException
- if there is already a query space with the specified unique ID.- See Also:
Join
-
getSessionFactory
SessionFactoryImplementor getSessionFactory()
Gets the session factory.- Returns:
- The session factory.
-
-