|
Cytoscape 3.0.1 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CyTableManager
A singleton object for managing registered CyTable
s.
When a CyTable
is created through a CyTableFactory
,
it exists independently from the rest of Cytoscape.
However, when a CyTable
is registered through the CyTableManager
,
CyTableManager
does the following things for the CyTable
:
TableAddedEvent
to inform other parts of Cytoscape that the CyTable
was added
to the CyTableManager
.
CyTable
available to other parts of
Cytoscape through methods like getAllTables(boolean)
.
CyTable
notifies Cytoscape about
the CyTable
, Cytoscape will ensure that the CyTable
is saved (see CyTable.setSavePolicy(org.cytoscape.model.SavePolicy)
). If the CyTable
is not registered with the CyTableManager
, it will not
be saved according to its SavePolicy
.
This interface, unfortunately, uses very confusing method names. Here is an explanation.
CyTable
s are explicitly mapped to
CyNetwork
, CyNode
s, or CyEdge
s through the
CyNetworkTableManager
.
Associated CyTable
s are obtained through getLocalTables(java.lang.Class extends org.cytoscape.model.CyIdentifiable>)
.
CyTable
s 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 getGlobalTables()
.
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 tables 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 |
---|
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 managerCyTable 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 tablesvoid reset()
Set<CyTable> getGlobalTables()
CyNetwork
s, CyNode
s, and CyEdge
s.
through CyNetworkTableManager
.
Set<CyTable> getLocalTables(Class<? extends CyIdentifiable> type)
CyNetwork
s,
CyNode
s, and CyEdge
s.
This method has nothing to do with CyNetwork.LOCAL_ATTRS
.
type
- Type of the network object, i.e., CyNetwork.class
,
CyNode.class
, or CyEdge.class
.
|
Cytoscape 3.0.1 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |