org.cytoscape.model
Interface CyTableManager

public interface CyTableManager

A singleton object that provides access to the available tables in the system. Should be provided as an OSGi service.

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

void	addTable(CyTable table) Registers a new table with the manager and fires a TableAddedEvent event.
void	deleteTable(long suid) Deletes a mutable table.
Set<CyTable>	getAllTables(boolean includePrivate) Returns a Set of all tables with the specified visibility.
Set<CyTable>	getGlobalTables() Returns a set of all global tables.
Set<CyTable>	getLocalTables(Class<? extends CyIdentifiable> type) Returns set of all local tabses for the given data type.
CyTable	getTable(long suid) Returns the table with the specified SUID.
void	reset() Releases all currently held references and resources.

Method Detail

getAllTables

Set<CyTable> getAllTables(boolean includePrivate)

Returns a Set of all tables with the specified visibility.

Parameters:

includePrivate - Whether to include private CyTables in the list (i.e. all possible CyTables) or not.

Returns:

A Set containing CyTable SUIDs either including private CyTables (i.e. meaning all possible CyTables) or just public CyTables.

addTable

void addTable(CyTable table)

Registers a new table with the manager and fires a TableAddedEvent event.

Parameters:

table - a non-null CyTable that will be added to the manager

getTable

CyTable getTable(long suid)

Returns the table with the specified SUID.

Parameters:

suid - The SUID identifying the CyTable.

Returns:

The CyTable identified by the suid. Will return null if a CyTable doesn't exist for the specified SUID.

deleteTable

void deleteTable(long suid)

Deletes a mutable table.

Parameters:

suid - the SUID identifying the CyTable to be deleted

Throws:

IllegalArgumentException - if the table that we requested to be deleted is immutable or if any of its columns are virtual columns in other tables

reset

void reset()

Releases all currently held references and resources.

getGlobalTables

Set<CyTable> getGlobalTables()

Returns a set of all global tables.

Returns:

All registered global tables

getLocalTables

Set<CyTable> getLocalTables(Class<? extends CyIdentifiable> type)

Returns set of all local tabses for the given data type.

Parameters:

type - Type of the graph object, i.e., node, edge or network.

Returns:

Set of all registered tables associated with the given data type.