Constructor Detail

• CoreAttributeGroup

  public CoreAttributeGroup​(java.lang.String name)

• CoreAttributeGroup

  public CoreAttributeGroup​(java.lang.String name,
                            java.lang.String type,
                            boolean isValidated)

• CoreAttributeGroup

  public CoreAttributeGroup​(java.lang.String name,
                            java.lang.Class type,
                            boolean isValidated)

  INTERNAL: This constructer is to only be used by EclipseLink internally

  Parameters:

  name -

  type -

• CoreAttributeGroup

  public CoreAttributeGroup()

Method Detail

• addAttribute

  public void addAttribute​(java.lang.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.

  Example: group.addAttribute("firstName");
group.addAttribute("manager.address");

  Parameters:

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

• addAttribute

  public void addAttribute​(java.lang.String attributeNameOrPath,
                           java.util.Collection<? extends CoreAttributeGroup> groups)

  Add an attribute and the corresponding list of AttributeGroups. Multiple groups are added in the case of inheritance

  Parameters:

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

  groups - - a collection of AttributeGroups to be added.

• addAttribute

  public 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.

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

  Parameters:

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

  group - - an AttributeGroup to be added.

• addAttributeKey

  public void addAttributeKey​(java.lang.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.

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

  Parameters:

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

  group - - an AttributeGroup to be added.

• addAttributes

  public void addAttributes​(java.util.Collection<java.lang.String> attrOrPaths)

  Add a set of attributes to the group.

• clone

  public CoreAttributeGroup clone()

• clone

  public CoreAttributeGroup clone​(java.util.Map<CoreAttributeGroup<ATTRIBUTE_ITEM,​DESCRIPTOR>,​CoreAttributeGroup<ATTRIBUTE_ITEM,​DESCRIPTOR>> cloneMap)

  INTERNAL: This method is used internally in the clone processing.

  Parameters:

  cloneMap -

  Returns:

• containsAttribute

  public boolean containsAttribute​(java.lang.String attributeNameOrPath)

  Return if the attribute is defined in the group.

• containsAttributeInternal

  public boolean containsAttributeInternal​(java.lang.String attributeName)

  INTERNAL: Return if the attribute is defined in the group. Only local attribute names are checked.

• convertClassNamesToClasses

  public void convertClassNamesToClasses​(java.lang.ClassLoader classLoader)

  INTERNAL: Convert all the class-name-based settings in this Descriptor to actual class-based settings. This method is used when converting a project that has been built with class names to a project with classes.

  Parameters:

  classLoader -

• equals

  public boolean equals​(java.lang.Object obj)

  Overrides:

  equals in class java.lang.Object

• findGroup

  public CoreAttributeGroup findGroup​(DESCRIPTOR type)

• getAllItems

  public java.util.Map<java.lang.String,​ATTRIBUTE_ITEM> getAllItems()

  INTERNAL:

• getAttributeNames

  public java.util.Set<java.lang.String> getAttributeNames()

• getGroup

  public CoreAttributeGroup getGroup​(java.lang.String attributeNameOrPath)

  Returns AttributeGroup corresponding to the passed (possibly nested) attribute.

• getItem

  public ATTRIBUTE_ITEM getItem​(java.lang.String attributeNameOrPath)

  INTERNAL: Lookup the AttributeItem for the provided attribute name or path.

  Returns:

  item or null

  Throws:

  java.lang.IllegalArgumentException - if name is not valid attribute name or path

• getItems

  public java.util.Map<java.lang.String,​ATTRIBUTE_ITEM> getItems()

  INTERNAL:

• getName

  public java.lang.String getName()

• getSubClassGroups

  public java.util.Map<java.lang.Object,​CoreAttributeGroup> getSubClassGroups()

  INTERNAL:

• getType

  public java.lang.Class getType()

• getTypeName

  public java.lang.String getTypeName()

  INTERNAL: Returns the name of the type this group represents

• hasInheritance

  public boolean hasInheritance()

  Indicates whether this group is part of an inheritance hierarchy

• hasItems

  public boolean hasItems()

  Indicates whether the group has at least one attribute.

• insertSubClass

  public void insertSubClass​(CoreAttributeGroup group)

  INTERNAL: This method will insert the group into the entity hierarchy just below this AttributeGroup.

  Parameters:

  group -

• isConcurrent

  public boolean isConcurrent()

  INTERNAL: Only LoadGroups allow concurrency.

• isCopyGroup

  public boolean isCopyGroup()

  INTERNAL: This method is used internally when converting to a copy group.

  Returns:

• isFetchGroup

  public boolean isFetchGroup()

• isLoadGroup

  public boolean isLoadGroup()

• isSupersetOf

  public boolean isSupersetOf​(CoreAttributeGroup<ATTRIBUTE_ITEM,​DESCRIPTOR> anotherGroup)

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

• isValidated

  public boolean isValidated()

  INTERNAL:

  Returns:

  the isValidated

• removeAttribute

  public void removeAttribute​(java.lang.String attributeNameOrPath)

  Remove an attribute from the group.

• setAllSubclasses

  public void setAllSubclasses​(java.util.Map<java.lang.Object,​CoreAttributeGroup> subclasses)

  INTERNAL:

• setAttributeNames

  public void setAttributeNames​(java.util.Set attributeNames)

• setName

  public void setName​(java.lang.String name)

• toString

  public java.lang.String toString()

  Overrides:

  toString in class java.lang.Object