gov.nih.nci.mageom.domain.Experiment.impl
Class ExperimentImpl

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

public class ExperimentImpl
extends IdentifiableImpl
implements Experiment

The Experiment is the collection of all the BioAssays that are related by the ExperimentDesign.

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

Field Summary
protected static java.util.ArrayList allAssociationMethods
           
protected  BioAssayDataCluster[] analysisResults
          DOCUMENT ME
protected  int analysisResultsCount
          The count of BioAssayDataCluster objects.
protected static java.util.Hashtable associationMethods
           
protected  BioAssayData[] bioAssayData
          DOCUMENT ME
protected  int bioAssayDataCount
          The count of BioAssayData objects.
protected  BioAssay[] bioAssays
          DOCUMENT ME
protected  int bioAssaysCount
          The count of BioAssay objects.
protected  ExperimentDesign[] experimentDesigns
          DOCUMENT ME
protected  int experimentDesignsCount
          The count of ExperimentDesign objects.
protected  Contact[] providers
          DOCUMENT ME
protected  int providersCount
          The count of Contact 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
ExperimentImpl()
          Default constructor
 
Method Summary
 BioAssayDataCluster[] getAnalysisResults()
          Returns the value of this Experiment object's analysisResults attribute.
 int getAnalysisResultsCount()
          Returns the count of all BioAssayDataCluster associated with this Experiment object.
 BioAssayData[] getBioAssayData()
          Returns the value of this Experiment object's bioAssayData attribute.
 int getBioAssayDataCount()
          Returns the count of all BioAssayData associated with this Experiment object.
 BioAssay[] getBioAssays()
          Returns the value of this Experiment object's bioAssays attribute.
 int getBioAssaysCount()
          Returns the count of all BioAssay associated with this Experiment object.
 ExperimentDesign[] getExperimentDesigns()
          Returns the value of this Experiment object's experimentDesigns attribute.
 int getExperimentDesignsCount()
          Returns the count of all ExperimentDesign associated with this Experiment object.
 Contact[] getProviders()
          Returns the value of this Experiment object's providers attribute.
 int getProvidersCount()
          Returns the count of all Contact associated with this Experiment object.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 Experiment[] searchExperiments(ExperimentSearchCriteria criteria)
          Returns an array of Experiment objects that satisfy the given ExperimentSearchCriteria.
 void setAnalysisResults(BioAssayDataCluster[] p_analysisResults)
          Sets the analysisResults attribute.
 void setBioAssayData(BioAssayData[] p_bioAssayData)
          Sets the bioAssayData attribute.
 void setBioAssays(BioAssay[] p_bioAssays)
          Sets the bioAssays attribute.
 void setExperimentDesigns(ExperimentDesign[] p_experimentDesigns)
          Sets the experimentDesigns attribute.
 void setProviders(Contact[] p_providers)
          Sets the providers 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

experimentDesignsCount

protected int experimentDesignsCount
The count of ExperimentDesign objects.


experimentDesigns

protected ExperimentDesign[] experimentDesigns
DOCUMENT ME


providersCount

protected int providersCount
The count of Contact objects.


providers

protected Contact[] providers
DOCUMENT ME


analysisResultsCount

protected int analysisResultsCount
The count of BioAssayDataCluster objects.


analysisResults

protected BioAssayDataCluster[] analysisResults
DOCUMENT ME


bioAssayDataCount

protected int bioAssayDataCount
The count of BioAssayData objects.


bioAssayData

protected BioAssayData[] bioAssayData
DOCUMENT ME


bioAssaysCount

protected int bioAssaysCount
The count of BioAssay objects.


bioAssays

protected BioAssay[] bioAssays
DOCUMENT ME

Constructor Detail

ExperimentImpl

public ExperimentImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class IdentifiableImpl

searchExperiments

public Experiment[] searchExperiments(ExperimentSearchCriteria criteria)
                               throws gov.nih.nci.common.search.SearchException
Returns an array of Experiment objects that satisfy the given ExperimentSearchCriteria.

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

setExperimentDesigns

public void setExperimentDesigns(ExperimentDesign[] p_experimentDesigns)
Sets the experimentDesigns attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Experiment object.

Specified by:
setExperimentDesigns in interface Experiment
Parameters:
p_experimentDesigns - The new value for experimentDesigns.
See Also:
Experiment.getExperimentDesigns()

getExperimentDesigns

public ExperimentDesign[] getExperimentDesigns()
Description copied from interface: Experiment
Returns the value of this Experiment object's experimentDesigns attribute.

Specified by:
getExperimentDesigns in interface Experiment
Returns:
gov.nih.nci.mageom.bean.Experiment.ExperimentDesign[] The value of experimentDesigns.
See Also:
Experiment.getExperimentDesigns()

setProviders

public void setProviders(Contact[] p_providers)
Sets the providers attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Experiment object.

Specified by:
setProviders in interface Experiment
Parameters:
p_providers - The new value for providers.
See Also:
Experiment.getProviders()

getProviders

public Contact[] getProviders()
Description copied from interface: Experiment
Returns the value of this Experiment object's providers attribute.

Specified by:
getProviders in interface Experiment
Returns:
gov.nih.nci.mageom.bean.AuditAndSecurity.Contact[] The value of providers.
See Also:
Experiment.getProviders()

setAnalysisResults

public void setAnalysisResults(BioAssayDataCluster[] p_analysisResults)
Sets the analysisResults attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Experiment object.

Specified by:
setAnalysisResults in interface Experiment
Parameters:
p_analysisResults - The new value for analysisResults.
See Also:
Experiment.getAnalysisResults()

getAnalysisResults

public BioAssayDataCluster[] getAnalysisResults()
Description copied from interface: Experiment
Returns the value of this Experiment object's analysisResults attribute.

Specified by:
getAnalysisResults in interface Experiment
Returns:
gov.nih.nci.mageom.bean.HigherLevelAnalysis.BioAssayDataCluster[] The value of analysisResults.
See Also:
Experiment.getAnalysisResults()

setBioAssayData

public void setBioAssayData(BioAssayData[] p_bioAssayData)
Sets the bioAssayData attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Experiment object.

Specified by:
setBioAssayData in interface Experiment
Parameters:
p_bioAssayData - The new value for bioAssayData.
See Also:
Experiment.getBioAssayData()

getBioAssayData

public BioAssayData[] getBioAssayData()
Description copied from interface: Experiment
Returns the value of this Experiment object's bioAssayData attribute.

Specified by:
getBioAssayData in interface Experiment
Returns:
gov.nih.nci.mageom.bean.BioAssayData.BioAssayData[] The value of bioAssayData.
See Also:
Experiment.getBioAssayData()

setBioAssays

public void setBioAssays(BioAssay[] p_bioAssays)
Sets the bioAssays attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Experiment object.

Specified by:
setBioAssays in interface Experiment
Parameters:
p_bioAssays - The new value for bioAssays.
See Also:
Experiment.getBioAssays()

getBioAssays

public BioAssay[] getBioAssays()
Description copied from interface: Experiment
Returns the value of this Experiment object's bioAssays attribute.

Specified by:
getBioAssays in interface Experiment
Returns:
gov.nih.nci.mageom.bean.BioAssay.BioAssay[] The value of bioAssays.
See Also:
Experiment.getBioAssays()

getExperimentDesignsCount

public int getExperimentDesignsCount()
Returns the count of all ExperimentDesign associated with this Experiment object.

Returns:
the count
See Also:
Experiment.getExperimentDesigns()

getProvidersCount

public int getProvidersCount()
Returns the count of all Contact associated with this Experiment object.

Returns:
the count
See Also:
Experiment.getProviders()

getAnalysisResultsCount

public int getAnalysisResultsCount()
Returns the count of all BioAssayDataCluster associated with this Experiment object.

Returns:
the count
See Also:
Experiment.getAnalysisResults()

getBioAssayDataCount

public int getBioAssayDataCount()
Returns the count of all BioAssayData associated with this Experiment object.

Returns:
the count
See Also:
Experiment.getBioAssayData()

getBioAssaysCount

public int getBioAssaysCount()
Returns the count of all BioAssay associated with this Experiment object.

Returns:
the count
See Also:
Experiment.getBioAssays()

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.