gov.nih.nci.mageom.domain.BioAssay.impl
Class ChannelImpl

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.BioAssay.impl.ChannelImpl
All Implemented Interfaces:
Channel, Describable, Extendable, Identifiable, java.io.Serializable

public class ChannelImpl
extends IdentifiableImpl
implements Channel

A channel represents an independent acquisition scheme for the ImageAcquisition event, typically a wavelength.

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

Field Summary
protected static java.util.ArrayList allAssociationMethods
           
protected static java.util.Hashtable associationMethods
           
protected  Compound[] labels
          DOCUMENT ME
protected  int labelsCount
          The count of Compound objects.
 
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
ChannelImpl()
          Default constructor
 
Method Summary
 Compound[] getLabels()
          Returns the value of this Channel object's labels attribute.
 int getLabelsCount()
          Returns the count of all Compound associated with this Channel object.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 Channel[] searchChannels(ChannelSearchCriteria criteria)
          Returns an array of Channel objects that satisfy the given ChannelSearchCriteria.
 void setLabels(Compound[] p_labels)
          Sets the labels 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

labelsCount

protected int labelsCount
The count of Compound objects.


labels

protected Compound[] labels
DOCUMENT ME

Constructor Detail

ChannelImpl

public ChannelImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class IdentifiableImpl

searchChannels

public Channel[] searchChannels(ChannelSearchCriteria criteria)
                         throws gov.nih.nci.common.search.SearchException
Returns an array of Channel objects that satisfy the given ChannelSearchCriteria.

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

setLabels

public void setLabels(Compound[] p_labels)
Sets the labels attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Channel object.

Specified by:
setLabels in interface Channel
Parameters:
p_labels - The new value for labels.
See Also:
Channel.getLabels()

getLabels

public Compound[] getLabels()
Description copied from interface: Channel
Returns the value of this Channel object's labels attribute.

Specified by:
getLabels in interface Channel
Returns:
gov.nih.nci.mageom.bean.BioMaterial.Compound[] The value of labels.
See Also:
Channel.getLabels()

getLabelsCount

public int getLabelsCount()
Returns the count of all Compound associated with this Channel object.

Returns:
the count
See Also:
Channel.getLabels()

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.