org.hibernate.loader.plan.build.spi

Interface ExpandingCollectionQuerySpace

All Superinterfaces:

CollectionQuerySpace, ExpandingQuerySpace, QuerySpace

All Known Implementing Classes:

CollectionQuerySpaceImpl

public interface ExpandingCollectionQuerySpace
extends CollectionQuerySpace, ExpandingQuerySpace

Describes a collection query space that allows adding joins with other query spaces; used while building a CollectionQuerySpace.

Author:

Gail Badner

See Also:

Join

Nested Class Summary

Nested classes/interfaces inherited from interface org.hibernate.loader.plan.spi.QuerySpace

QuerySpace.Disposition

Method Summary

Modifier and Type	Method and Description
void	addJoin(Join join) Adds a join with another query space for either a collection element or index.

Methods inherited from interface org.hibernate.loader.plan.spi.CollectionQuerySpace

getCollectionPersister

Methods inherited from interface org.hibernate.loader.plan.build.spi.ExpandingQuerySpace

canJoinsBeRequired, getExpandingQuerySpaces

Methods inherited from interface org.hibernate.loader.plan.spi.QuerySpace

getDisposition, getJoins, getPropertyMapping, getQuerySpaces, getUid, toAliasedColumns

Method Detail

addJoin

void addJoin(Join join)

Adds a join with another query space for either a collection element or index. If join is an instance of JoinDefinedByMetadata, then the only valid values returned by JoinDefinedByMetadata.getJoinedPropertyName() are "elements" and "indices" for the collection element or index, respectively.

Specified by:

addJoin in interface ExpandingQuerySpace

Parameters:

join - The element or index join to add.

Throws:

IllegalArgumentException - if join is an instance of JoinDefinedByMetadata and join.getJoinedPropertyName() is neither {@code "elements"} and {@code "indices"}.

IllegalStateException - if there is already an existing join with the same joined property name.