public class FetchProfile extends Object
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. <p/> This class defines the runtime representation of this data.
Constructor and Description |
---|
FetchProfile(String name)
Constructs a FetchProfile, supplying its unique name (unique within the SessionFactory).
|
Modifier and Type | Method and Description |
---|---|
void |
addFetch(Association association,
Fetch.Style style)
Add a fetch to the profile.
|
void |
addFetch(Association association,
String fetchStyleName)
Add a fetch to the profile.
|
void |
addFetch(Fetch fetch)
Add a fetch to the profile.
|
Fetch |
getFetchByRole(String role)
Obtain the fetch associated with the given 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.
|
public FetchProfile(String name)
Constructs a FetchProfile, supplying its unique name (unique within the SessionFactory).
name
- The name under which we are bound in the sessionFactorypublic void addFetch(Association association, String fetchStyleName)
Add a fetch to the profile.
association
- The association to be fetchedfetchStyleName
- The name of the fetch style to applypublic void addFetch(Association association, Fetch.Style style)
Add a fetch to the profile.
association
- The association to be fetchedstyle
- The style to applypublic void addFetch(Fetch fetch)
Add a fetch to the profile.
fetch
- The fetch to add.public String getName()
Getter for property 'name'.
public Map<String,Fetch> getFetches()
Getter for property 'fetches'. Map of Fetch
instances, keyed by association <tt>role</tt>
public Fetch getFetchByRole(String role)
Obtain the fetch associated with the given role.
role
- The role identifying the fetchnull
if a matching one was not foundpublic boolean isContainsJoinFetchedCollection()
Getter for property 'containsJoinFetchedCollection', which flags whether this fetch profile contained any collection join fetches.
public boolean isContainsJoinFetchedBag()
Getter for property 'containsJoinFetchedBag', which flags whether this fetch profile contained any bag join fetches
Copyright © 2001-2018 Red Hat, Inc. All Rights Reserved.