gov.nih.nci.mageom.domain.HigherLevelAnalysis.impl
Class BioAssayDataClusterImpl

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.HigherLevelAnalysis.impl.BioAssayDataClusterImpl
All Implemented Interfaces:
Describable, Extendable, BioAssayDataCluster, Identifiable, java.io.Serializable

public class BioAssayDataClusterImpl
extends IdentifiableImpl
implements BioAssayDataCluster

A mathematical method of higher level analysis whereby BioAssayData are grouped together into nodes.

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

Field Summary
protected static java.util.ArrayList allAssociationMethods
           
protected static java.util.Hashtable associationMethods
           
protected  BioAssayData clusterBioAssayData
          DOCUMENT ME
protected  java.lang.Long clusterBioAssayDataId
          The internal ID of the associated clusterBioAssayData object.
protected  Node[] nodes
          DOCUMENT ME
protected  int nodesCount
          The count of Node 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
BioAssayDataClusterImpl()
          Default constructor
 
Method Summary
 BioAssayData getClusterBioAssayData()
          Returns the value of this BioAssayDataCluster object's clusterBioAssayData attribute.
 Node[] getNodes()
          Returns the value of this BioAssayDataCluster object's nodes attribute.
 int getNodesCount()
          Returns the count of all Node associated with this BioAssayDataCluster object.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 BioAssayDataCluster[] searchBioAssayDataClusters(BioAssayDataClusterSearchCriteria criteria)
          Returns an array of BioAssayDataCluster objects that satisfy the given BioAssayDataClusterSearchCriteria.
 void setClusterBioAssayData(BioAssayData p_clusterBioAssayData)
          Sets the clusterBioAssayData attribute.
 void setNodes(Node[] p_nodes)
          Sets the nodes 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

nodesCount

protected int nodesCount
The count of Node objects.


nodes

protected Node[] nodes
DOCUMENT ME


clusterBioAssayData

protected BioAssayData clusterBioAssayData
DOCUMENT ME


clusterBioAssayDataId

protected java.lang.Long clusterBioAssayDataId
The internal ID of the associated clusterBioAssayData object.

Constructor Detail

BioAssayDataClusterImpl

public BioAssayDataClusterImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class IdentifiableImpl

searchBioAssayDataClusters

public BioAssayDataCluster[] searchBioAssayDataClusters(BioAssayDataClusterSearchCriteria criteria)
                                                 throws gov.nih.nci.common.search.SearchException
Returns an array of BioAssayDataCluster objects that satisfy the given BioAssayDataClusterSearchCriteria.

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

setNodes

public void setNodes(Node[] p_nodes)
Sets the nodes attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a BioAssayDataCluster object.

Specified by:
setNodes in interface BioAssayDataCluster
Parameters:
p_nodes - The new value for nodes.
See Also:
BioAssayDataCluster.getNodes()

getNodes

public Node[] getNodes()
Description copied from interface: BioAssayDataCluster
Returns the value of this BioAssayDataCluster object's nodes attribute.

Specified by:
getNodes in interface BioAssayDataCluster
Returns:
gov.nih.nci.mageom.bean.HigherLevelAnalysis.Node[] The value of nodes.
See Also:
BioAssayDataCluster.getNodes()

setClusterBioAssayData

public void setClusterBioAssayData(BioAssayData p_clusterBioAssayData)
Sets the clusterBioAssayData attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a BioAssayDataCluster object.

Specified by:
setClusterBioAssayData in interface BioAssayDataCluster
Parameters:
p_clusterBioAssayData - The new value for clusterBioAssayData.
See Also:
BioAssayDataCluster.getClusterBioAssayData()

getClusterBioAssayData

public BioAssayData getClusterBioAssayData()
Description copied from interface: BioAssayDataCluster
Returns the value of this BioAssayDataCluster object's clusterBioAssayData attribute.

Specified by:
getClusterBioAssayData in interface BioAssayDataCluster
Returns:
gov.nih.nci.mageom.bean.BioAssayData.BioAssayData The value of clusterBioAssayData.
See Also:
BioAssayDataCluster.getClusterBioAssayData()

getNodesCount

public int getNodesCount()
Returns the count of all Node associated with this BioAssayDataCluster object.

Returns:
the count
See Also:
BioAssayDataCluster.getNodes()

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.