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

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.ParameterizableImpl
All Implemented Interfaces:
Describable, Extendable, Identifiable, Parameterizable, java.io.Serializable
Direct Known Subclasses:
HardwareImpl, ProtocolImpl, SoftwareImpl

public class ParameterizableImpl
extends IdentifiableImpl
implements Parameterizable

The Parameterizable interface encapsulates the association of Parameters with ParameterValues.

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

Field Summary
protected static java.util.ArrayList allAssociationMethods
           
protected static java.util.Hashtable associationMethods
           
protected  Parameter[] parameterTypes
          DOCUMENT ME
protected  int parameterTypesCount
          The count of Parameter objects.
protected  java.lang.String URI
          Where an instantiated Parameterizable is located.
 
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
ParameterizableImpl()
          Default constructor
 
Method Summary
 Parameter[] getParameterTypes()
          Returns the value of this Parameterizable object's parameterTypes attribute.
 int getParameterTypesCount()
          Returns the count of all Parameter associated with this Parameterizable object.
 java.lang.String getURI()
          Returns the value of this Parameterizable object's URI attribute.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 Parameterizable[] searchParameterizables(ParameterizableSearchCriteria criteria)
          Returns an array of Parameterizable objects that satisfy the given ParameterizableSearchCriteria.
 void setParameterTypes(Parameter[] p_parameterTypes)
          Sets the parameterTypes attribute.
 void setURI(java.lang.String p_URI)
          Sets the URI 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

URI

protected java.lang.String URI
Where an instantiated Parameterizable is located.


parameterTypesCount

protected int parameterTypesCount
The count of Parameter objects.


parameterTypes

protected Parameter[] parameterTypes
DOCUMENT ME

Constructor Detail

ParameterizableImpl

public ParameterizableImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class IdentifiableImpl

searchParameterizables

public Parameterizable[] searchParameterizables(ParameterizableSearchCriteria criteria)
                                         throws gov.nih.nci.common.search.SearchException
Returns an array of Parameterizable objects that satisfy the given ParameterizableSearchCriteria.

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

setURI

public void setURI(java.lang.String p_URI)
Sets the URI attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Parameterizable object.

Specified by:
setURI in interface Parameterizable
Parameters:
p_URI - The new value for URI.
See Also:
Parameterizable.getURI()

getURI

public java.lang.String getURI()
Description copied from interface: Parameterizable
Returns the value of this Parameterizable object's URI attribute. Description of URI: Where an instantiated Parameterizable is located.

Specified by:
getURI in interface Parameterizable
Returns:
String The value of URI.
See Also:
Parameterizable.getURI()

setParameterTypes

public void setParameterTypes(Parameter[] p_parameterTypes)
Sets the parameterTypes attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Parameterizable object.

Specified by:
setParameterTypes in interface Parameterizable
Parameters:
p_parameterTypes - The new value for parameterTypes.
See Also:
Parameterizable.getParameterTypes()

getParameterTypes

public Parameter[] getParameterTypes()
Description copied from interface: Parameterizable
Returns the value of this Parameterizable object's parameterTypes attribute.

Specified by:
getParameterTypes in interface Parameterizable
Returns:
gov.nih.nci.mageom.bean.Protocol.Parameter[] The value of parameterTypes.
See Also:
Parameterizable.getParameterTypes()

getParameterTypesCount

public int getParameterTypesCount()
Returns the count of all Parameter associated with this Parameterizable object.

Returns:
the count
See Also:
Parameterizable.getParameterTypes()

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.