Package org.cytoscape.model

Interface CyTableFactory

public interface CyTableFactory
An interface describing a factory used for creating CyTable objects. This factory will be provided as a service through Spring/OSGi.

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>

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.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    CyTableFactory.InitialTableSize
    A description of the initial size of the table.

  • Method Summary

    Modifier and Type
    Method
    Description
    CyTable
    createTable​(String title, String primaryKey, Class<?> primaryKeyType, boolean pub, boolean isMutable)
    Creates a CyTable object with the specified name, primary key, visibility, and mutability.
    CyTable
    createTable​(String title, String primaryKey, Class<?> primaryKeyType, boolean pub, boolean isMutable, CyTableFactory.InitialTableSize initialSize)
    Creates a CyTable object with the specified name, primary key, visibility, and mutability.

  • Method Details

    • createTable

      CyTable createTable​(String title, String primaryKey, Class<?> primaryKeyType, boolean pub, boolean isMutable, CyTableFactory.InitialTableSize initialSize)
      Creates a CyTable object with the specified name, primary key, visibility, and mutability.
      Parameters:
      title - The name of the CyTable.
      primaryKey - The name primaryKey column for this table.
      primaryKeyType - The type of the primaryKey column for this table; this must be Long.class if the table's keys are to refer to network objects, i.e. nodes, edges, networks.
      pub - Whether or not the CyTable should be public.
      isMutable - if true, the table can be deleted later on, otherwise it can't
      initialSize - a rough guess as to the expected size of the table
      Returns:
      A new CyTable with the specified name that is either public or not (see CyTable.isPublic().

    • createTable

      CyTable createTable​(String title, String primaryKey, Class<?> primaryKeyType, boolean pub, boolean isMutable)
      Creates a CyTable object with the specified name, primary key, visibility, and mutability.
      Parameters:
      title - The name of the CyTable.
      primaryKey - The name primaryKey column for this table.
      primaryKeyType - The type of the primaryKey column for this table; this must be Long.class if the table's keys are to refer to network objects, i.e. nodes, edges, networks.
      pub - Whether or not the CyTable should be public.
      isMutable - if true, the table can be deleted later on, otherwise it can't
      Returns:
      A new CyTable with the specified name that is either public or not (see CyTable.isPublic().