cytoscape
Class CyNode

java.lang.Object
  cytoscape.CyNode

All Implemented Interfaces:

GraphObject, Node

public class CyNode
extends Object
implements Node

Field Summary

static String	HAS_NESTED_NETWORK_ATTR
static String	NESTED_NETWORK_ID_ATTR
static String	NESTED_NETWORK_IS_VISIBLE_ATTR
static String	PARENT_NODES_ATTR

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!
GraphPerspective	getNestedNetwork() Return the currently set graph perspective (may be null) associated with this node.
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!
void	setNestedNetwork(GraphPerspective graphPerspective) Assign a graph perspective reference to this node.
String	toString() Return the "name" of a node

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NESTED_NETWORK_ID_ATTR

public static final String NESTED_NETWORK_ID_ATTR

See Also:

Constant Field Values

NESTED_NETWORK_IS_VISIBLE_ATTR

public static final String NESTED_NETWORK_IS_VISIBLE_ATTR

See Also:

Constant Field Values

HAS_NESTED_NETWORK_ATTR

public static final String HAS_NESTED_NETWORK_ATTR

See Also:

Constant Field Values

PARENT_NODES_ATTR

public static final String PARENT_NODES_ATTR

See Also:

Constant Field Values

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

setNestedNetwork

public void setNestedNetwork(GraphPerspective graphPerspective)

Assign a graph perspective reference to this node.

Specified by:

setNestedNetwork in interface Node

getNestedNetwork

public GraphPerspective getNestedNetwork()

Return the currently set graph perspective (may be null) associated with this node.

Specified by:

getNestedNetwork in interface Node

Returns:

a network reference or null.