public interface ExpandingQuerySpaces extends QuerySpaces
QuerySpace
references and
exposes the ability to create an ExpandingQuerySpace
for "returns" and fetches;
used when building a load plan.Modifier and Type | Method and Description |
---|---|
String |
generateImplicitUid()
Generate a unique ID to be used when creating an
ExpandingQuerySpace . |
SessionFactoryImplementor |
getSessionFactory()
Gets the session factory.
|
ExpandingCollectionQuerySpace |
makeCollectionQuerySpace(String uid,
CollectionPersister collectionPersister,
boolean canJoinsBeRequired)
Create an
ExpandingCollectionQuerySpace for a collection (that is not a "return")
with the specified unique ID. |
ExpandingCompositeQuerySpace |
makeCompositeQuerySpace(String uid,
CompositePropertyMapping compositePropertyMapping,
boolean canJoinsBeRequired)
Create an
ExpandingCompositeQuerySpace for a composite
with the specified unique ID. |
ExpandingEntityQuerySpace |
makeEntityQuerySpace(String uid,
EntityPersister entityPersister,
boolean canJoinsBeRequired)
Create an
ExpandingEntityQuerySpace for an entity (that is not a "return")
with the specified unique ID. |
ExpandingCollectionQuerySpace |
makeRootCollectionQuerySpace(String uid,
CollectionPersister collectionPersister)
Create an
ExpandingCollectionQuerySpace for a collection "return" with the
specified unique ID. |
ExpandingEntityQuerySpace |
makeRootEntityQuerySpace(String uid,
EntityPersister entityPersister)
Create an
ExpandingEntityQuerySpace for an entity "return" with the
specified unique ID. |
findQuerySpaceByUid, getQuerySpaceByUid, getRootQuerySpaces
String generateImplicitUid()
ExpandingQuerySpace
.
Using this method to generate a unique ID ensures that this object
does not contain a QuerySpace
with the returned unique ID.ExpandingEntityQuerySpace makeRootEntityQuerySpace(String uid, EntityPersister entityPersister)
ExpandingEntityQuerySpace
for an entity "return" with the
specified unique ID.
The unique ID should be generated using generateImplicitUid()
,
A unique suffix may be added to the unique ID for an existing QuerySpace
.
In this case, it is the caller's responsibility to ensure uniqueness.uid
- The unique ID for the root entity query space.entityPersister
- The entity persister.ExpandingEntityQuerySpace
with the specified unique ID.IllegalStateException
- if there is already a query space with the
specified unique ID.EntityReturn
ExpandingEntityQuerySpace makeEntityQuerySpace(String uid, EntityPersister entityPersister, boolean canJoinsBeRequired)
ExpandingEntityQuerySpace
for an entity (that is not a "return")
with the specified unique ID.
The unique ID should be generated using generateImplicitUid()
,
A unique suffix may be added to the unique ID for an existing QuerySpace
.
In this case, it is the caller's responsibility to ensure uniqueness.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.ExpandingEntityQuerySpace
with the specified unique ID.IllegalStateException
- if there is already a query space with the
specified unique ID.Join
ExpandingCollectionQuerySpace makeRootCollectionQuerySpace(String uid, CollectionPersister collectionPersister)
ExpandingCollectionQuerySpace
for a collection "return" with the
specified unique ID.
The unique ID should be generated using generateImplicitUid()
,
A unique suffix may be added to the unique ID for an existing QuerySpace
.
In this case, it is the caller's responsibility to ensure uniqueness.uid
- The unique ID for the root collection query space.collectionPersister
- The collection persister.ExpandingCollectionQuerySpace
with the specified unique ID.IllegalStateException
- if there is already a query space with the
specified unique ID.CollectionReturn
ExpandingCollectionQuerySpace makeCollectionQuerySpace(String uid, CollectionPersister collectionPersister, boolean canJoinsBeRequired)
ExpandingCollectionQuerySpace
for a collection (that is not a "return")
with the specified unique ID.
The unique ID should be generated using generateImplicitUid()
,
A unique suffix may be added to the unique ID for an existing QuerySpace
.
In this case, it is the caller's responsibility to ensure uniqueness.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.ExpandingCollectionQuerySpace
with the specified unique ID.IllegalStateException
- if there is already a query space with the
specified unique ID.Join
ExpandingCompositeQuerySpace makeCompositeQuerySpace(String uid, CompositePropertyMapping compositePropertyMapping, boolean canJoinsBeRequired)
ExpandingCompositeQuerySpace
for a composite
with the specified unique ID.
The unique ID should be generated using generateImplicitUid()
,
A unique suffix may be added to the unique ID for an existing QuerySpace
.
In this case, it is the caller's responsibility to ensure uniqueness.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.ExpandingCompositeQuerySpace
with the specified unique ID.IllegalStateException
- if there is already a query space with the
specified unique ID.Join
SessionFactoryImplementor getSessionFactory()
Copyright © 2021 JBoss by Red Hat. All rights reserved.