org.cytoscape.model
Interface CyNetworkTableManager

public interface CyNetworkTableManager

Provides access to all network-table relationships.

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.

Method Summary

Set<CyNetwork>	getNetworkSet() Returns a read-only set of all networks managed by this instance.
CyTable	getTable(CyNetwork network, Class<? extends CyIdentifiable> type, String namespace) Returns the table with the specified namespace and type from the network.
Map<String,CyTable>	getTables(CyNetwork network, Class<? extends CyIdentifiable> type) Returns a read-only map of all of the tables for the specified type from the network.
void	removeTable(CyNetwork network, Class<? extends CyIdentifiable> type, String namespace) Removes the table with the specified namespace and type from the network.
void	reset() Clears all the network-table relationships.
void	setTable(CyNetwork network, Class<? extends CyIdentifiable> type, String namespace, CyTable table) Associates the given table to the network using the specified namespace and type.

Method Detail

setTable

void setTable(CyNetwork network,
              Class<? extends CyIdentifiable> type,
              String namespace,
              CyTable table)

Associates the given table to the network using the specified namespace and type.

Parameters:

network - the CyNetwork to associate the given table to.

type - Type of CyIdentifiable associated with the table.

namespace - The name of the table relative to the network.

table - the table to associate to the network with the specified namespace and type.

getTable

CyTable getTable(CyNetwork network,
                 Class<? extends CyIdentifiable> type,
                 String namespace)

Returns the table with the specified namespace and type from the network.

Parameters:

network - the network to check for the table.

type - Type of CyIdentifiable associated with the table.

namespace - The name of the table relative to the network.

Returns:

the table with the specified namespace and type from the network.

removeTable

void removeTable(CyNetwork network,
                 Class<? extends CyIdentifiable> type,
                 String namespace)

Removes the table with the specified namespace and type from the network.

Parameters:

network - the network to remove the table from.

type - Type of CyIdentifiable associated with the table.

namespace - The name of the table relative to the network.

getTables

Map<String,CyTable> getTables(CyNetwork network,
                              Class<? extends CyIdentifiable> type)

Returns a read-only map of all of the tables for the specified type from the network. Each table is keyed by its namespace.

Parameters:

network - The network to return the tables of.

type - The type of the tables to return.

Returns:

a read-only map of all the tables for the specified type from the network.

reset

void reset()

Clears all the network-table relationships.

getNetworkSet

Set<CyNetwork> getNetworkSet()

Returns a read-only set of all networks managed by this instance.

Returns:

a read-only set of all networks managed by this instance.