Module omix.api

Package omix.plugin.data

Interface DataManager

All Superinterfaces:

DataManager

public interface DataManager
extends DataManager

This class represents the data manager sidebar and provides access to the currently open data sources and tables.

Since:

Omix 1.8.6

Author:

Dr. Peter Droste

See Also:

DataManager

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	DataManager.CloseDataSourceEvent
static class	DataManager.CurrentDataSourceChangeEvent
static class	DataManager.CurrentTableChangeEvent
static class	DataManager.DataManagerChangeEvent
static interface	DataManager.DataManagerChangeListener
static class	DataManager.DataManagerSourceChangeEvent
static class	DataManager.GeneralDataManagerChangeEvent
static class	DataManager.LanguageChangeEvent
static class	DataManager.OpenDataSourceEvent
static class	DataManager.TableFormatChangeEvent

Method Summary

Modifier and Type	Method	Description
default void	addDataManagerChangeListener(DataManager.DataManagerChangeListener listener)
Table	getCurrentTable()	Returns the table currently open or null if no table is open.
DataSourceInterface	getDataSource(String dataSourceID)	returns the data source for the given identifier
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.
default void	removeDataManagerChangeListener(DataManager.DataManagerChangeListener listener)

Method Details

getCurrentTable

Table getCurrentTable()

Returns the table currently open or null if no table is open.

Specified by:

getCurrentTable in interface DataManager

Returns:

current table

See Also:

DataManager.getCurrentTable()

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".

Specified by:

getTable in interface DataManager

Parameters:

path -

Returns:

table according to path

See Also:

DataManager.getTable(String)

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".

Specified by:

getTable in interface DataManager

Parameters:

dataSourceID -

tableID -

Returns:

table according to dataSourceID and tableID

See Also:

DataManager.getTable(String, String)

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".

Specified by:

getTable in interface DataManager

Parameters:

dataSourceID -

tableIndex -

Returns:

table

See Also:

DataManager.getTable(String, int)

getDataSourceIDs

List<String> getDataSourceIDs()

Returns a list of all available data sources.

Specified by:

getDataSourceIDs in interface DataManager

Returns:

data sources

See Also:

DataManager.getDataSourceIDs()

getTableIDs

List<String> getTableIDs(String dataSourceID)

Returns a list of all available tables in a data source.

Specified by:

getTableIDs in interface DataManager

Parameters:

dataSourceID -

Returns:

table IDs

See Also:

DataManager.getTableIDs(String)

addDataManagerChangeListener

default void addDataManagerChangeListener(DataManager.DataManagerChangeListener listener)

removeDataManagerChangeListener

default void removeDataManagerChangeListener(DataManager.DataManagerChangeListener listener)

getDataSource

DataSourceInterface getDataSource(String dataSourceID)

returns the data source for the given identifier

Parameters:

dataSourceID -

Returns:

DataSourceInterface

Since:

Omix 1.8.6