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

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

public class HardwareImpl
extends ParameterizableImpl
implements Hardware

Hardware represents the hardware used. Examples of Hardware include: computers, scanners, wash stations etc...

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

Field Summary
protected static java.util.ArrayList allAssociationMethods
           
protected static java.util.Hashtable associationMethods
           
protected  Contact[] hardwareManufacturers
          DOCUMENT ME
protected  int hardwareManufacturersCount
          The count of Contact objects.
protected  java.lang.String make
          The make of the Hardware (its manufacturer).
protected  java.lang.String model
          The model (number) of a piece of hardware.
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
HardwareImpl()
          Default constructor
 
Method Summary
 Contact[] getHardwareManufacturers()
          Returns the value of this Hardware object's hardwareManufacturers attribute.
 int getHardwareManufacturersCount()
          Returns the count of all Contact associated with this Hardware object.
 java.lang.String getMake()
          Returns the value of this Hardware object's make attribute.
 java.lang.String getModel()
          Returns the value of this Hardware object's model attribute.
 Software[] getSoftwares()
          Returns the value of this Hardware object's softwares attribute.
 int getSoftwaresCount()
          Returns the count of all Software associated with this Hardware object.
 OntologyEntry getType()
          Returns the value of this Hardware object's type attribute.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 Hardware[] searchHardwares(HardwareSearchCriteria criteria)
          Returns an array of Hardware objects that satisfy the given HardwareSearchCriteria.
 void setHardwareManufacturers(Contact[] p_hardwareManufacturers)
          Sets the hardwareManufacturers attribute.
 void setMake(java.lang.String p_make)
          Sets the make attribute.
 void setModel(java.lang.String p_model)
          Sets the model 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

model

protected java.lang.String model
The model (number) of a piece of hardware.


make

protected java.lang.String make
The make of the Hardware (its manufacturer).


hardwareManufacturersCount

protected int hardwareManufacturersCount
The count of Contact objects.


hardwareManufacturers

protected Contact[] hardwareManufacturers
DOCUMENT ME


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

HardwareImpl

public HardwareImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class ParameterizableImpl

searchHardwares

public Hardware[] searchHardwares(HardwareSearchCriteria criteria)
                           throws gov.nih.nci.common.search.SearchException
Returns an array of Hardware objects that satisfy the given HardwareSearchCriteria.

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

setModel

public void setModel(java.lang.String p_model)
Sets the model attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Hardware object.

Specified by:
setModel in interface Hardware
Parameters:
p_model - The new value for model.
See Also:
Hardware.getModel()

getModel

public java.lang.String getModel()
Description copied from interface: Hardware
Returns the value of this Hardware object's model attribute. Description of model: The model (number) of a piece of hardware.

Specified by:
getModel in interface Hardware
Returns:
String The value of model.
See Also:
Hardware.getModel()

setMake

public void setMake(java.lang.String p_make)
Sets the make attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Hardware object.

Specified by:
setMake in interface Hardware
Parameters:
p_make - The new value for make.
See Also:
Hardware.getMake()

getMake

public java.lang.String getMake()
Description copied from interface: Hardware
Returns the value of this Hardware object's make attribute. Description of make: The make of the Hardware (its manufacturer).

Specified by:
getMake in interface Hardware
Returns:
String The value of make.
See Also:
Hardware.getMake()

setHardwareManufacturers

public void setHardwareManufacturers(Contact[] p_hardwareManufacturers)
Sets the hardwareManufacturers attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Hardware object.

Specified by:
setHardwareManufacturers in interface Hardware
Parameters:
p_hardwareManufacturers - The new value for hardwareManufacturers.
See Also:
Hardware.getHardwareManufacturers()

getHardwareManufacturers

public Contact[] getHardwareManufacturers()
Description copied from interface: Hardware
Returns the value of this Hardware object's hardwareManufacturers attribute.

Specified by:
getHardwareManufacturers in interface Hardware
Returns:
gov.nih.nci.mageom.bean.AuditAndSecurity.Contact[] The value of hardwareManufacturers.
See Also:
Hardware.getHardwareManufacturers()

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

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

getSoftwares

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

Specified by:
getSoftwares in interface Hardware
Returns:
gov.nih.nci.mageom.bean.Protocol.Software[] The value of softwares.
See Also:
Hardware.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 Hardware object.

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

getType

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

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

getHardwareManufacturersCount

public int getHardwareManufacturersCount()
Returns the count of all Contact associated with this Hardware object.

Returns:
the count
See Also:
Hardware.getHardwareManufacturers()

getSoftwaresCount

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

Returns:
the count
See Also:
Hardware.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.