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

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.SoftwareImpl
All Implemented Interfaces:
Describable, Extendable, Identifiable, Parameterizable, Software, java.io.Serializable

public class SoftwareImpl
extends ParameterizableImpl
implements Software

Software represents the software used. Examples of Software include: feature extraction software, clustering software, etc...

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

Field Summary
protected static java.util.ArrayList allAssociationMethods
           
protected static java.util.Hashtable associationMethods
           
protected  Hardware hardware
          DOCUMENT ME
protected  java.lang.Long hardwareId
          The internal ID of the associated hardware object.
protected  Contact[] softwareManufacturers
          DOCUMENT ME
protected  int softwareManufacturersCount
          The count of Contact objects.
protected  Software[] softwares
          DOCUMENT ME
protected  int softwaresCount
          The count of Software objects.
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
SoftwareImpl()
          Default constructor
 
Method Summary
 Hardware getHardware()
          Returns the value of this Software object's hardware attribute.
 Contact[] getSoftwareManufacturers()
          Returns the value of this Software object's softwareManufacturers attribute.
 int getSoftwareManufacturersCount()
          Returns the count of all Contact associated with this Software object.
 Software[] getSoftwares()
          Returns the value of this Software object's softwares attribute.
 int getSoftwaresCount()
          Returns the count of all Software associated with this Software object.
 OntologyEntry getType()
          Returns the value of this Software object's type attribute.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 Software[] searchSoftwares(SoftwareSearchCriteria criteria)
          Returns an array of Software objects that satisfy the given SoftwareSearchCriteria.
 void setHardware(Hardware p_hardware)
          Sets the hardware attribute.
 void setSoftwareManufacturers(Contact[] p_softwareManufacturers)
          Sets the softwareManufacturers attribute.
 void setSoftwares(Software[] p_softwares)
          Sets the softwares 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

softwareManufacturersCount

protected int softwareManufacturersCount
The count of Contact objects.


softwareManufacturers

protected Contact[] softwareManufacturers
DOCUMENT ME


hardware

protected Hardware hardware
DOCUMENT ME


hardwareId

protected java.lang.Long hardwareId
The internal ID of the associated hardware object.


softwaresCount

protected int softwaresCount
The count of Software objects.


softwares

protected Software[] softwares
DOCUMENT ME


type

protected OntologyEntry type
DOCUMENT ME


typeId

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

Constructor Detail

SoftwareImpl

public SoftwareImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class ParameterizableImpl

searchSoftwares

public Software[] searchSoftwares(SoftwareSearchCriteria criteria)
                           throws gov.nih.nci.common.search.SearchException
Returns an array of Software objects that satisfy the given SoftwareSearchCriteria.

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

setSoftwareManufacturers

public void setSoftwareManufacturers(Contact[] p_softwareManufacturers)
Sets the softwareManufacturers attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Software object.

Specified by:
setSoftwareManufacturers in interface Software
Parameters:
p_softwareManufacturers - The new value for softwareManufacturers.
See Also:
Software.getSoftwareManufacturers()

getSoftwareManufacturers

public Contact[] getSoftwareManufacturers()
Description copied from interface: Software
Returns the value of this Software object's softwareManufacturers attribute.

Specified by:
getSoftwareManufacturers in interface Software
Returns:
gov.nih.nci.mageom.bean.AuditAndSecurity.Contact[] The value of softwareManufacturers.
See Also:
Software.getSoftwareManufacturers()

setHardware

public void setHardware(Hardware p_hardware)
Sets the hardware attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Software object.

Specified by:
setHardware in interface Software
Parameters:
p_hardware - The new value for hardware.
See Also:
Software.getHardware()

getHardware

public Hardware getHardware()
Description copied from interface: Software
Returns the value of this Software object's hardware attribute.

Specified by:
getHardware in interface Software
Returns:
gov.nih.nci.mageom.bean.Protocol.Hardware The value of hardware.
See Also:
Software.getHardware()

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 Software object.

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

getSoftwares

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

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

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 Software object.

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

getType

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

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

getSoftwareManufacturersCount

public int getSoftwareManufacturersCount()
Returns the count of all Contact associated with this Software object.

Returns:
the count
See Also:
Software.getSoftwareManufacturers()

getSoftwaresCount

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

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

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.