gov.nasa.pds.tools.dict
Class ObjectDefinition

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

public class ObjectDefinition
extends Definition
implements DictionaryTokens

This class represents an object definition in the PDS data dictionary.

Version:
$Revision: 2939 $
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
ObjectDefinition(java.lang.String identifier)
           
 
Method Summary
 java.util.List getOptionalElements()
           
 java.util.List getOptionalObjects()
           
 java.util.List getRequiredElements()
           
 java.util.List getRequiredObjects()
           
 boolean isElementOptional(java.lang.String identifier)
           
 boolean isElementPossible(java.lang.String identifier)
           
 boolean isElementRequired(java.lang.String identifier)
           
 boolean isObjectOptional(java.lang.String identifier)
           
 boolean isObjectPossible(java.lang.String identifier)
           
 boolean isObjectRequired(java.lang.String identifier)
           
 void setOptionalElements(java.util.List optionalElements)
           
 void setOptionalObjects(java.util.List optionalObjects)
           
 void setRequiredElements(java.util.List requiredElements)
           
 void setRequiredObjects(java.util.List requiredObjects)
           
 
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

ObjectDefinition

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

getOptionalElements

public java.util.List getOptionalElements()
Returns:
Returns the names optional elements.

setOptionalElements

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

getOptionalObjects

public java.util.List getOptionalObjects()
Returns:
Returns the name of optional objects.

setOptionalObjects

public void setOptionalObjects(java.util.List optionalObjects)
Parameters:
optionalObjects - The names of optional objects.

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.

getRequiredObjects

public java.util.List getRequiredObjects()
Returns:
Returns the names of required objects.

setRequiredObjects

public void setRequiredObjects(java.util.List requiredObjects)
Parameters:
requiredObjects - The names of required objects.

isElementRequired

public boolean isElementRequired(java.lang.String identifier)
Parameters:
identifier -
Returns:
true if element is required otherwise false.

isElementPossible

public boolean isElementPossible(java.lang.String identifier)
Parameters:
identifier -
Returns:
true if element can occur otherwise false.

isElementOptional

public boolean isElementOptional(java.lang.String identifier)
Parameters:
identifier -
Returns:
true if element is optional otherwise false.

isObjectRequired

public boolean isObjectRequired(java.lang.String identifier)
Parameters:
identifier -
Returns:
true if the object is required otherwise false.

isObjectOptional

public boolean isObjectOptional(java.lang.String identifier)
Parameters:
identifier -
Returns:
true if the object is optional otherwise false.

isObjectPossible

public boolean isObjectPossible(java.lang.String identifier)
Parameters:
identifier -
Returns:
true if the object can occur.


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