org.hibernate.engine.query.sql

Class NativeSQLQueryCollectionReturn

Implemented Interfaces:
NativeSQLQueryReturn, Serializable

public class NativeSQLQueryCollectionReturn
extends NativeSQLQueryNonScalarReturn

Represents a return defined as part of a native sql query which names a collection role in the form {classname}.{collectionrole}; it is used in defining a custom sql 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

Constructor Summary

NativeSQLQueryCollectionReturn(String alias, String ownerEntityName, String ownerProperty, Map propertyResults, LockMode lockMode)
Construct a native-sql return representing a collection initializer

Method Summary

String
getOwnerEntityName()
Returns the class owning the collection.
String
getOwnerProperty()
Returns the name of the property representing the collection from the getOwnerEntityName().

Methods inherited from class org.hibernate.engine.query.sql.NativeSQLQueryNonScalarReturn

getAlias, getLockMode, getPropertyResultsMap

Constructor Details

NativeSQLQueryCollectionReturn

public NativeSQLQueryCollectionReturn(String alias,
                                      String ownerEntityName,
                                      String ownerProperty,
                                      Map propertyResults,
                                      LockMode lockMode)
Construct a native-sql return representing a collection initializer
Parameters:
alias - The result alias
ownerEntityName - The entity-name of the entity owning the collection to be initialized.
ownerProperty - The property name (on the owner) which represents the collection to be initialized.
propertyResults - Any user-supplied column->property mappings
lockMode - The lock mode to apply to the collection.

Method Details

getOwnerEntityName

public String getOwnerEntityName()
Returns the class owning the collection.
Returns:
The class owning the collection.

getOwnerProperty

public String getOwnerProperty()
Returns:
The name of the property representing the collection on the owner class.