org.gcube.portlets.user.tdwx.server.datasource

Interface DataSourceX

public interface DataSourceX

Author:

"Giancarlo Panichi" g.panichi@isti.cnr.it

Method Summary

Methods

Modifier and Type	Method and Description
String	getDataAsJSon(int start, int limit, String sortingColumn, Direction direction, ArrayList<FilterInformation> filters, ArrayList<StaticFilterInformation> staticFilters) Retrieves the table data as JSON object.
String	getDataSourceFactoryId() Returns the id of the DataSourceXFactory that have generated it.
TableDefinition	getTableDefinition() Returns the table definition.

Method Detail

getDataSourceFactoryId

String getDataSourceFactoryId()

Returns the id of the DataSourceXFactory that have generated it.

Returns:

the DataSourceXFactory id.

getTableDefinition

TableDefinition getTableDefinition()
                                   throws DataSourceXException

Returns the table definition.

Returns:

a table definition.

Throws:

DataSourceXException - if an error occurred retrieving the table definition.

getDataAsJSon

String getDataAsJSon(int start,
                   int limit,
                   String sortingColumn,
                   Direction direction,
                   ArrayList<FilterInformation> filters,
                   ArrayList<StaticFilterInformation> staticFilters)
                     throws DataSourceXException

Retrieves the table data as JSON object.

Parameters:

start - the starting row index.

limit - the number of rows after the starting index to retrieve.

sortingColumn - the column used for sorting.

direction - the sorting direction.

filters - dynamic filters

staticFilters - static filters

Returns:

the JSON object as String.

Throws:

DataSourceXException - if an error occurred retrieving the table data.