org.cytoscape.model

Interface CyTableMetadata

public interface CyTableMetadata

A snapshot of information about a relationship shared between a CyTable instance and an associated CyNetworks. The interface is used to capture table information for serialization and shouldn't be needed for most normal use of tables.

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.

Module: model-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>model-api</artifactId>
</dependency>

Method Summary

Modifier and Type	Method and Description
String	getNamespace() Returns the namespace used as the key to this object's table in CyNetworkTableManager.getTables(org.cytoscape.model.CyNetwork, java.lang.Class<? extends org.cytoscape.model.CyIdentifiable>).
CyNetwork	getNetwork() Returns all the networks associated with this object's table.
CyTable	getTable() Returns the table whose metadata is described by this instance.
Class<?>	getType() Returns the type of the data associated with this object's table.

Method Detail

getType

Class<?> getType()

Returns the type of the data associated with this object's table. This is typically either CyNetwork.class, CyNode.class, or CyEdge.class.

Returns:

the type of the data associated with this object's table.

getTable

CyTable getTable()

Returns the table whose metadata is described by this instance.

Returns:

the table whose metadata is described by this instance.

getNetwork

CyNetwork getNetwork()

Returns all the networks associated with this object's table.

Returns:

all the networks associated with this object's table.

getNamespace

String getNamespace()

Returns the namespace used as the key to this object's table in CyNetworkTableManager.getTables(org.cytoscape.model.CyNetwork, java.lang.Class<? extends org.cytoscape.model.CyIdentifiable>).

Returns:

the namespace used as the key to this object's table in CyNetworkTableManager.getTables(org.cytoscape.model.CyNetwork, java.lang.Class<? extends org.cytoscape.model.CyIdentifiable>).