gov.nih.nci.mageom.domain.BioMaterial.impl
Class CompoundMeasurementImpl

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.BioMaterial.impl.CompoundMeasurementImpl
All Implemented Interfaces:
CompoundMeasurement, Extendable, java.io.Serializable

public class CompoundMeasurementImpl
extends ExtendableImpl
implements CompoundMeasurement

A CompoundMeasurement is a pairing of a source Compound and an amount (Measurement) of that Compound.

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

Field Summary
protected static java.util.ArrayList allAssociationMethods
           
protected static java.util.Hashtable associationMethods
           
protected  Compound compound
          DOCUMENT ME
protected  java.lang.Long compoundId
          The internal ID of the associated compound object.
protected  Measurement measurement
          DOCUMENT ME
protected  java.lang.Long measurementId
          The internal ID of the associated measurement object.
 
Fields inherited from class gov.nih.nci.mageom.domain.impl.ExtendableImpl
propertySets, propertySetsCount, securedElementId
 
Constructor Summary
CompoundMeasurementImpl()
          Default constructor
 
Method Summary
 Compound getCompound()
          Returns the value of this CompoundMeasurement object's compound attribute.
 Measurement getMeasurement()
          Returns the value of this CompoundMeasurement object's measurement attribute.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 CompoundMeasurement[] searchCompoundMeasurements(CompoundMeasurementSearchCriteria criteria)
          Returns an array of CompoundMeasurement objects that satisfy the given CompoundMeasurementSearchCriteria.
 void setCompound(Compound p_compound)
          Sets the compound attribute.
 void setMeasurement(Measurement p_measurement)
          Sets the measurement 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

measurement

protected Measurement measurement
DOCUMENT ME


measurementId

protected java.lang.Long measurementId
The internal ID of the associated measurement object.


compound

protected Compound compound
DOCUMENT ME


compoundId

protected java.lang.Long compoundId
The internal ID of the associated compound object.

Constructor Detail

CompoundMeasurementImpl

public CompoundMeasurementImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class ExtendableImpl

searchCompoundMeasurements

public CompoundMeasurement[] searchCompoundMeasurements(CompoundMeasurementSearchCriteria criteria)
                                                 throws gov.nih.nci.common.search.SearchException
Returns an array of CompoundMeasurement objects that satisfy the given CompoundMeasurementSearchCriteria.

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

setMeasurement

public void setMeasurement(Measurement p_measurement)
Sets the measurement attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a CompoundMeasurement object.

Specified by:
setMeasurement in interface CompoundMeasurement
Parameters:
p_measurement - The new value for measurement.
See Also:
CompoundMeasurement.getMeasurement()

getMeasurement

public Measurement getMeasurement()
Description copied from interface: CompoundMeasurement
Returns the value of this CompoundMeasurement object's measurement attribute.

Specified by:
getMeasurement in interface CompoundMeasurement
Returns:
gov.nih.nci.mageom.bean.Measurement.Measurement The value of measurement.
See Also:
CompoundMeasurement.getMeasurement()

setCompound

public void setCompound(Compound p_compound)
Sets the compound attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a CompoundMeasurement object.

Specified by:
setCompound in interface CompoundMeasurement
Parameters:
p_compound - The new value for compound.
See Also:
CompoundMeasurement.getCompound()

getCompound

public Compound getCompound()
Description copied from interface: CompoundMeasurement
Returns the value of this CompoundMeasurement object's compound attribute.

Specified by:
getCompound in interface CompoundMeasurement
Returns:
gov.nih.nci.mageom.bean.BioMaterial.Compound The value of compound.
See Also:
CompoundMeasurement.getCompound()

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.