|
EclipseLink 2.1.0, build 'v20100529-r7411' API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.persistence.queries.AttributeGroup
public class AttributeGroup
Purpose: Base class for FetchGroup and LoadGroup.
Field Summary | |
---|---|
protected java.util.Map<java.lang.String,org.eclipse.persistence.internal.queries.AttributeItem> |
items
Specified attributes in the group mapped to their AttributeItems |
Constructor Summary | |
---|---|
AttributeGroup()
|
|
AttributeGroup(java.lang.String name)
|
Method Summary | |
---|---|
org.eclipse.persistence.internal.queries.AttributeItem |
addAttribute(java.lang.String attributeNameOrPath)
Add an basic attribute or nested attribute with each String representing an attribute on the path to what needs to be included in the AttributeGroup. |
org.eclipse.persistence.internal.queries.AttributeItem |
addAttribute(java.lang.String attributeNameOrPath,
AttributeGroup group)
|
void |
addAttributes(java.util.Collection<java.lang.String> attrOrPaths)
Add a set of attributes to the group. |
AttributeGroup |
clone()
|
boolean |
containsAttribute(java.lang.String attributeNameOrPath)
Return if the attribute is defined in the group. |
protected java.lang.String[] |
convert(java.lang.String... nameOrPath)
Convert a provided name or path which could be a single attributeName, a single string with dot separated attribute names, or an array of attribute names defining the path. |
boolean |
equals(java.lang.Object obj)
|
java.util.Set<java.lang.String> |
getAttributeNames()
|
AttributeGroup |
getGroup(java.lang.String attributeNameOrPath)
Returns AttributeGroup corresponding to the passed (possibly nested) attribute. |
org.eclipse.persistence.internal.queries.AttributeItem |
getItem(java.lang.String attributeNameOrPath)
TODO |
java.util.Map<java.lang.String,org.eclipse.persistence.internal.queries.AttributeItem> |
getItems()
|
java.lang.String |
getName()
|
boolean |
hasItems()
|
boolean |
isFetchGroup()
|
boolean |
isLoadGroup()
|
boolean |
isSupersetOf(AttributeGroup anotherGroup)
Return true if this AttributeGroup is a super-set of the passed in AttributeGroup. |
AttributeGroup |
newGroup(java.lang.String name,
AttributeGroup parent)
|
org.eclipse.persistence.internal.queries.AttributeItem |
newItem(AttributeGroup group,
java.lang.String attrName)
|
void |
removeAttribute(java.lang.String attributeNameOrPath)
Remove an attribute from the group. |
void |
setAttributeNames(java.util.Set attributeNames)
|
void |
setName(java.lang.String name)
|
FetchGroup |
toFetchGroup()
|
LoadGroup |
toLoadGroup()
|
java.lang.String |
toString()
|
java.lang.String |
toStringAdditionalInfo()
|
protected java.lang.String |
toStringItems()
|
protected static java.lang.String |
toStringPath(java.lang.String[] attributePath,
int position)
|
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected java.util.Map<java.lang.String,org.eclipse.persistence.internal.queries.AttributeItem> items
Constructor Detail |
---|
public AttributeGroup(java.lang.String name)
public AttributeGroup()
Method Detail |
---|
public org.eclipse.persistence.internal.queries.AttributeItem newItem(AttributeGroup group, java.lang.String attrName)
public AttributeGroup newGroup(java.lang.String name, AttributeGroup parent)
public java.lang.String getName()
public void setName(java.lang.String name)
public java.util.Set<java.lang.String> getAttributeNames()
public void setAttributeNames(java.util.Set attributeNames)
public boolean hasItems()
public java.util.Map<java.lang.String,org.eclipse.persistence.internal.queries.AttributeItem> getItems()
public boolean containsAttribute(java.lang.String attributeNameOrPath)
public org.eclipse.persistence.internal.queries.AttributeItem addAttribute(java.lang.String attributeNameOrPath)
Example:
group.addAttribute("firstName");
group.addAttribute("manager.address");
attrPathOrName
- A simple attribute, array or attributes forming a pathpublic org.eclipse.persistence.internal.queries.AttributeItem addAttribute(java.lang.String attributeNameOrPath, AttributeGroup group)
public void addAttributes(java.util.Collection<java.lang.String> attrOrPaths)
public AttributeGroup getGroup(java.lang.String attributeNameOrPath)
public org.eclipse.persistence.internal.queries.AttributeItem getItem(java.lang.String attributeNameOrPath)
attributeNameOrPath
-
public void removeAttribute(java.lang.String attributeNameOrPath)
public boolean isSupersetOf(AttributeGroup anotherGroup)
protected java.lang.String[] convert(java.lang.String... nameOrPath)
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String toStringAdditionalInfo()
protected java.lang.String toStringItems()
protected static java.lang.String toStringPath(java.lang.String[] attributePath, int position)
public boolean isFetchGroup()
public FetchGroup toFetchGroup()
public boolean isLoadGroup()
public LoadGroup toLoadGroup()
public AttributeGroup clone()
clone
in class java.lang.Object
|
EclipseLink 2.1.0, build 'v20100529-r7411' API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |