FileDocCategorySizeDatePackage
CollectionReturn.javaAPI DocHibernate 3.2.51743Thu Jun 15 00:21:06 BST 2006org.hibernate.loader.custom

CollectionReturn

public class CollectionReturn extends NonScalarReturn
Represents a return which names a collection role; it is used in defining a custom query for loading an entity's collection in non-fetching scenarios (i.e., loading the collection itself as the "root" of the result).
author
Steve Ebersole

Fields Summary
private final String
ownerEntityName
private final String
ownerProperty
private final org.hibernate.loader.CollectionAliases
collectionAliases
private final org.hibernate.loader.EntityAliases
elementEntityAliases
Constructors Summary
public CollectionReturn(String alias, String ownerEntityName, String ownerProperty, org.hibernate.loader.CollectionAliases collectionAliases, org.hibernate.loader.EntityAliases elementEntityAliases, org.hibernate.LockMode lockMode)

		super( alias, lockMode );
		this.ownerEntityName = ownerEntityName;
		this.ownerProperty = ownerProperty;
		this.collectionAliases = collectionAliases;
		this.elementEntityAliases = elementEntityAliases;
Methods Summary
public org.hibernate.loader.CollectionAliasesgetCollectionAliases()

		return collectionAliases;
public org.hibernate.loader.EntityAliasesgetElementEntityAliases()

		return elementEntityAliases;
public java.lang.StringgetOwnerEntityName()
Returns the class owning the collection.

return
The class owning the collection.

		return ownerEntityName;
public java.lang.StringgetOwnerProperty()
Returns the name of the property representing the collection from the {@link #getOwnerEntityName}.

return
The name of the property representing the collection on the owner class.

		return ownerProperty;