org.cytoscape.model
Interface CyNode
- All Superinterfaces:
- CyIdentifiable
public interface CyNode
- extends CyIdentifiable
An object that represents a node (vertex) within a network
of nodes and edges.
Cytoscape Backwards Compatibility (API Interface): We expect that this interface will be used but not implemented by developers using this interface. As such, we reserve the right to add methods to the interface as part of minor version upgrades. We will not remove methods for any changes other than major version upgrades.
getNetworkPointer
CyNetwork getNetworkPointer()
- Returns the network referenced by this node. If no
network has been specified this method will return null.
- Returns:
- A reference to a CyNetwork if one exists,
returns null otherwise.
setNetworkPointer
void setNetworkPointer(CyNetwork network)
- Allows a network reference for this node to be set. Only one
network may be set for a given node. Any CyNetwork may
be used (the network may be a subnetwork of the network that
contains this node, but it is not mandatory). To unset a network, use
null as an argument.
- Parameters:
network
- The network that is to be referenced by this node. If
this value is null, any existing reference will be removed.
Note that this if a previous referenced network is being replaced or nulled out, an
UnsetNetworkPointerEvent
will be fired and if a new network will be set a
SetNetworkPointerEvent
will be fired.
Copyright 2011 Cytoscape Consortium. All rights reserved.