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

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

public class BioSourceImpl
extends BioMaterialImpl
implements BioSource

The BioSource is the original source material before any treatment events. It is also a top node of the directed acyclic graph generated by treatments. The association to OntologyEntry allows enumeration of a BioSource's inherent properties.

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

Field Summary
protected static java.util.ArrayList allAssociationMethods
           
protected static java.util.Hashtable associationMethods
           
protected  Contact[] sourceContact
          DOCUMENT ME
protected  int sourceContactCount
          The count of Contact 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
BioSourceImpl()
          Default constructor
 
Method Summary
 Contact[] getSourceContact()
          Returns the value of this BioSource object's sourceContact attribute.
 int getSourceContactCount()
          Returns the count of all Contact associated with this BioSource object.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 BioSource[] searchBioSources(BioSourceSearchCriteria criteria)
          Returns an array of BioSource objects that satisfy the given BioSourceSearchCriteria.
 void setSourceContact(Contact[] p_sourceContact)
          Sets the sourceContact 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

sourceContactCount

protected int sourceContactCount
The count of Contact objects.


sourceContact

protected Contact[] sourceContact
DOCUMENT ME

Constructor Detail

BioSourceImpl

public BioSourceImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class BioMaterialImpl

searchBioSources

public BioSource[] searchBioSources(BioSourceSearchCriteria criteria)
                             throws gov.nih.nci.common.search.SearchException
Returns an array of BioSource objects that satisfy the given BioSourceSearchCriteria.

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

setSourceContact

public void setSourceContact(Contact[] p_sourceContact)
Sets the sourceContact attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a BioSource object.

Specified by:
setSourceContact in interface BioSource
Parameters:
p_sourceContact - The new value for sourceContact.
See Also:
BioSource.getSourceContact()

getSourceContact

public Contact[] getSourceContact()
Description copied from interface: BioSource
Returns the value of this BioSource object's sourceContact attribute.

Specified by:
getSourceContact in interface BioSource
Returns:
gov.nih.nci.mageom.bean.AuditAndSecurity.Contact[] The value of sourceContact.
See Also:
BioSource.getSourceContact()

getSourceContactCount

public int getSourceContactCount()
Returns the count of all Contact associated with this BioSource object.

Returns:
the count
See Also:
BioSource.getSourceContact()

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.