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

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

public class ExperimentalFactorImpl
extends IdentifiableImpl
implements ExperimentalFactor

ExperimentFactors are the dependent variables of an experiment (e.g. time, glucose concentration, ...).

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

Field Summary
protected static java.util.ArrayList allAssociationMethods
           
protected  OntologyEntry[] annotations
          DOCUMENT ME
protected  int annotationsCount
          The count of OntologyEntry objects.
protected static java.util.Hashtable associationMethods
           
protected  OntologyEntry category
          DOCUMENT ME
protected  java.lang.Long categoryId
          The internal ID of the associated category object.
protected  FactorValue[] factorValues
          DOCUMENT ME
protected  int factorValuesCount
          The count of FactorValue 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
ExperimentalFactorImpl()
          Default constructor
 
Method Summary
 OntologyEntry[] getAnnotations()
          Returns the value of this ExperimentalFactor object's annotations attribute.
 int getAnnotationsCount()
          Returns the count of all OntologyEntry associated with this ExperimentalFactor object.
 OntologyEntry getCategory()
          Returns the value of this ExperimentalFactor object's category attribute.
 FactorValue[] getFactorValues()
          Returns the value of this ExperimentalFactor object's factorValues attribute.
 int getFactorValuesCount()
          Returns the count of all FactorValue associated with this ExperimentalFactor object.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 ExperimentalFactor[] searchExperimentalFactors(ExperimentalFactorSearchCriteria criteria)
          Returns an array of ExperimentalFactor objects that satisfy the given ExperimentalFactorSearchCriteria.
 void setAnnotations(OntologyEntry[] p_annotations)
          Sets the annotations attribute.
 void setCategory(OntologyEntry p_category)
          Sets the category attribute.
 void setFactorValues(FactorValue[] p_factorValues)
          Sets the factorValues 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

factorValuesCount

protected int factorValuesCount
The count of FactorValue objects.


factorValues

protected FactorValue[] factorValues
DOCUMENT ME


category

protected OntologyEntry category
DOCUMENT ME


categoryId

protected java.lang.Long categoryId
The internal ID of the associated category object.


annotationsCount

protected int annotationsCount
The count of OntologyEntry objects.


annotations

protected OntologyEntry[] annotations
DOCUMENT ME

Constructor Detail

ExperimentalFactorImpl

public ExperimentalFactorImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class IdentifiableImpl

searchExperimentalFactors

public ExperimentalFactor[] searchExperimentalFactors(ExperimentalFactorSearchCriteria criteria)
                                               throws gov.nih.nci.common.search.SearchException
Returns an array of ExperimentalFactor objects that satisfy the given ExperimentalFactorSearchCriteria.

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

setFactorValues

public void setFactorValues(FactorValue[] p_factorValues)
Sets the factorValues attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a ExperimentalFactor object.

Specified by:
setFactorValues in interface ExperimentalFactor
Parameters:
p_factorValues - The new value for factorValues.
See Also:
ExperimentalFactor.getFactorValues()

getFactorValues

public FactorValue[] getFactorValues()
Description copied from interface: ExperimentalFactor
Returns the value of this ExperimentalFactor object's factorValues attribute.

Specified by:
getFactorValues in interface ExperimentalFactor
Returns:
gov.nih.nci.mageom.bean.Experiment.FactorValue[] The value of factorValues.
See Also:
ExperimentalFactor.getFactorValues()

setCategory

public void setCategory(OntologyEntry p_category)
Sets the category attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a ExperimentalFactor object.

Specified by:
setCategory in interface ExperimentalFactor
Parameters:
p_category - The new value for category.
See Also:
ExperimentalFactor.getCategory()

getCategory

public OntologyEntry getCategory()
Description copied from interface: ExperimentalFactor
Returns the value of this ExperimentalFactor object's category attribute.

Specified by:
getCategory in interface ExperimentalFactor
Returns:
gov.nih.nci.mageom.bean.Description.OntologyEntry The value of category.
See Also:
ExperimentalFactor.getCategory()

setAnnotations

public void setAnnotations(OntologyEntry[] p_annotations)
Sets the annotations attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a ExperimentalFactor object.

Specified by:
setAnnotations in interface ExperimentalFactor
Parameters:
p_annotations - The new value for annotations.
See Also:
ExperimentalFactor.getAnnotations()

getAnnotations

public OntologyEntry[] getAnnotations()
Description copied from interface: ExperimentalFactor
Returns the value of this ExperimentalFactor object's annotations attribute.

Specified by:
getAnnotations in interface ExperimentalFactor
Returns:
gov.nih.nci.mageom.bean.Description.OntologyEntry[] The value of annotations.
See Also:
ExperimentalFactor.getAnnotations()

getFactorValuesCount

public int getFactorValuesCount()
Returns the count of all FactorValue associated with this ExperimentalFactor object.

Returns:
the count
See Also:
ExperimentalFactor.getFactorValues()

getAnnotationsCount

public int getAnnotationsCount()
Returns the count of all OntologyEntry associated with this ExperimentalFactor object.

Returns:
the count
See Also:
ExperimentalFactor.getAnnotations()

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.