Cytoscape 2.6.2 (c) 2006,2007 ISB, MSKCC, UCSD

cytoscape
Class CyNode

java.lang.Object
  extended by cytoscape.CyNode
All Implemented Interfaces:
GraphObject, Node

public class CyNode
extends Object
implements Node


Constructor Summary
CyNode(RootGraph root, int rootGraphIndex)
          Creates a new CyNode object.
 
Method Summary
 void addToGroup(CyGroup group)
          Add this node to the specified group.
 GraphPerspective getGraphPerspective()
          DOCUMENT ME!
 List<CyGroup> getGroups()
          Return the list of groups this node is a member of
 String getIdentifier()
          DOCUMENT ME!
 RootGraph getRootGraph()
          DOCUMENT ME!
 int getRootGraphIndex()
          DOCUMENT ME!
 boolean inGroup(CyGroup group)
          Check to see if this node is a member of the requested group
 boolean isaGroup()
          Check to see if this node is a group
 void removeFromGroup(CyGroup group)
          Remove this node from the specified group.
 boolean setGraphPerspective(GraphPerspective gp)
          DOCUMENT ME!
 boolean setIdentifier(String new_id)
          DOCUMENT ME!
 String toString()
          Return the "name" of a node
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CyNode

public CyNode(RootGraph root,
              int rootGraphIndex)
Creates a new CyNode object.

Parameters:
root - DOCUMENT ME!
rootGraphIndex - DOCUMENT ME!
Method Detail

getGraphPerspective

public GraphPerspective getGraphPerspective()
DOCUMENT ME!

Specified by:
getGraphPerspective in interface Node
Returns:
DOCUMENT ME!
See Also:
RootGraph.getNodeMetaChildIndicesArray(int), RootGraph.getEdgeMetaChildIndicesArray(int)

setGraphPerspective

public boolean setGraphPerspective(GraphPerspective gp)
DOCUMENT ME!

Specified by:
setGraphPerspective in interface Node
Parameters:
gp - DOCUMENT ME!
Returns:
DOCUMENT ME!
See Also:
RootGraph.addNodeMetaChild(int, int), RootGraph.addEdgeMetaChild(int, int)

getRootGraph

public RootGraph getRootGraph()
DOCUMENT ME!

Specified by:
getRootGraph in interface GraphObject
Returns:
DOCUMENT ME!

getRootGraphIndex

public int getRootGraphIndex()
DOCUMENT ME!

Specified by:
getRootGraphIndex in interface GraphObject
Returns:
DOCUMENT ME!

getIdentifier

public String getIdentifier()
DOCUMENT ME!

Specified by:
getIdentifier in interface GraphObject
Returns:
DOCUMENT ME!

setIdentifier

public boolean setIdentifier(String new_id)
DOCUMENT ME!

Specified by:
setIdentifier in interface GraphObject
Parameters:
new_id - DOCUMENT ME!
Returns:
DOCUMENT ME!

addToGroup

public void addToGroup(CyGroup group)
Add this node to the specified group.

Parameters:
group - CyGroup to add this group to

removeFromGroup

public void removeFromGroup(CyGroup group)
Remove this node from the specified group.

Parameters:
group - CyGroup to remove this group from

getGroups

public List<CyGroup> getGroups()
Return the list of groups this node is a member of

Returns:
list of CyGroups this group is a member of

inGroup

public boolean inGroup(CyGroup group)
Check to see if this node is a member of the requested group

Parameters:
group - the group to check
Returns:
'true' if this node is in group

isaGroup

public boolean isaGroup()
Check to see if this node is a group

Returns:
'true' if this node is a group

toString

public String toString()
Return the "name" of a node

Overrides:
toString in class Object
Returns:
string representation of the node

www.cytoscape.org