EclipseLink 2.1.2, build 'v20101206-r8635' API Reference

org.eclipse.persistence.queries
Class LoadGroup

java.lang.Object
  extended by org.eclipse.persistence.queries.AttributeGroup
      extended by org.eclipse.persistence.queries.LoadGroup
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public class LoadGroup
extends AttributeGroup

Purpose: Used to load specified relationship attributes and nested relationship attributes.

A LoadGroup can be configured for use on a query using ObjectLevelReadQuery.setLoadGroup(LoadGroup) or in the case of JPA users with LOAD_GROUP query hint. Alternatively a FetchGroup could be used with FetchGroup.shouldLoad() set to true and the FetchGroup configured on a query be executed.

See Also:
FetchGroup, Serialized Form
Author:
ailitchev
Since:
Eclipselink 2.1

Field Summary
 
Fields inherited from class org.eclipse.persistence.queries.AttributeGroup
items
 
Constructor Summary
LoadGroup()
           
LoadGroup(java.lang.String name)
           
 
Method Summary
 void addAttribute(java.lang.String attributeNameOrPath, AttributeGroup group)
          Add a basic attribute or nested attribute with each String representing an attribute on the path to what needs to be included in the AttributeGroup.
 void addAttribute(java.lang.String attributeNameOrPath, LoadGroup group)
           
 LoadGroup clone()
           
 LoadGroup getGroup(java.lang.String attributeNameOrPath)
          Returns LoadGroup corresponding to the passed (possibly nested) attribute.
 boolean isLoadGroup()
           
protected  LoadGroup newGroup(java.lang.String name, AttributeGroup parent)
          Subclass may create different types.
 
Methods inherited from class org.eclipse.persistence.queries.AttributeGroup
addAttribute, addAttributes, containsAttribute, convert, equals, getAttributeNames, getItem, getItems, getName, hasItems, isCopyGroup, isFetchGroup, isSupersetOf, newItem, removeAttribute, setAttributeNames, setName, toCopyGroup, toFetchGroup, toLoadGroup, toString, toStringAdditionalInfo, toStringItems, toStringPath
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

LoadGroup

public LoadGroup()

LoadGroup

public LoadGroup(java.lang.String name)
Method Detail

newGroup

protected LoadGroup newGroup(java.lang.String name,
                             AttributeGroup parent)
Description copied from class: AttributeGroup
Subclass may create different types.

Overrides:
newGroup in class AttributeGroup

isLoadGroup

public boolean isLoadGroup()
Overrides:
isLoadGroup in class AttributeGroup

clone

public LoadGroup clone()
Overrides:
clone in class AttributeGroup

getGroup

public LoadGroup getGroup(java.lang.String attributeNameOrPath)
Returns LoadGroup corresponding to the passed (possibly nested) attribute.

Overrides:
getGroup in class AttributeGroup

addAttribute

public void addAttribute(java.lang.String attributeNameOrPath,
                         AttributeGroup group)
Description copied from class: AttributeGroup
Add a basic attribute or nested attribute with each String representing an attribute on the path to what needs to be included in the AttributeGroup.

Example: group.addAttribute("firstName", group1);
group.addAttribute("manager.address", group2);
Note that existing group corresponding to attributeNameOrPath will be overridden with the passed group.

Overrides:
addAttribute in class AttributeGroup
group - - an AttributeGroup to be added.

addAttribute

public void addAttribute(java.lang.String attributeNameOrPath,
                         LoadGroup group)

EclipseLink 2.1.2, build 'v20101206-r8635' API Reference