org.wso2.carbon.dataservices.core.custom.datasource

Interface DataTable

All Known Implementing Classes:

InMemoryDataSource.InMemoryDataTable

public interface DataTable

This represents a data table in a custom data source.

Method Summary

Modifier and Type	Method and Description
void	deleteData(long... ids) Deletes rows from the data table.
Map<Long,DataRow>	filterData(String column, Object value, TabularDataBasedDS.FilterOperator operator) Returns filtered data according to the given criteria.
Map<Long,DataRow>	getData(long start, long length) Returns all the data in the table.
List<DataColumn>	getDataColumns() Returns all the data table columns available.
void	insertData(DataRow... values) Inserts a new row in to the data table.
void	updateData(Map<Long,DataRow> values) Updates the data table with the given values.

Method Detail

getDataColumns

List<DataColumn> getDataColumns()
                         throws DataServiceFault

Returns all the data table columns available.

Returns:

The list of data columns

Throws:

DataServiceFault - Thrown if any error occurs

getData

Map<Long,DataRow> getData(long start,
                          long length)
                   throws DataServiceFault

Returns all the data in the table.

Parameters:

start - The 0-based starting index of the results to be returned

length - The length of the result set size to be limited to, -1 if unlimited

Returns:

A map of data rows, keyed by a unique value to identify the row

Throws:

DatListaServiceFault - Thrown if any error occurs

DataServiceFault

updateData

void updateData(Map<Long,DataRow> values)
         throws DataServiceFault

Updates the data table with the given values.

Parameters:

values - The rows to be updated

Throws:

DataServiceFault - Thrown if any error occurs

insertData

void insertData(DataRow... values)
         throws DataServiceFault

Inserts a new row in to the data table.

Parameters:

values - The values of the new data row

Throws:

DataServiceFault - Thrown if any error occurs

deleteData

void deleteData(long... ids)
         throws DataServiceFault

Deletes rows from the data table.

Parameters:

ids - The row ids of the rows to be deleted

Throws:

DataServiceFault - Thrown if any error occurs

filterData

Map<Long,DataRow> filterData(String column,
                             Object value,
                             TabularDataBasedDS.FilterOperator operator)
                      throws DataServiceFault

Returns filtered data according to the given criteria.

Parameters:

column - The column the filtering to be based on

value - The value used to evaluate the criteria

operator - The operator used to do the evaluation

Returns:

The filtered data

Throws:

DataServiceFault - Thrown if any error occurs