Module omix.api
Package omix.lang.data

Interface DataManager

All Known Subinterfaces:
DataManager
public interface DataManager
This class represents the data manager sidebar and provides access to the currently open data sources and tables.
Since:
Omix 1.8.5
Author:
Dr. Peter Droste

  • Method Summary

    Modifier and Type Method Description
    Table getCurrentTable()
    Returns the table currently open or null if no table is open.
    List<String> getDataSourceIDs()
    Returns a list of all available data sources.
    Table getTable​(String path)
    Returns the table under the specified path or null if table is not available.
    Table getTable​(String dataSourceID, int tableIndex)
    Returns the n'th table within the specified data source or null if table is not available.
    Table getTable​(String dataSourceID, String tableID)
    Returns the table with the specified "tableID" within the specified data source or null if table is not available.
    List<String> getTableIDs​(String dataSourceID)
    Returns a list of all available tables in a data source.

  • Method Details

    • getCurrentTable

      Table getCurrentTable()
      Returns the table currently open or null if no table is open.
      Returns:
      current table

    • getTable

      Table getTable​(String path)
      Returns the table under the specified path or null if table is not available. For instance, "data.csv" refers to the corresponding file, "data.xlsx/table1" refers to the sheet "table1" in file "data.xlsx".
      Parameters:
      path -
      Returns:
      table according to path

    • getTable

      Table getTable​(String dataSourceID, String tableID)
      Returns the table with the specified "tableID" within the specified data source or null if table is not available. For instance, getTable("data.xlsx", "table1") refers to the sheet "table1" within file "data.xlsx".
      Parameters:
      dataSourceID -
      tableID -
      Returns:
      table according to dataSourceID and tableID

    • getTable

      Table getTable​(String dataSourceID, int tableIndex)
      Returns the n'th table within the specified data source or null if table is not available. The first sheet has index n=0. For instance, getTable("data.xlsx", 2) refers to the third(!) sheet in file "data.xlsx".
      Parameters:
      dataSourceID -
      tableIndex -
      Returns:
      table

    • getDataSourceIDs

      List<String> getDataSourceIDs()
      Returns a list of all available data sources.
      Returns:
      data sources

    • getTableIDs

      List<String> getTableIDs​(String dataSourceID)
      Returns a list of all available tables in a data source.
      Parameters:
      dataSourceID -
      Returns:
      table IDs