gov.nih.nci.mageom.domain.BioMaterial.impl
Class LabeledExtractImpl

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

public class LabeledExtractImpl
extends BioMaterialImpl
implements LabeledExtract

LabeledExtracts are special BioSamples that have Compounds which are detectable (these are often fluorescent or reactive moieties).

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.BioMaterial.impl.BioMaterialImpl
characteristics, characteristicsCount, materialType, materialTypeId, qualityControlStatistics, qualityControlStatisticsCount, treatments, treatmentsCount
 
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
LabeledExtractImpl()
          Default constructor
 
Method Summary
 Compound[] getLabels()
          Returns the value of this LabeledExtract object's labels attribute.
 int getLabelsCount()
          Returns the count of all Compound associated with this LabeledExtract object.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 LabeledExtract[] searchLabeledExtracts(LabeledExtractSearchCriteria criteria)
          Returns an array of LabeledExtract objects that satisfy the given LabeledExtractSearchCriteria.
 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.BioMaterial.impl.BioMaterialImpl
getCharacteristics, getCharacteristicsCount, getMaterialType, getQualityControlStatistics, getQualityControlStatisticsCount, getTreatments, getTreatmentsCount, searchBioMaterials, setCharacteristics, setMaterialType, setQualityControlStatistics, setTreatments
 
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.BioMaterial.BioMaterial
getCharacteristics, getMaterialType, getQualityControlStatistics, getTreatments, setCharacteristics, setMaterialType, setQualityControlStatistics, setTreatments
 
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

LabeledExtractImpl

public LabeledExtractImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class BioMaterialImpl

searchLabeledExtracts

public LabeledExtract[] searchLabeledExtracts(LabeledExtractSearchCriteria criteria)
                                       throws gov.nih.nci.common.search.SearchException
Returns an array of LabeledExtract objects that satisfy the given LabeledExtractSearchCriteria.

Parameters:
criteria - The LabeledExtractSearchCriteria which represents a query for LabeledExtract objects.
Returns:
An array of LabeledExtract 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 LabeledExtract object.

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

getLabels

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

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

getLabelsCount

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

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

toXML

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

toXMLDoc

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

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