com.metamatrix.common.object
Class PropertyDefinitionGroup

java.lang.Object
  extended by com.metamatrix.common.object.ObjectDefinitionImpl
      extended by com.metamatrix.common.object.PropertyDefinitionGroup
All Implemented Interfaces:
ObjectDefinition, PropertiedObject, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable

public class PropertyDefinitionGroup
extends ObjectDefinitionImpl

PropertyDefinitionGroup is a nestable list of PropertyDefinitions that are defined to be used together. The data structure also contains a name, displayName, and other ObjectDefinition properties.

See Also:
Serialized Form

Constructor Summary
PropertyDefinitionGroup(java.lang.String name, java.lang.String displayName, java.lang.String shortDescription, java.util.List propertyDefinitions)
          Create an instance of the PropertyDefinitionGroup, specifying the list of PropertyDefinition instances to be used.
PropertyDefinitionGroup(java.lang.String name, java.lang.String displayName, java.lang.String shortDescription, java.util.List propertyDefinitions, java.util.List subPropertyDefinitionGroups)
          Create an instance of the PropertyDefinitionGroup, specifying the list of PropertyDefinition instances to be used and an optional List of subgroup definitions
 
Method Summary
 java.util.List getPropertyDefinitions()
          obtain the List of PropertyDefinitions for this instance.
 java.util.List getSubGroups()
          obtain the List of PropertyDefinitionGroups that are contained by this instance.
 boolean hasSubgroups()
          determine if this PropertiedObjectGroup has subgroups.
 
Methods inherited from class com.metamatrix.common.object.ObjectDefinitionImpl
clone, compareTo, computeDisplayName, computePluralDisplayName, equals, getDisplayName, getName, getPluralDisplayName, getShortDescription, getShortDisplayName, hashCode, setDisplayName, setName, setPluralDisplayName, setShortDescription, setShortDisplayName, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PropertyDefinitionGroup

public PropertyDefinitionGroup(java.lang.String name,
                               java.lang.String displayName,
                               java.lang.String shortDescription,
                               java.util.List propertyDefinitions)
Create an instance of the PropertyDefinitionGroup, specifying the list of PropertyDefinition instances to be used.

Parameters:
name - the identifier of this instance.
displayName - the displayable name for this property; or null if the display name is the same as the property name.
shortDescription - the short description for this property, or null if there is no short description.
propertyDefinitions - the list of PropertyDefinition instances; the list is assumed to be immutable, and may never be null

PropertyDefinitionGroup

public PropertyDefinitionGroup(java.lang.String name,
                               java.lang.String displayName,
                               java.lang.String shortDescription,
                               java.util.List propertyDefinitions,
                               java.util.List subPropertyDefinitionGroups)
Create an instance of the PropertyDefinitionGroup, specifying the list of PropertyDefinition instances to be used and an optional List of subgroup definitions

Parameters:
name - the identifier of this instance.
displayName - the displayable name for this property; or null if the display name is the same as the property name.
shortDescription - the short description for this property, or null if there is no short description.
propertyDefinitions - the list of PropertyDefinition instances; the list is assumed to be immutable, and may never be null
subPropertyDefinitionGroups - the list of PropertyDefinitionGroup instances that are contained by this instance; the list is assumed to be immutable, may be null or an empty list.
Method Detail

getPropertyDefinitions

public java.util.List getPropertyDefinitions()
obtain the List of PropertyDefinitions for this instance.

Returns:
the list of PropertyDefinitions.

hasSubgroups

public boolean hasSubgroups()
determine if this PropertiedObjectGroup has subgroups.

Returns:
true if subgroups exist, false if not.

getSubGroups

public java.util.List getSubGroups()
obtain the List of PropertyDefinitionGroups that are contained by this instance.

Returns:
the subgroups, may be null if there are none.


Copyright © 2009. All Rights Reserved.