idare.subnetwork.internal

Class NetworkViewSwitcher

java.lang.Object

org.cytoscape.task.AbstractNodeViewTaskFactory

idare.subnetwork.internal.NetworkViewSwitcher

All Implemented Interfaces:

org.cytoscape.event.CyListener, org.cytoscape.model.events.NetworkAboutToBeDestroyedListener, org.cytoscape.model.events.RowsSetListener, org.cytoscape.session.events.SessionAboutToBeSavedListener, org.cytoscape.task.NodeViewTaskFactory

public class NetworkViewSwitcher
extends org.cytoscape.task.AbstractNodeViewTaskFactory
implements org.cytoscape.model.events.NetworkAboutToBeDestroyedListener, org.cytoscape.model.events.RowsSetListener, org.cytoscape.session.events.SessionAboutToBeSavedListener

A Class that acts as switcher between networks.

Author:

Thomas Pfau

Field Summary

Fields

Modifier and Type	Field and Description
static String	PREFERRED_OPTION
static String	Title

Constructor Summary

Constructors

Constructor and Description
NetworkViewSwitcher(org.cytoscape.service.util.CyServiceRegistrar reg, IDARESettingsManager ism) Constructs a NetworkView Switcher for the current application.

Method Summary

Modifier and Type	Method and Description
void	addNetworkToTree(org.cytoscape.model.CyNetwork parent, org.cytoscape.model.CyNetwork child, String ColumnID, String NetworkID) Add a subnetwork to the subnetwork hierarchy.
void	addSubNetworkView(org.cytoscape.model.CyNetwork network, org.cytoscape.view.model.CyNetworkView view) Add a new Network to the list of existing networks and also add its view.
org.cytoscape.work.TaskIterator	createTaskIterator(org.cytoscape.view.model.View<org.cytoscape.model.CyNode> arg0, org.cytoscape.view.model.CyNetworkView arg1)
HashMap<org.cytoscape.model.CyNetwork,org.cytoscape.view.model.CyNetworkView>	getExistingNetworks()
HashMap<org.cytoscape.model.CyNetwork,org.cytoscape.view.model.CyNetworkView>	getExistingNetworksForColumn(String selectedColumn) Get the subnetworks that currently exist for the provided column present in any parent network
String	getSubNetworkName(org.cytoscape.model.CyNetwork network) Get the internal name of the network (i.e.
Set<String>	getSubNetworkWorksForNetwork(org.cytoscape.model.CyNetwork parentnetwork, String ColName) Get the Names of all subnetworks for a specific parent network and a specific column.
void	handleEvent(org.cytoscape.model.events.NetworkAboutToBeDestroyedEvent e)
void	handleEvent(org.cytoscape.model.events.RowsSetEvent e) Check whether the set row is a network row and if, check whether it refers to a network, we are listening to and update all links accordingly
void	handleEvent(org.cytoscape.session.events.SessionAboutToBeSavedEvent arg0)
void	reset() Reset the Switcher (e.g.

Methods inherited from class org.cytoscape.task.AbstractNodeViewTaskFactory

isReady

Methods inherited from class java.lang.Object

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

Field Detail

PREFERRED_OPTION

public static String PREFERRED_OPTION

Title

public static String Title

Constructor Detail

NetworkViewSwitcher

public NetworkViewSwitcher(org.cytoscape.service.util.CyServiceRegistrar reg,
                           IDARESettingsManager ism)

Constructs a NetworkView Switcher for the current application.

Parameters:

reg - - A CyServiceRegistrar to obtain relevant services

ism - The IDARESettingsManager to use

Method Detail

createTaskIterator

public org.cytoscape.work.TaskIterator createTaskIterator(org.cytoscape.view.model.View<org.cytoscape.model.CyNode> arg0,
                                                          org.cytoscape.view.model.CyNetworkView arg1)

Specified by:

createTaskIterator in interface org.cytoscape.task.NodeViewTaskFactory

reset

public void reset()

Reset the Switcher (e.g. upon loading a session).

addSubNetworkView

public void addSubNetworkView(org.cytoscape.model.CyNetwork network,
                              org.cytoscape.view.model.CyNetworkView view)

Add a new Network to the list of existing networks and also add its view.

Parameters:

network - - The new CyNetwork

view - - A CyNetworkView for the provided CyNetwork

addNetworkToTree

public void addNetworkToTree(org.cytoscape.model.CyNetwork parent,
                             org.cytoscape.model.CyNetwork child,
                             String ColumnID,
                             String NetworkID)

Add a subnetwork to the subnetwork hierarchy.

Parameters:

parent - The parent network (to retrieve the parent node, or create it if parent non null

child - The child node (i.e. the node to add to the hierarchy

ColumnID - The Column the subnetwork is generated from.

NetworkID - The ID of the network (should be an entry of the column indicated).

getSubNetworkName

public String getSubNetworkName(org.cytoscape.model.CyNetwork network)

Get the internal name of the network (i.e. the identifier used)

Parameters:

network - The network to retrieve a name for

Returns:

The name used to identify the network.

getExistingNetworks

public HashMap<org.cytoscape.model.CyNetwork,org.cytoscape.view.model.CyNetworkView> getExistingNetworks()

getExistingNetworksForColumn

public HashMap<org.cytoscape.model.CyNetwork,org.cytoscape.view.model.CyNetworkView> getExistingNetworksForColumn(String selectedColumn)

Get the subnetworks that currently exist for the provided column present in any parent network

Parameters:

selectedColumn - The Column to obtain the Network to View pairs for

Returns:

A Map of CyNetwork to CyNetworkView pairs. The Views can be null, if there is no existing view for the given network.

getSubNetworkWorksForNetwork

public Set<String> getSubNetworkWorksForNetwork(org.cytoscape.model.CyNetwork parentnetwork,
                                                String ColName)

Get the Names of all subnetworks for a specific parent network and a specific column.

Parameters:

parentnetwork - the parent network to retrieve subnetwork names for

ColName - the currently selected Column (to only return names specific for this network)

Returns:

A Set of String with al the subnetwork Names for the provided parent network created using the specified column.

handleEvent

public void handleEvent(org.cytoscape.model.events.NetworkAboutToBeDestroyedEvent e)

Specified by:

handleEvent in interface org.cytoscape.model.events.NetworkAboutToBeDestroyedListener

handleEvent

public void handleEvent(org.cytoscape.model.events.RowsSetEvent e)

Check whether the set row is a network row and if, check whether it refers to a network, we are listening to and update all links accordingly

Specified by:

handleEvent in interface org.cytoscape.model.events.RowsSetListener

handleEvent

public void handleEvent(org.cytoscape.session.events.SessionAboutToBeSavedEvent arg0)

Specified by:

handleEvent in interface org.cytoscape.session.events.SessionAboutToBeSavedListener