public interface CyTableManager
CyTable is created through a
it exists independently from the rest of Cytoscape.
However, when a
CyTable is registered through the
CyTableManager does the following things for the
TableAddedEventto inform other parts of Cytoscape that the
CyTablewas added to the
CyTableavailable to other parts of Cytoscape through methods like
CyTablenotifies Cytoscape about the
CyTable, Cytoscape will ensure that the
CyTableis saved (see
CyTable.setSavePolicy(org.cytoscape.model.SavePolicy)). If the
CyTableis not registered with the
CyTableManager, it will not be saved according to its
This interface, unfortunately, uses very confusing method names. Here is an explanation.
CyTables are explicitly mapped to
CyEdges through the
CyTables are obtained through
getLocalTables(java.lang.Class<? extends org.cytoscape.model.CyIdentifiable>).
CyTables are not explicitly mapped to network objects. Note that columns in an unassociated table can still be "mapped" to network objects when an associated table has a virtual column from an unassociated table. Unassigned tables are obtained from
To use this in your app, include the following dependency in your POM:
<dependency> <groupId>org.cytoscape</groupId> <artifactId>model-api</artifactId> </dependency>
|Modifier and Type||Method and Description|
Registers a new table with the manager and fires a TableAddedEvent event.
Deletes a mutable table.
Returns a Set of all tables with the specified visibility.
Returns a set of all global tables.
Returns set of all local tables for the given data type.
Returns the table with the specified SUID.
Releases all currently held references and resources.
Set<CyTable> getAllTables(boolean includePrivate)
includePrivate- Whether to include private CyTables in the list (i.e. all possible CyTables) or not.
void addTable(CyTable table)
table- a non-null CyTable that will be added to the manager
CyTable getTable(long suid)
suid- The SUID identifying the CyTable.
void deleteTable(long suid)
suid- the SUID identifying the CyTable to be deleted
IllegalArgumentException- if the table that we requested to be deleted is immutable or if any of its columns are virtual columns in other tables
Set<CyTable> getLocalTables(Class<? extends CyIdentifiable> type)
CyEdges. This method has nothing to do with
type- Type of the network object, i.e.,
Copyright 2011 Cytoscape Consortium. All rights reserved.