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

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

public class ProtocolImpl
extends ParameterizableImpl
implements Protocol

A Protocol is a parameterizable description of a method. ProtocolApplication is used to specify the ParameterValues of it's Protocol's Parameters.

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

Field Summary
protected static java.util.ArrayList allAssociationMethods
           
protected static java.util.Hashtable associationMethods
           
protected  Hardware[] hardwares
          DOCUMENT ME
protected  int hardwaresCount
          The count of Hardware objects.
protected  Software[] softwares
          DOCUMENT ME
protected  int softwaresCount
          The count of Software objects.
protected  java.lang.String text
          The text description of the Protocol.
protected  java.lang.String title
          The title of the Protocol
protected  OntologyEntry type
          DOCUMENT ME
protected  java.lang.Long typeId
          The internal ID of the associated type object.
 
Fields inherited from class gov.nih.nci.mageom.domain.Protocol.impl.ParameterizableImpl
parameterTypes, parameterTypesCount, URI
 
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
ProtocolImpl()
          Default constructor
 
Method Summary
 Hardware[] getHardwares()
          Returns the value of this Protocol object's hardwares attribute.
 int getHardwaresCount()
          Returns the count of all Hardware associated with this Protocol object.
 Software[] getSoftwares()
          Returns the value of this Protocol object's softwares attribute.
 int getSoftwaresCount()
          Returns the count of all Software associated with this Protocol object.
 java.lang.String getText()
          Returns the value of this Protocol object's text attribute.
 java.lang.String getTitle()
          Returns the value of this Protocol object's title attribute.
 OntologyEntry getType()
          Returns the value of this Protocol object's type attribute.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 Protocol[] searchProtocols(ProtocolSearchCriteria criteria)
          Returns an array of Protocol objects that satisfy the given ProtocolSearchCriteria.
 void setHardwares(Hardware[] p_hardwares)
          Sets the hardwares attribute.
 void setSoftwares(Software[] p_softwares)
          Sets the softwares attribute.
 void setText(java.lang.String p_text)
          Sets the text attribute.
 void setTitle(java.lang.String p_title)
          Sets the title attribute.
 void setType(OntologyEntry p_type)
          Sets the type 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.Protocol.impl.ParameterizableImpl
getParameterTypes, getParameterTypesCount, getURI, searchParameterizables, setParameterTypes, setURI
 
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.Protocol.Parameterizable
getParameterTypes, getURI, setParameterTypes, setURI
 
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

text

protected java.lang.String text
The text description of the Protocol.


title

protected java.lang.String title
The title of the Protocol


softwaresCount

protected int softwaresCount
The count of Software objects.


softwares

protected Software[] softwares
DOCUMENT ME


hardwaresCount

protected int hardwaresCount
The count of Hardware objects.


hardwares

protected Hardware[] hardwares
DOCUMENT ME


type

protected OntologyEntry type
DOCUMENT ME


typeId

protected java.lang.Long typeId
The internal ID of the associated type object.

Constructor Detail

ProtocolImpl

public ProtocolImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class ParameterizableImpl

searchProtocols

public Protocol[] searchProtocols(ProtocolSearchCriteria criteria)
                           throws gov.nih.nci.common.search.SearchException
Returns an array of Protocol objects that satisfy the given ProtocolSearchCriteria.

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

setText

public void setText(java.lang.String p_text)
Sets the text attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Protocol object.

Specified by:
setText in interface Protocol
Parameters:
p_text - The new value for text.
See Also:
Protocol.getText()

getText

public java.lang.String getText()
Description copied from interface: Protocol
Returns the value of this Protocol object's text attribute. Description of text: The text description of the Protocol.

Specified by:
getText in interface Protocol
Returns:
String The value of text.
See Also:
Protocol.getText()

setTitle

public void setTitle(java.lang.String p_title)
Sets the title attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Protocol object.

Specified by:
setTitle in interface Protocol
Parameters:
p_title - The new value for title.
See Also:
Protocol.getTitle()

getTitle

public java.lang.String getTitle()
Description copied from interface: Protocol
Returns the value of this Protocol object's title attribute. Description of title: The title of the Protocol

Specified by:
getTitle in interface Protocol
Returns:
String The value of title.
See Also:
Protocol.getTitle()

setSoftwares

public void setSoftwares(Software[] p_softwares)
Sets the softwares attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Protocol object.

Specified by:
setSoftwares in interface Protocol
Parameters:
p_softwares - The new value for softwares.
See Also:
Protocol.getSoftwares()

getSoftwares

public Software[] getSoftwares()
Description copied from interface: Protocol
Returns the value of this Protocol object's softwares attribute.

Specified by:
getSoftwares in interface Protocol
Returns:
gov.nih.nci.mageom.bean.Protocol.Software[] The value of softwares.
See Also:
Protocol.getSoftwares()

setHardwares

public void setHardwares(Hardware[] p_hardwares)
Sets the hardwares attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Protocol object.

Specified by:
setHardwares in interface Protocol
Parameters:
p_hardwares - The new value for hardwares.
See Also:
Protocol.getHardwares()

getHardwares

public Hardware[] getHardwares()
Description copied from interface: Protocol
Returns the value of this Protocol object's hardwares attribute.

Specified by:
getHardwares in interface Protocol
Returns:
gov.nih.nci.mageom.bean.Protocol.Hardware[] The value of hardwares.
See Also:
Protocol.getHardwares()

setType

public void setType(OntologyEntry p_type)
Sets the type attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Protocol object.

Specified by:
setType in interface Protocol
Parameters:
p_type - The new value for type.
See Also:
Protocol.getType()

getType

public OntologyEntry getType()
Description copied from interface: Protocol
Returns the value of this Protocol object's type attribute.

Specified by:
getType in interface Protocol
Returns:
gov.nih.nci.mageom.bean.Description.OntologyEntry The value of type.
See Also:
Protocol.getType()

getSoftwaresCount

public int getSoftwaresCount()
Returns the count of all Software associated with this Protocol object.

Returns:
the count
See Also:
Protocol.getSoftwares()

getHardwaresCount

public int getHardwaresCount()
Returns the count of all Hardware associated with this Protocol object.

Returns:
the count
See Also:
Protocol.getHardwares()

toXML

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

toXMLDoc

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

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