Interface VirtualColumnInfo


  • public interface VirtualColumnInfo
    Information object for columns that stores extra Virtual Column information if applicable. See CyTable.addVirtualColumn(java.lang.String, java.lang.String, org.cytoscape.model.CyTable, java.lang.String, boolean) for details on what virtual columns are.

    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.
    • Method Detail

      • isVirtual

        boolean isVirtual()
        Returns true if the column is virtual, otherwise false.
        Returns:
        true if the column is virtual, otherwise false.
      • getSourceColumn

        String getSourceColumn()
        Returns the name of the column from the source table which contains the values this column provides.
        Returns:
        the name of the column from the source table which contains the values this column provides.
      • getSourceJoinKey

        String getSourceJoinKey()
        Returns the name of the column from the source table used for the join.
        Returns:
        the name of the column from the source table used for the join.
      • getTargetJoinKey

        String getTargetJoinKey()
        Returns the name of the column from the target table used for the join.
        Returns:
        the name of the column from the target table used for the join.
      • getSourceTable

        CyTable getSourceTable()
        Returns the originating table for this column if this column is virtual.
        Returns:
        the originating table for this column if this column is virtual.
      • isImmutable

        boolean isImmutable()
        Returns true if this virtual column was originally created immutable.
        Returns:
        true if this virtual column was originally created immutable.