gov.nih.nci.mageom.domain.Protocol.impl
Class ParameterValueImpl

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.Protocol.impl.ParameterValueImpl
All Implemented Interfaces:
Extendable, ParameterValue, java.io.Serializable

public class ParameterValueImpl
extends ExtendableImpl
implements ParameterValue

The value of a Parameter.

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

Field Summary
protected static java.util.ArrayList allAssociationMethods
           
protected static java.util.Hashtable associationMethods
           
protected  Parameter parameterType
          DOCUMENT ME
protected  java.lang.Long parameterTypeId
          The internal ID of the associated parameterType object.
protected  java.lang.String value
          The value of the parameter.
 
Fields inherited from class gov.nih.nci.mageom.domain.impl.ExtendableImpl
propertySets, propertySetsCount, securedElementId
 
Constructor Summary
ParameterValueImpl()
          Default constructor
 
Method Summary
 Parameter getParameterType()
          Returns the value of this ParameterValue object's parameterType attribute.
 java.lang.String getValue()
          Returns the value of this ParameterValue object's value attribute.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 ParameterValue[] searchParameterValues(ParameterValueSearchCriteria criteria)
          Returns an array of ParameterValue objects that satisfy the given ParameterValueSearchCriteria.
 void setParameterType(Parameter p_parameterType)
          Sets the parameterType attribute.
 void setValue(java.lang.String p_value)
          Sets the value 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

value

protected java.lang.String value
The value of the parameter. Will have the datatype of its associated Parameter.


parameterType

protected Parameter parameterType
DOCUMENT ME


parameterTypeId

protected java.lang.Long parameterTypeId
The internal ID of the associated parameterType object.

Constructor Detail

ParameterValueImpl

public ParameterValueImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class ExtendableImpl

searchParameterValues

public ParameterValue[] searchParameterValues(ParameterValueSearchCriteria criteria)
                                       throws gov.nih.nci.common.search.SearchException
Returns an array of ParameterValue objects that satisfy the given ParameterValueSearchCriteria.

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

setValue

public void setValue(java.lang.String p_value)
Sets the value attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a ParameterValue object.

Specified by:
setValue in interface ParameterValue
Parameters:
p_value - The new value for value.
See Also:
ParameterValue.getValue()

getValue

public java.lang.String getValue()
Description copied from interface: ParameterValue
Returns the value of this ParameterValue object's value attribute. Description of value: The value of the parameter. Will have the datatype of its associated Parameter.

Specified by:
getValue in interface ParameterValue
Returns:
any The value of value.
See Also:
ParameterValue.getValue()

setParameterType

public void setParameterType(Parameter p_parameterType)
Sets the parameterType attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a ParameterValue object.

Specified by:
setParameterType in interface ParameterValue
Parameters:
p_parameterType - The new value for parameterType.
See Also:
ParameterValue.getParameterType()

getParameterType

public Parameter getParameterType()
Description copied from interface: ParameterValue
Returns the value of this ParameterValue object's parameterType attribute.

Specified by:
getParameterType in interface ParameterValue
Returns:
gov.nih.nci.mageom.bean.Protocol.Parameter The value of parameterType.
See Also:
ParameterValue.getParameterType()

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.