/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
 * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
 */
package org.hibernate.loader.custom;
import org.hibernate.LockMode;

Represents a return which names a fetched association.
Author:Steve Ebersole
/** * Represents a return which names a fetched association. * * @author Steve Ebersole */
public abstract class FetchReturn extends NonScalarReturn { private final NonScalarReturn owner; private final String ownerProperty;
Creates a return descriptor for an association fetch.
Params:
  • owner – The return descriptor for the owner of the fetch
  • ownerProperty – The name of the property represernting the association being fetched
  • alias – The alias for the fetch
  • lockMode – The lock mode to apply to the fetched association.
/** * Creates a return descriptor for an association fetch. * * @param owner The return descriptor for the owner of the fetch * @param ownerProperty The name of the property represernting the association being fetched * @param alias The alias for the fetch * @param lockMode The lock mode to apply to the fetched association. */
public FetchReturn( NonScalarReturn owner, String ownerProperty, String alias, LockMode lockMode) { super( alias, lockMode ); this.owner = owner; this.ownerProperty = ownerProperty; }
Retrieves the return descriptor for the owner of this fetch.
Returns:The owner
/** * Retrieves the return descriptor for the owner of this fetch. * * @return The owner */
public NonScalarReturn getOwner() { return owner; }
The name of the property on the owner which represents this association.
Returns:The property name.
/** * The name of the property on the owner which represents this association. * * @return The property name. */
public String getOwnerProperty() { return ownerProperty; } }