public class CoreAttributeGroup<ATTRIBUTE_ITEM extends CoreAttributeItem> extends Object implements Serializable, Cloneable
AttributeGroup
,
Serialized FormConstructor and Description |
---|
CoreAttributeGroup() |
CoreAttributeGroup(String name) |
CoreAttributeGroup(String name,
Class type,
boolean isValidated)
INTERNAL:
This constructer is to only be used by EclipseLink internally
|
CoreAttributeGroup(String name,
String type,
boolean isValidated) |
Modifier and Type | Method and Description |
---|---|
void |
addAttribute(String attributeNameOrPath)
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(String attributeNameOrPath,
Collection<? extends CoreAttributeGroup> groups)
Add an attribute and the corresponding list of AttributeGroups.
|
void |
addAttribute(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.
|
void |
addAttributeKey(String attributeNameOrPath,
CoreAttributeGroup group)
Add a basic attribute or nested attribute with each String representing
the key of an attribute of type Map on the path to what needs to be
included in the AttributeGroup.
|
void |
addAttributes(Collection<String> attrOrPaths)
Add a set of attributes to the group.
|
CoreAttributeGroup |
clone() |
CoreAttributeGroup |
clone(Map<CoreAttributeGroup<ATTRIBUTE_ITEM>,CoreAttributeGroup<ATTRIBUTE_ITEM>> cloneMap)
INTERNAL:
This method is used internally in the clone processing.
|
boolean |
containsAttribute(String attributeNameOrPath)
Return if the attribute is defined in the group.
|
boolean |
containsAttributeInternal(String attributeName)
INTERNAL:
Return if the attribute is defined in the group.
|
void |
convertClassNamesToClasses(ClassLoader classLoader)
INTERNAL:
Convert all the class-name-based settings in this Descriptor to actual class-based
settings.
|
boolean |
equals(Object obj) |
CoreAttributeGroup |
findGroup(ClassDescriptor type) |
Map<String,ATTRIBUTE_ITEM> |
getAllItems()
INTERNAL:
|
Set<String> |
getAttributeNames() |
CoreAttributeGroup |
getGroup(String attributeNameOrPath)
Returns AttributeGroup corresponding to the passed (possibly nested)
attribute.
|
ATTRIBUTE_ITEM |
getItem(String attributeNameOrPath)
INTERNAL:
Lookup the
AttributeItem for the provided attribute name or path. |
Map<String,ATTRIBUTE_ITEM> |
getItems()
INTERNAL:
|
String |
getName() |
Map<Object,CoreAttributeGroup> |
getSubClassGroups()
INTERNAL:
|
Class |
getType() |
String |
getTypeName()
INTERNAL:
Returns the name of the type this group represents
|
boolean |
hasInheritance()
Indicates whether this group is part of an inheritance hierarchy
|
boolean |
hasItems()
Indicates whether the group has at least one attribute.
|
void |
insertSubClass(CoreAttributeGroup group)
INTERNAL:
This method will insert the group into the entity hierarchy just below this AttributeGroup.
|
boolean |
isConcurrent()
INTERNAL:
Only LoadGroups allow concurrency.
|
boolean |
isCopyGroup()
INTERNAL:
This method is used internally when converting to a copy group.
|
boolean |
isFetchGroup() |
boolean |
isLoadGroup() |
boolean |
isSupersetOf(CoreAttributeGroup<ATTRIBUTE_ITEM> anotherGroup)
Return true if this AttributeGroup is a super-set of the passed in
AttributeGroup.
|
boolean |
isValidated()
INTERNAL:
|
void |
removeAttribute(String attributeNameOrPath)
Remove an attribute from the group.
|
void |
setAllSubclasses(Map<Object,CoreAttributeGroup> subclasses)
INTERNAL:
|
void |
setAttributeNames(Set attributeNames) |
void |
setName(String name) |
String |
toString() |
public CoreAttributeGroup(String name)
public CoreAttributeGroup(String name, Class type, boolean isValidated)
name
- type
- public CoreAttributeGroup()
public void addAttribute(String attributeNameOrPath)
Example:
group.addAttribute("firstName");
group.addAttribute("manager.address");
attrPathOrName
- A simple attribute, array or attributes forming a pathpublic void addAttribute(String attributeNameOrPath, Collection<? extends CoreAttributeGroup> groups)
attrPathOrName
- A simple attribute, array or attributes forming a pathgroup
- - a collection of AttributeGroups to be added.public void addAttribute(String attributeNameOrPath, CoreAttributeGroup group)
Example:
group.addAttribute("firstName", group1);
Note that existing group corresponding to attributeNameOrPath
will be overridden with the passed group.
group.addAttribute("manager.address", group2);
attrPathOrName
- A simple attribute, array or attributes forming a pathgroup
- - an AttributeGroup to be added.public void addAttributeKey(String attributeNameOrPath, CoreAttributeGroup group)
Example:
group.addAttribute("firstName", group1);
Note that existing group corresponding to attributeNameOrPath will be
overridden with the passed group.
group.addAttribute("manager.address", group2);
attrPathOrName
- A simple attribute, array or attributes forming a path to a
Map keygroup
- - an AttributeGroup to be added.public void addAttributes(Collection<String> attrOrPaths)
public CoreAttributeGroup clone()
public CoreAttributeGroup clone(Map<CoreAttributeGroup<ATTRIBUTE_ITEM>,CoreAttributeGroup<ATTRIBUTE_ITEM>> cloneMap)
cloneMap
- public boolean containsAttribute(String attributeNameOrPath)
public boolean containsAttributeInternal(String attributeName)
public void convertClassNamesToClasses(ClassLoader classLoader)
classLoader
- public CoreAttributeGroup findGroup(ClassDescriptor type)
public Map<String,ATTRIBUTE_ITEM> getAllItems()
public CoreAttributeGroup getGroup(String attributeNameOrPath)
public ATTRIBUTE_ITEM getItem(String attributeNameOrPath)
AttributeItem
for the provided attribute name or path.IllegalArgumentException
- if name is not valid attribute name or pathpublic Map<String,ATTRIBUTE_ITEM> getItems()
public String getName()
public Map<Object,CoreAttributeGroup> getSubClassGroups()
public Class getType()
public String getTypeName()
public boolean hasInheritance()
public boolean hasItems()
public void insertSubClass(CoreAttributeGroup group)
group
- public boolean isConcurrent()
public boolean isCopyGroup()
cloneMap
- public boolean isFetchGroup()
public boolean isLoadGroup()
public boolean isSupersetOf(CoreAttributeGroup<ATTRIBUTE_ITEM> anotherGroup)
public boolean isValidated()
public void removeAttribute(String attributeNameOrPath)
public void setAllSubclasses(Map<Object,CoreAttributeGroup> subclasses)
public void setAttributeNames(Set attributeNames)
public void setName(String name)