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

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

public class NodeImpl
extends DescribableImpl
implements Node

An individual component of a clustering. May contain other nodes.

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

Field Summary
protected static java.util.ArrayList allAssociationMethods
           
protected static java.util.Hashtable associationMethods
           
protected  NodeContents[] nodeContents
          DOCUMENT ME
protected  int nodeContentsCount
          The count of NodeContents objects.
protected  Node[] nodes
          DOCUMENT ME
protected  int nodesCount
          The count of Node objects.
protected  NodeValue[] nodeValue
          DOCUMENT ME
protected  int nodeValueCount
          The count of NodeValue objects.
 
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
NodeImpl()
          Default constructor
 
Method Summary
 NodeContents[] getNodeContents()
          Returns the value of this Node object's nodeContents attribute.
 int getNodeContentsCount()
          Returns the count of all NodeContents associated with this Node object.
 Node[] getNodes()
          Returns the value of this Node object's nodes attribute.
 int getNodesCount()
          Returns the count of all Node associated with this Node object.
 NodeValue[] getNodeValue()
          Returns the value of this Node object's nodeValue attribute.
 int getNodeValueCount()
          Returns the count of all NodeValue associated with this Node object.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 Node[] searchNodes(NodeSearchCriteria criteria)
          Returns an array of Node objects that satisfy the given NodeSearchCriteria.
 void setNodeContents(NodeContents[] p_nodeContents)
          Sets the nodeContents attribute.
 void setNodes(Node[] p_nodes)
          Sets the nodes attribute.
 void setNodeValue(NodeValue[] p_nodeValue)
          Sets the nodeValue 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.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.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


nodeContentsCount

protected int nodeContentsCount
The count of NodeContents objects.


nodeContents

protected NodeContents[] nodeContents
DOCUMENT ME


nodeValueCount

protected int nodeValueCount
The count of NodeValue objects.


nodeValue

protected NodeValue[] nodeValue
DOCUMENT ME

Constructor Detail

NodeImpl

public NodeImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class DescribableImpl

searchNodes

public Node[] searchNodes(NodeSearchCriteria criteria)
                   throws gov.nih.nci.common.search.SearchException
Returns an array of Node objects that satisfy the given NodeSearchCriteria.

Parameters:
criteria - The NodeSearchCriteria which represents a query for Node objects.
Returns:
An array of Node 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 Node object.

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

getNodes

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

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

setNodeContents

public void setNodeContents(NodeContents[] p_nodeContents)
Sets the nodeContents attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Node object.

Specified by:
setNodeContents in interface Node
Parameters:
p_nodeContents - The new value for nodeContents.
See Also:
Node.getNodeContents()

getNodeContents

public NodeContents[] getNodeContents()
Description copied from interface: Node
Returns the value of this Node object's nodeContents attribute.

Specified by:
getNodeContents in interface Node
Returns:
gov.nih.nci.mageom.bean.HigherLevelAnalysis.NodeContents[] The value of nodeContents.
See Also:
Node.getNodeContents()

setNodeValue

public void setNodeValue(NodeValue[] p_nodeValue)
Sets the nodeValue attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Node object.

Specified by:
setNodeValue in interface Node
Parameters:
p_nodeValue - The new value for nodeValue.
See Also:
Node.getNodeValue()

getNodeValue

public NodeValue[] getNodeValue()
Description copied from interface: Node
Returns the value of this Node object's nodeValue attribute.

Specified by:
getNodeValue in interface Node
Returns:
gov.nih.nci.mageom.bean.HigherLevelAnalysis.NodeValue[] The value of nodeValue.
See Also:
Node.getNodeValue()

getNodesCount

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

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

getNodeContentsCount

public int getNodeContentsCount()
Returns the count of all NodeContents associated with this Node object.

Returns:
the count
See Also:
Node.getNodeContents()

getNodeValueCount

public int getNodeValueCount()
Returns the count of all NodeValue associated with this Node object.

Returns:
the count
See Also:
Node.getNodeValue()

toXML

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

toXMLDoc

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

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