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

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
All Implemented Interfaces:
DesignElementGroup, Describable, Extendable, Identifiable, java.io.Serializable
Direct Known Subclasses:
CompositeGroupImpl, FeatureGroupImpl, ReporterGroupImpl

public class DesignElementGroupImpl
extends IdentifiableImpl
implements DesignElementGroup

The DesignElementGroup holds information on either features, reporters, or compositeSequences, particularly that information that is common between all of the DesignElements contained.

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

Field Summary
protected static java.util.ArrayList allAssociationMethods
           
protected static java.util.Hashtable associationMethods
           
protected  OntologyEntry species
          DOCUMENT ME
protected  java.lang.Long speciesId
          The internal ID of the associated species object.
protected  OntologyEntry[] types
          DOCUMENT ME
protected  int typesCount
          The count of OntologyEntry 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
DesignElementGroupImpl()
          Default constructor
 
Method Summary
 OntologyEntry getSpecies()
          Returns the value of this DesignElementGroup object's species attribute.
 OntologyEntry[] getTypes()
          Returns the value of this DesignElementGroup object's types attribute.
 int getTypesCount()
          Returns the count of all OntologyEntry associated with this DesignElementGroup object.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 DesignElementGroup[] searchDesignElementGroups(DesignElementGroupSearchCriteria criteria)
          Returns an array of DesignElementGroup objects that satisfy the given DesignElementGroupSearchCriteria.
 void setSpecies(OntologyEntry p_species)
          Sets the species attribute.
 void setTypes(OntologyEntry[] p_types)
          Sets the types 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

species

protected OntologyEntry species
DOCUMENT ME


speciesId

protected java.lang.Long speciesId
The internal ID of the associated species object.


typesCount

protected int typesCount
The count of OntologyEntry objects.


types

protected OntologyEntry[] types
DOCUMENT ME

Constructor Detail

DesignElementGroupImpl

public DesignElementGroupImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class IdentifiableImpl

searchDesignElementGroups

public DesignElementGroup[] searchDesignElementGroups(DesignElementGroupSearchCriteria criteria)
                                               throws gov.nih.nci.common.search.SearchException
Returns an array of DesignElementGroup objects that satisfy the given DesignElementGroupSearchCriteria.

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

setSpecies

public void setSpecies(OntologyEntry p_species)
Sets the species attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a DesignElementGroup object.

Specified by:
setSpecies in interface DesignElementGroup
Parameters:
p_species - The new value for species.
See Also:
DesignElementGroup.getSpecies()

getSpecies

public OntologyEntry getSpecies()
Description copied from interface: DesignElementGroup
Returns the value of this DesignElementGroup object's species attribute.

Specified by:
getSpecies in interface DesignElementGroup
Returns:
gov.nih.nci.mageom.bean.Description.OntologyEntry The value of species.
See Also:
DesignElementGroup.getSpecies()

setTypes

public void setTypes(OntologyEntry[] p_types)
Sets the types attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a DesignElementGroup object.

Specified by:
setTypes in interface DesignElementGroup
Parameters:
p_types - The new value for types.
See Also:
DesignElementGroup.getTypes()

getTypes

public OntologyEntry[] getTypes()
Description copied from interface: DesignElementGroup
Returns the value of this DesignElementGroup object's types attribute.

Specified by:
getTypes in interface DesignElementGroup
Returns:
gov.nih.nci.mageom.bean.Description.OntologyEntry[] The value of types.
See Also:
DesignElementGroup.getTypes()

getTypesCount

public int getTypesCount()
Returns the count of all OntologyEntry associated with this DesignElementGroup object.

Returns:
the count
See Also:
DesignElementGroup.getTypes()

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.