gov.nih.nci.mageom.domain.ArrayDesign.impl
Class ReporterGroupImpl

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.ArrayDesign.impl.DesignElementGroupImpl
                      extended by gov.nih.nci.mageom.domain.ArrayDesign.impl.ReporterGroupImpl
All Implemented Interfaces:
DesignElementGroup, ReporterGroup, Describable, Extendable, Identifiable, java.io.Serializable

public class ReporterGroupImpl
extends DesignElementGroupImpl
implements ReporterGroup

Allows specification of the type of Reporter Design Element.

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

Field Summary
protected static java.util.ArrayList allAssociationMethods
           
protected static java.util.Hashtable associationMethods
           
protected  Reporter[] reporters
          DOCUMENT ME
protected  int reportersCount
          The count of Reporter objects.
 
Fields inherited from class gov.nih.nci.mageom.domain.ArrayDesign.impl.DesignElementGroupImpl
species, speciesId, types, typesCount
 
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
ReporterGroupImpl()
          Default constructor
 
Method Summary
 Reporter[] getReporters()
          Returns the value of this ReporterGroup object's reporters attribute.
 int getReportersCount()
          Returns the count of all Reporter associated with this ReporterGroup object.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 ReporterGroup[] searchReporterGroups(ReporterGroupSearchCriteria criteria)
          Returns an array of ReporterGroup objects that satisfy the given ReporterGroupSearchCriteria.
 void setReporters(Reporter[] p_reporters)
          Sets the reporters 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.ArrayDesign.impl.DesignElementGroupImpl
getSpecies, getTypes, getTypesCount, searchDesignElementGroups, setSpecies, setTypes
 
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.ArrayDesign.DesignElementGroup
getSpecies, getTypes, setSpecies, setTypes
 
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

reportersCount

protected int reportersCount
The count of Reporter objects.


reporters

protected Reporter[] reporters
DOCUMENT ME

Constructor Detail

ReporterGroupImpl

public ReporterGroupImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class DesignElementGroupImpl

searchReporterGroups

public ReporterGroup[] searchReporterGroups(ReporterGroupSearchCriteria criteria)
                                     throws gov.nih.nci.common.search.SearchException
Returns an array of ReporterGroup objects that satisfy the given ReporterGroupSearchCriteria.

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

setReporters

public void setReporters(Reporter[] p_reporters)
Sets the reporters attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a ReporterGroup object.

Specified by:
setReporters in interface ReporterGroup
Parameters:
p_reporters - The new value for reporters.
See Also:
ReporterGroup.getReporters()

getReporters

public Reporter[] getReporters()
Description copied from interface: ReporterGroup
Returns the value of this ReporterGroup object's reporters attribute.

Specified by:
getReporters in interface ReporterGroup
Returns:
gov.nih.nci.mageom.bean.DesignElement.Reporter[] The value of reporters.
See Also:
ReporterGroup.getReporters()

getReportersCount

public int getReportersCount()
Returns the count of all Reporter associated with this ReporterGroup object.

Returns:
the count
See Also:
ReporterGroup.getReporters()

toXML

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

toXMLDoc

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

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