org.cytoscape.command.util
Class EdgeList

java.lang.Object
  org.cytoscape.command.util.EdgeList

public class EdgeList
extends Object

This class implements a wrapper for a List of CyEdges that can be used by the Tunables mechanism. Currently, it is only implemented by command tunables so it will be ignored in GUI (Swing) contexts. A typical use might look like:

 public EdgeList edgeList = new EdgeList(null);





Cytoscape Backwards Compatibility (Final Class):  This class is final and therefore can't be extended by users. This means that we may add methods for minor version updates. Methods will only be removed for major version updates.
Module: command-executor-api
To use this in your app, include the following dependency in your POM:
<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>command-executor-api</artifactId>
</dependency>







Constructor Summary
EdgeList()



          Empty constructor for an EdgeList.
EdgeList(CyNetwork targetNetwork)



          Constructor for EdgeList when the network is known
 at time of creation.
 



Method Summary




 CyNetwork
getNetwork()



          Return the network used by this EdgeList



 List<CyEdge>
getValue()



          Return the edgeList for this tunable



 void
setNetwork(CyNetwork network)



          Set the network to be used by this EdgeList



 void
setValue(List<CyEdge> edgeList)



          Set the edgeList for this tunable


 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 





Constructor Detail



EdgeList
public EdgeList()

Empty constructor for an EdgeList.  Use this when the
 target network won't be known until the Tunable is used.





EdgeList
public EdgeList(CyNetwork targetNetwork)

Constructor for EdgeList when the network is known
 at time of creation.


Parameters:
targetNetwork - the network for the edges to be returned





Method Detail



setNetwork
public void setNetwork(CyNetwork network)

Set the network to be used by this EdgeList


Parameters:
network - the network to use for finding the edges





getNetwork
public CyNetwork getNetwork()

Return the network used by this EdgeList



Returns:
the network to use for finding the edges





setValue
public void setValue(List<CyEdge> edgeList)

Set the edgeList for this tunable


Parameters:
edgeList - the list of edges





getValue
public List<CyEdge> getValue()

Return the edgeList for this tunable



Returns:
the list of edges