gov.nasa.pds.tools.dict
Class GroupDefinition

java.lang.Object
  extended by gov.nasa.pds.tools.dict.Definition
      extended by gov.nasa.pds.tools.dict.GroupDefinition
All Implemented Interfaces:
DictionaryTokens

public class GroupDefinition
extends Definition
implements DictionaryTokens

This class models a group definition. Groups can only contain optional and required elements. This class will only contain the identifiers of these elements.

Version:
$Revision: 2940 $
Author:
pramirez

Field Summary
 
Fields inherited from class gov.nasa.pds.tools.dict.Definition
objectType
 
Fields inherited from interface gov.nasa.pds.tools.dict.DictionaryTokens
ALIAS_LIST, DATA_TYPE, DEFINITION, DESCRIPTION, ELEMENT_ALIASES, ELEMENT_DEFINITION, ELEMENT_IDENT_LENGTH, GENERIC_GROUP, GENERIC_OBJECT, MAX_LENGTH, MAXIMUM, MIN_LENGTH, MINIMUM, NAME, NAMESPACE_LENGTH, NOT_APPLICABLE, OBJECT_ALIASES, OBJECT_TYPE, OBJECT_TYPE_GENERIC, OBJECT_TYPE_GENERIC_GROUP, OBJECT_TYPE_SPECIFIC, OBJECT_TYPE_SPECIFIC_GROUP, OPTIONAL_ELEMENTS, OPTIONAL_OBJECTS, REQUIRED_ELEMENTS, REQUIRED_OBJECTS, SPECIFIC_GROUP, SPECIFIC_OBJECT, STATUS_TYPE, UNIT_LIST, UNIT_SEQUENCE, UNITS, VALUE_TYPE, VALUE_TYPE_STATIC, VALUE_TYPE_SUGGESTED, VALUES
 
Constructor Summary
GroupDefinition(java.lang.String identifier)
           
 
Method Summary
 boolean canHaveElement(java.lang.String identifier)
           
 java.util.List getOptionalElements()
          Lists the optional elements that can appear in this group
 java.util.List getRequiredElements()
           
 boolean hasElement(java.lang.String identifier)
           
 boolean mustHaveElement(java.lang.String identifier)
           
 void setOptionalElements(java.util.List optionalElements)
           
 void setRequiredElements(java.util.List requiredElements)
           
 
Methods inherited from class gov.nasa.pds.tools.dict.Definition
addAlias, addAliases, getAliases, getDescription, getIdentifier, getObjectType, getStatusType, setAliases, setDescription, setIdentifier, setObjectType, setStatusType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GroupDefinition

public GroupDefinition(java.lang.String identifier)
Method Detail

getOptionalElements

public java.util.List getOptionalElements()
Lists the optional elements that can appear in this group

Returns:
Returns the names optional elements.

setOptionalElements

public void setOptionalElements(java.util.List optionalElements)
Parameters:
optionalElements - The names of optional elements.

getRequiredElements

public java.util.List getRequiredElements()
Returns:
Returns the names of required elements.

setRequiredElements

public void setRequiredElements(java.util.List requiredElements)
Parameters:
requiredElements - The names of required elements.

mustHaveElement

public boolean mustHaveElement(java.lang.String identifier)
Parameters:
identifier -
Returns:
Returns the required elements.

canHaveElement

public boolean canHaveElement(java.lang.String identifier)
Parameters:
identifier -
Returns:
Returns the possible elements.

hasElement

public boolean hasElement(java.lang.String identifier)


Copyright © 2005-2007 NASA Jet Propulsion Laboratory, California Institute of Technology. All Rights Reserved.