org.eclipse.persistence.internal.queries

Class EntityFetchGroup

java.lang.Object

org.eclipse.persistence.core.queries.CoreAttributeGroup<AttributeItem,ClassDescriptor>

org.eclipse.persistence.queries.AttributeGroup

org.eclipse.persistence.queries.FetchGroup

org.eclipse.persistence.internal.queries.EntityFetchGroup

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class EntityFetchGroup
extends FetchGroup

EntityFetchGroup reflects the state of the object. Because EntityFetchGroup doesn't attempt to track the state of related objects it is flat (non-nested).

Since:

EclipseLink 2.1

Author:

dclarke, ailitchev

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EntityFetchGroup(java.util.Collection<java.lang.String> attributeNames)
EntityFetchGroup(FetchGroup fetchGroup)
EntityFetchGroup(FetchGroup fetchGroup, java.lang.String attributeName)
EntityFetchGroup(java.lang.String attributeName)
EntityFetchGroup(java.lang.String[] attributeNames)

Method Summary

Modifier and Type	Method and Description
void	addAttribute(java.lang.String attributeNameOrPath, CoreAttributeGroup 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.
boolean	isEntityFetchGroup()
boolean	isSupersetOf(CoreAttributeGroup anotherGroup) Return true if this EntityFetchGroup is a super-set of the passed in EntityFetchGroup.
java.lang.String	onUnfetchedAttribute(FetchGroupTracker entity, java.lang.String attributeName) Called on attempt to get value of an attribute that hasn't been fetched yet.
java.lang.String	onUnfetchedAttributeForSet(FetchGroupTracker entity, java.lang.String attributeName) Called on attempt to assign value to an attribute that hasn't been fetched yet.
void	removeAttribute(java.lang.String attributeNameOrPath) Remove an attribute from the group.
void	setOnEntity(java.lang.Object entity, AbstractSession session) Set this EntityFetchGroup on an entity implementing FetchGroupTracker.

Methods inherited from class org.eclipse.persistence.queries.FetchGroup

addAttribute, addAttributeKey, clone, getAttributes, getEntityFetchGroup, getGroup, getRootEntity, isFetchGroup, setRootEntity, setShouldLoad, setShouldLoadAll, shouldLoad, toLoadGroup, toLoadGroupLoadOnly

Methods inherited from class org.eclipse.persistence.queries.AttributeGroup

addAttribute, findGroup, getItem, isConcurrent, isCopyGroup, isLoadGroup, isSupersetOf, toCopyGroup, toCopyGroup, toFetchGroup, toFetchGroup, toLoadGroup

Methods inherited from class org.eclipse.persistence.core.queries.CoreAttributeGroup

addAttribute, addAttributes, clone, containsAttribute, containsAttributeInternal, convertClassNamesToClasses, equals, getAllItems, getAttributeNames, getItems, getName, getSubClassGroups, getType, getTypeName, hasInheritance, hasItems, insertSubClass, isValidated, setAllSubclasses, setAttributeNames, setName, toString

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EntityFetchGroup

public EntityFetchGroup(FetchGroup fetchGroup)

EntityFetchGroup

public EntityFetchGroup(java.lang.String attributeName)

EntityFetchGroup

public EntityFetchGroup(java.util.Collection<java.lang.String> attributeNames)

EntityFetchGroup

public EntityFetchGroup(java.lang.String[] attributeNames)

EntityFetchGroup

public EntityFetchGroup(FetchGroup fetchGroup,
                        java.lang.String attributeName)

Method Detail

addAttribute

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

Description copied from class: CoreAttributeGroup

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 FetchGroup

Parameters:

attributeNameOrPath - A simple attribute, array or attributes forming a path

group - - an AttributeGroup to be added.

onUnfetchedAttribute

public java.lang.String onUnfetchedAttribute(FetchGroupTracker entity,
                                             java.lang.String attributeName)

Called on attempt to get value of an attribute that hasn't been fetched yet. Returns an error message in case exception should be thrown by the calling method, null otherwise.

Overrides:

onUnfetchedAttribute in class FetchGroup

onUnfetchedAttributeForSet

public java.lang.String onUnfetchedAttributeForSet(FetchGroupTracker entity,
                                                   java.lang.String attributeName)

Called on attempt to assign value to an attribute that hasn't been fetched yet. Returns an error message in case exception should be thrown by the calling method, null otherwise.

Overrides:

onUnfetchedAttributeForSet in class FetchGroup

removeAttribute

public void removeAttribute(java.lang.String attributeNameOrPath)

Description copied from class: CoreAttributeGroup

Remove an attribute from the group.

Overrides:

removeAttribute in class CoreAttributeGroup<AttributeItem,ClassDescriptor>

setOnEntity

public void setOnEntity(java.lang.Object entity,
                        AbstractSession session)

Set this EntityFetchGroup on an entity implementing FetchGroupTracker.

isEntityFetchGroup

public boolean isEntityFetchGroup()

Overrides:

isEntityFetchGroup in class FetchGroup

isSupersetOf

public boolean isSupersetOf(CoreAttributeGroup anotherGroup)

Return true if this EntityFetchGroup is a super-set of the passed in EntityFetchGroup.

Overrides:

isSupersetOf in class CoreAttributeGroup<AttributeItem,ClassDescriptor>