gov.nih.nci.mageom.domain.BioEvent.impl
Class BioEventImpl

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.BioEvent.impl.BioEventImpl
All Implemented Interfaces:
BioEvent, Describable, Extendable, Identifiable, java.io.Serializable
Direct Known Subclasses:
BioAssayCreationImpl, BioAssayTreatmentImpl, FeatureExtractionImpl, MapImpl, TransformationImpl, TreatmentImpl

public class BioEventImpl
extends IdentifiableImpl
implements BioEvent

An abstract class to capture the concept of an event (either in the laboratory or a computational analysis).

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

Field Summary
protected static java.util.ArrayList allAssociationMethods
           
protected static java.util.Hashtable associationMethods
           
protected  ProtocolApplication[] protocolApplications
          DOCUMENT ME
protected  int protocolApplicationsCount
          The count of ProtocolApplication 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
BioEventImpl()
          Default constructor
 
Method Summary
 ProtocolApplication[] getProtocolApplications()
          Returns the value of this BioEvent object's protocolApplications attribute.
 int getProtocolApplicationsCount()
          Returns the count of all ProtocolApplication associated with this BioEvent object.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 BioEvent[] searchBioEvents(BioEventSearchCriteria criteria)
          Returns an array of BioEvent objects that satisfy the given BioEventSearchCriteria.
 void setProtocolApplications(ProtocolApplication[] p_protocolApplications)
          Sets the protocolApplications 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

protocolApplicationsCount

protected int protocolApplicationsCount
The count of ProtocolApplication objects.


protocolApplications

protected ProtocolApplication[] protocolApplications
DOCUMENT ME

Constructor Detail

BioEventImpl

public BioEventImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class IdentifiableImpl

searchBioEvents

public BioEvent[] searchBioEvents(BioEventSearchCriteria criteria)
                           throws gov.nih.nci.common.search.SearchException
Returns an array of BioEvent objects that satisfy the given BioEventSearchCriteria.

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

setProtocolApplications

public void setProtocolApplications(ProtocolApplication[] p_protocolApplications)
Sets the protocolApplications attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a BioEvent object.

Specified by:
setProtocolApplications in interface BioEvent
Parameters:
p_protocolApplications - The new value for protocolApplications.
See Also:
BioEvent.getProtocolApplications()

getProtocolApplications

public ProtocolApplication[] getProtocolApplications()
Description copied from interface: BioEvent
Returns the value of this BioEvent object's protocolApplications attribute.

Specified by:
getProtocolApplications in interface BioEvent
Returns:
gov.nih.nci.mageom.bean.Protocol.ProtocolApplication[] The value of protocolApplications.
See Also:
BioEvent.getProtocolApplications()

getProtocolApplicationsCount

public int getProtocolApplicationsCount()
Returns the count of all ProtocolApplication associated with this BioEvent object.

Returns:
the count
See Also:
BioEvent.getProtocolApplications()

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.