gov.nih.nci.mageom.domain.Measurement.impl
Class UnitImpl

java.lang.Object
  extended by gov.nih.nci.mageom.domain.impl.MAGEOMObject
      extended by gov.nih.nci.mageom.domain.impl.ExtendableImpl
          extended by gov.nih.nci.mageom.domain.Measurement.impl.UnitImpl
All Implemented Interfaces:
Extendable, Unit, java.io.Serializable
Direct Known Subclasses:
ConcentrationUnitImpl, DistanceUnitImpl, MassUnitImpl, QuantityUnitImpl, TemperatureUnitImpl, TimeUnitImpl, VolumeUnitImpl

public class UnitImpl
extends ExtendableImpl
implements Unit

The unit is a strict enumeration of types.

Version:
%I%, %G%
See Also:
Serialized Form

Field Summary
protected static java.util.ArrayList allAssociationMethods
           
protected static java.util.Hashtable associationMethods
           
protected  java.lang.String unitName
          The name of the unit.
 
Fields inherited from class gov.nih.nci.mageom.domain.impl.ExtendableImpl
propertySets, propertySetsCount, securedElementId
 
Constructor Summary
UnitImpl()
          Default constructor
 
Method Summary
 java.lang.String getUnitName()
          Returns the value of this Unit object's unitName attribute.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 Unit[] searchUnits(UnitSearchCriteria criteria)
          Returns an array of Unit objects that satisfy the given UnitSearchCriteria.
 void setUnitName(java.lang.String p_unitName)
          Sets the unitName attribute.
 java.lang.String toString()
          Returns a String representation of this object suitable for console display.
 org.w3c.dom.Element toXML(org.w3c.dom.Document doc)
           
 org.w3c.dom.Element toXMLDoc(org.w3c.dom.Document doc)
           
 org.w3c.dom.Element toXMLProcessor(org.w3c.dom.Document doc, java.util.ArrayList fillOutValues)
          Returns an XML representation of the object.
 
Methods inherited from class gov.nih.nci.mageom.domain.impl.ExtendableImpl
getPropertySets, getPropertySetsCount, getSecuredElementId, searchExtendables, setPropertySets, setSecuredElementId
 
Methods inherited from class gov.nih.nci.mageom.domain.impl.MAGEOMObject
getId, getIsEditable, setId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface gov.nih.nci.mageom.domain.Extendable
getPropertySets, setPropertySets
 

Field Detail

allAssociationMethods

protected static java.util.ArrayList allAssociationMethods

associationMethods

protected static java.util.Hashtable associationMethods

unitName

protected java.lang.String unitName
The name of the unit.

Constructor Detail

UnitImpl

public UnitImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class ExtendableImpl

searchUnits

public Unit[] searchUnits(UnitSearchCriteria criteria)
                   throws gov.nih.nci.common.search.SearchException
Returns an array of Unit objects that satisfy the given UnitSearchCriteria.

Parameters:
criteria - The UnitSearchCriteria which represents a query for Unit objects.
Returns:
An array of Unit objects.
Throws:
A - gov.nih.nci.common.search.SearchException if there is a problem searching.
gov.nih.nci.common.search.SearchException

setUnitName

public void setUnitName(java.lang.String p_unitName)
Sets the unitName attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Unit object.

Specified by:
setUnitName in interface Unit
Parameters:
p_unitName - The new value for unitName.
See Also:
Unit.getUnitName()

getUnitName

public java.lang.String getUnitName()
Description copied from interface: Unit
Returns the value of this Unit object's unitName attribute. Description of unitName: The name of the unit.

Specified by:
getUnitName in interface Unit
Returns:
String The value of unitName.
See Also:
Unit.getUnitName()

toXML

public org.w3c.dom.Element toXML(org.w3c.dom.Document doc)
Overrides:
toXML in class ExtendableImpl

toXMLDoc

public org.w3c.dom.Element toXMLDoc(org.w3c.dom.Document doc)
Overrides:
toXMLDoc in class ExtendableImpl

toXMLProcessor

public org.w3c.dom.Element toXMLProcessor(org.w3c.dom.Document doc,
                                          java.util.ArrayList fillOutValues)
Returns an XML representation of the object. The document is not modified.

Overrides:
toXMLProcessor in class ExtendableImpl
Parameters:
doc - the working document
fillOutValues - a list of attribute names that should have full XML for their values.
Returns:
org.w3c.dom.Element an XML representation

getXMLMethodDescriptors

public java.util.Hashtable getXMLMethodDescriptors()
Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.

Overrides:
getXMLMethodDescriptors in class ExtendableImpl
Returns:
Hashtable The Hashtable of descriptors.

toString

public java.lang.String toString()
Returns a String representation of this object suitable for console display.

Overrides:
toString in class ExtendableImpl
Returns:
the String representation.