Top Description Inners Fields Constructors Methods
org.hibernate.mapping

public Class FetchProfile

extends Object
Class Inheritance
Imports
java.util.LinkedHashSet

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 represent the data as it is defined in their metadata.

Author
Steve Ebersole
See Also
org.hibernate.engine.profile.FetchProfile

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
FetchProfile.Fetch

Defines an individual association fetch within the given profile.

Field Summary

Modifier and TypeField and Description
private LinkedHashSet<FetchProfile.Fetch>
private final String
private final MetadataSource

Constructor Summary

AccessConstructor and Description
public
FetchProfile(String
The name of the fetch profile.
name
,
MetadataSource
The source of the fetch profile (where was it defined).
source
)

Create a fetch profile representation.

Method Summary

Modifier and TypeMethod and Description
public void
addFetch(String
The entity which contains the association to be fetched
entity
,
String
The association to fetch
association
,
String
The style of fetch t apply
style
)

Adds a fetch to this profile.

public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public LinkedHashSet<FetchProfile.Fetch>

Returns:

The fetches associated with this profile.
getFetches
()

Retrieve the fetches associated with this profile

public String

Returns:

The profile name
getName
()

Retrieve the name of the fetch profile.

public MetadataSource

Returns:

The profile source.
getSource
()

Retrieve the fetch profile source.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

fetchesback to summary
private LinkedHashSet<FetchProfile.Fetch> fetches
nameback to summary
private final String name
sourceback to summary
private final MetadataSource source

Constructor Detail

FetchProfileback to summary
public FetchProfile(String name, MetadataSource source)

Create a fetch profile representation.

Parameters
name:String

The name of the fetch profile.

source:MetadataSource

The source of the fetch profile (where was it defined).

Method Detail

addFetchback to summary
public void addFetch(String entity, String association, String style)

Adds a fetch to this profile.

Parameters
entity:String

The entity which contains the association to be fetched

association:String

The association to fetch

style:String

The style of fetch t apply

equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

getFetchesback to summary
public LinkedHashSet<FetchProfile.Fetch> getFetches()

Retrieve the fetches associated with this profile

Returns:LinkedHashSet<FetchProfile.Fetch>

The fetches associated with this profile.

getNameback to summary
public String getName()

Retrieve the name of the fetch profile.

Returns:String

The profile name

getSourceback to summary
public MetadataSource getSource()

Retrieve the fetch profile source.

Returns:MetadataSource

The profile source.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

org.hibernate.mapping back to summary

public Class FetchProfile.Fetch

extends Object
Class Inheritance

Defines an individual association fetch within the given profile.

Field Summary

Modifier and TypeField and Description
private final String
private final String
private final String

Constructor Summary

AccessConstructor and Description
public
Fetch(String entity, String association, String style)

Method Summary

Modifier and TypeMethod and Description
public String
public String
public String
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

associationback to summary
private final String association
entityback to summary
private final String entity
styleback to summary
private final String style

Constructor Detail

Fetchback to summary
public Fetch(String entity, String association, String style)

Method Detail

getAssociationback to summary
public String getAssociation()
getEntityback to summary
public String getEntity()
getStyleback to summary
public String getStyle()