public class

FetchProfile

extends Object
java.lang.Object
   ↳ org.hibernate.engine.profile.FetchProfile

Class Overview

A 'fetch profile' allows a user to dynamically modify the fetching strategy used for particular associations at runtime, whereas that information was historically only statically defined in the metadata.

This class defines the runtime representation of this data.

Summary

Public Constructors
FetchProfile(String name)
A 'fetch profile' is uniquely named within a SessionFactory, thus it is also uniquely and easily identifiable within that SessionFactory.
Public Methods
void addFetch(Fetch fetch)
Add a fetch to the profile.
void addFetch(Association association, String fetchStyleName)
Add a fetch to the profile.
void addFetch(Association association, Fetch.Style style)
Add a fetch to the profile.
Fetch getFetchByRole(String role)
Map<String, Fetch> getFetches()
Getter for property 'fetches'.
String getName()
Getter for property 'name'.
boolean isContainsJoinFetchedBag()
Getter for property 'containsJoinFetchedBag', which flags whether this fetch profile contained any bag join fetches
boolean isContainsJoinFetchedCollection()
Getter for property 'containsJoinFetchedCollection', which flags whether this fetch profile contained any collection join fetches.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public FetchProfile (String name)

A 'fetch profile' is uniquely named within a SessionFactory, thus it is also uniquely and easily identifiable within that SessionFactory.

Parameters
name The name under which we are bound in the sessionFactory

Public Methods

public void addFetch (Fetch fetch)

Add a fetch to the profile.

Parameters
fetch The fetch to add.

public void addFetch (Association association, String fetchStyleName)

Add a fetch to the profile.

Parameters
association The association to be fetched
fetchStyleName The name of the fetch style to apply

public void addFetch (Association association, Fetch.Style style)

Add a fetch to the profile.

Parameters
association The association to be fetched
style The style to apply

public Fetch getFetchByRole (String role)

public Map<String, Fetch> getFetches ()

Getter for property 'fetches'. Map of Fetch instances, keyed by association role

Returns
  • Value for property 'fetches'.

public String getName ()

Getter for property 'name'.

Returns
  • Value for property 'name'.

public boolean isContainsJoinFetchedBag ()

Getter for property 'containsJoinFetchedBag', which flags whether this fetch profile contained any bag join fetches

Returns
  • Value for property 'containsJoinFetchedBag'.

public boolean isContainsJoinFetchedCollection ()

Getter for property 'containsJoinFetchedCollection', which flags whether this fetch profile contained any collection join fetches.

Returns
  • Value for property 'containsJoinFetchedCollection'.