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

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.impl.DescribableImpl
              extended by gov.nih.nci.mageom.domain.impl.IdentifiableImpl
                  extended by gov.nih.nci.mageom.domain.Protocol.impl.ParameterImpl
All Implemented Interfaces:
Describable, Extendable, Identifiable, Parameter, java.io.Serializable

public class ParameterImpl
extends IdentifiableImpl
implements Parameter

A Parameter is a replaceable value in a Parameterizable class. Examples of Parameters include: scanning wavelength, laser power, centrifuge speed, multiplicative errors, the number of input nodes to a SOM, and PCR temperatures.

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

Field Summary
protected static java.util.ArrayList allAssociationMethods
           
protected static java.util.Hashtable associationMethods
           
protected  OntologyEntry dataType
          DOCUMENT ME
protected  java.lang.Long dataTypeId
          The internal ID of the associated dataType object.
protected  Measurement defaultValue
          DOCUMENT ME
protected  java.lang.Long defaultValueId
          The internal ID of the associated defaultValue object.
 
Fields inherited from class gov.nih.nci.mageom.domain.impl.IdentifiableImpl
identifier, name
 
Fields inherited from class gov.nih.nci.mageom.domain.impl.DescribableImpl
auditTrail, auditTrailCount, descriptions, descriptionsCount, security, securityId
 
Fields inherited from class gov.nih.nci.mageom.domain.impl.ExtendableImpl
propertySets, propertySetsCount, securedElementId
 
Constructor Summary
ParameterImpl()
          Default constructor
 
Method Summary
 OntologyEntry getDataType()
          Returns the value of this Parameter object's dataType attribute.
 Measurement getDefaultValue()
          Returns the value of this Parameter object's defaultValue attribute.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 Parameter[] searchParameters(ParameterSearchCriteria criteria)
          Returns an array of Parameter objects that satisfy the given ParameterSearchCriteria.
 void setDataType(OntologyEntry p_dataType)
          Sets the dataType attribute.
 void setDefaultValue(Measurement p_defaultValue)
          Sets the defaultValue 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.IdentifiableImpl
getIdentifier, getName, searchIdentifiables, setIdentifier, setName
 
Methods inherited from class gov.nih.nci.mageom.domain.impl.DescribableImpl
getAuditTrail, getAuditTrailCount, getDescriptions, getDescriptionsCount, getSecurity, searchDescribables, setAuditTrail, setDescriptions, setSecurity
 
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.Identifiable
getIdentifier, getName, setIdentifier, setName
 
Methods inherited from interface gov.nih.nci.mageom.domain.Describable
getAuditTrail, getDescriptions, getSecurity, setAuditTrail, setDescriptions, setSecurity
 
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

dataType

protected OntologyEntry dataType
DOCUMENT ME


dataTypeId

protected java.lang.Long dataTypeId
The internal ID of the associated dataType object.


defaultValue

protected Measurement defaultValue
DOCUMENT ME


defaultValueId

protected java.lang.Long defaultValueId
The internal ID of the associated defaultValue object.

Constructor Detail

ParameterImpl

public ParameterImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class IdentifiableImpl

searchParameters

public Parameter[] searchParameters(ParameterSearchCriteria criteria)
                             throws gov.nih.nci.common.search.SearchException
Returns an array of Parameter objects that satisfy the given ParameterSearchCriteria.

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

setDataType

public void setDataType(OntologyEntry p_dataType)
Sets the dataType attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Parameter object.

Specified by:
setDataType in interface Parameter
Parameters:
p_dataType - The new value for dataType.
See Also:
Parameter.getDataType()

getDataType

public OntologyEntry getDataType()
Description copied from interface: Parameter
Returns the value of this Parameter object's dataType attribute.

Specified by:
getDataType in interface Parameter
Returns:
gov.nih.nci.mageom.bean.Description.OntologyEntry The value of dataType.
See Also:
Parameter.getDataType()

setDefaultValue

public void setDefaultValue(Measurement p_defaultValue)
Sets the defaultValue attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Parameter object.

Specified by:
setDefaultValue in interface Parameter
Parameters:
p_defaultValue - The new value for defaultValue.
See Also:
Parameter.getDefaultValue()

getDefaultValue

public Measurement getDefaultValue()
Description copied from interface: Parameter
Returns the value of this Parameter object's defaultValue attribute.

Specified by:
getDefaultValue in interface Parameter
Returns:
gov.nih.nci.mageom.bean.Measurement.Measurement The value of defaultValue.
See Also:
Parameter.getDefaultValue()

toXML

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

toXMLDoc

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

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