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

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
              extended by gov.nih.nci.mageom.domain.Measurement.impl.VolumeUnitImpl
All Implemented Interfaces:
Extendable, Unit, VolumeUnit, java.io.Serializable

public class VolumeUnitImpl
extends UnitImpl
implements VolumeUnit

Volume

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 unitNameCV
          DOCUMENT ME
 
Fields inherited from class gov.nih.nci.mageom.domain.Measurement.impl.UnitImpl
unitName
 
Fields inherited from class gov.nih.nci.mageom.domain.impl.ExtendableImpl
propertySets, propertySetsCount, securedElementId
 
Constructor Summary
VolumeUnitImpl()
          Default constructor
 
Method Summary
 java.lang.String getUnitNameCV()
          Returns the value of this VolumeUnit object's unitNameCV attribute.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 VolumeUnit[] searchVolumeUnits(VolumeUnitSearchCriteria criteria)
          Returns an array of VolumeUnit objects that satisfy the given VolumeUnitSearchCriteria.
 void setUnitNameCV(java.lang.String p_unitNameCV)
          Sets the unitNameCV 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.Measurement.impl.UnitImpl
getUnitName, searchUnits, setUnitName
 
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.Measurement.Unit
getUnitName, setUnitName
 
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

unitNameCV

protected java.lang.String unitNameCV
DOCUMENT ME

Constructor Detail

VolumeUnitImpl

public VolumeUnitImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class UnitImpl

searchVolumeUnits

public VolumeUnit[] searchVolumeUnits(VolumeUnitSearchCriteria criteria)
                               throws gov.nih.nci.common.search.SearchException
Returns an array of VolumeUnit objects that satisfy the given VolumeUnitSearchCriteria.

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

setUnitNameCV

public void setUnitNameCV(java.lang.String p_unitNameCV)
Sets the unitNameCV attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a VolumeUnit object.

Specified by:
setUnitNameCV in interface VolumeUnit
Parameters:
p_unitNameCV - The new value for unitNameCV.
See Also:
VolumeUnit.getUnitNameCV()

getUnitNameCV

public java.lang.String getUnitNameCV()
Description copied from interface: VolumeUnit
Returns the value of this VolumeUnit object's unitNameCV attribute. Description of unitNameCV: DOCUMENT ME!

Specified by:
getUnitNameCV in interface VolumeUnit
Returns:
enum {mL,cc,dL,L,uL,nL,pL,fL,other} The value of unitNameCV.
See Also:
VolumeUnit.getUnitNameCV()

toXML

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

toXMLDoc

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

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 UnitImpl
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 UnitImpl
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 UnitImpl
Returns:
the String representation.