org.wso2.carbon.dataservices.core.odata

Interface ODataDataHandler

All Known Implementing Classes:

CassandraDataHandler, RDBMSDataHandler

public interface ODataDataHandler

This class represents an odata data handler used when using odata db handles.

Method Summary

Modifier and Type	Method and Description
void	commitTransaction() This method commits the transaction.
boolean	deleteEntityInTable(String tableName, ODataEntry entity) This method deletes entity from table.
void	deleteReference(String rootTableName, ODataEntry rootTableKeys, String navigationTable, ODataEntry navigationTableKeys) This method deletes the references of the table where the keys were imported.
Map<String,NavigationTable>	getNavigationProperties() This method returns the navigation property map, which contains the Navigation table which contains the all the navigation paths from the table,
Map<String,List<String>>	getPrimaryKeys() This method returns the all the primary keys in the database tables.
List<String>	getTableList() This method return names of all the tables in the database.
Map<String,Map<String,DataColumn>>	getTableMetadata() This method return database table metadata.
ODataEntry	insertEntityToTable(String tableName, ODataEntry entity) This method inserts entity to table.
void	openTransaction() This method opens the transaction.
List<ODataEntry>	readTable(String tableName) This method read the table data and return.
List<ODataEntry>	readTableWithKeys(String tableName, ODataEntry keys) This method read the table with Keys and return.
void	rollbackTransaction() This method rollbacks the transaction.
boolean	updateEntityInTable(String tableName, ODataEntry newProperties) This method updates entity in table.
boolean	updateEntityInTableTransactional(String tableName, ODataEntry oldProperties, ODataEntry newProperties) This method updates the entity in table when transactional update is necessary.
void	updateReference(String rootTableName, ODataEntry rootTableKeys, String navigationTable, ODataEntry navigationTableKeys) This method updates the references of the table where the keys were imported.

Method Detail

readTable

List<ODataEntry> readTable(String tableName)
                    throws ODataServiceFault

This method read the table data and return. Return a list of DataEntry object which has been wrapped the entity.

Parameters:

tableName - Name of the table

Returns:

EntityCollection

Throws:

ODataServiceFault

See Also:

DataEntry

readTableWithKeys

List<ODataEntry> readTableWithKeys(String tableName,
                                   ODataEntry keys)
                            throws ODataServiceFault

This method read the table with Keys and return. Return a list of DataEntry object which has been wrapped the entity.

Parameters:

tableName - Name of the table

keys - Keys to check

Returns:

EntityCollection

Throws:

ODataServiceFault

See Also:

DataEntry

insertEntityToTable

ODataEntry insertEntityToTable(String tableName,
                               ODataEntry entity)
                        throws ODataServiceFault

This method inserts entity to table.

Parameters:

tableName - Name of the table

entity - Entity

Throws:

ODataServiceFault

deleteEntityInTable

boolean deleteEntityInTable(String tableName,
                            ODataEntry entity)
                     throws ODataServiceFault

This method deletes entity from table.

Parameters:

tableName - Name of the table

entity - Entity

Throws:

ODataServiceFault

updateEntityInTable

boolean updateEntityInTable(String tableName,
                            ODataEntry newProperties)
                     throws ODataServiceFault

This method updates entity in table.

Parameters:

tableName - Name of the table

newProperties - New Properties

Throws:

ODataServiceFault

updateEntityInTableTransactional

boolean updateEntityInTableTransactional(String tableName,
                                         ODataEntry oldProperties,
                                         ODataEntry newProperties)
                                  throws ODataServiceFault

This method updates the entity in table when transactional update is necessary.

Parameters:

tableName - Table Name

oldProperties - Old Properties

newProperties - New Properties

Throws:

ODataServiceFault

getTableMetadata

Map<String,Map<String,DataColumn>> getTableMetadata()

This method return database table metadata. Return a map with table name as the key, and the values contains maps with column name as the map key, and the values of the column name map will DataColumn object, which represents the column.

Returns:

Database Metadata

See Also:

DataColumn

getTableList

List<String> getTableList()

This method return names of all the tables in the database.

Returns:

Table list.

getPrimaryKeys

Map<String,List<String>> getPrimaryKeys()

This method returns the all the primary keys in the database tables. Return a map with table name as the keys, and the values contains a list of column names which are act as primary keys in the table.

Returns:

Primary Key Map

getNavigationProperties

Map<String,NavigationTable> getNavigationProperties()

This method returns the navigation property map, which contains the Navigation table which contains the all the navigation paths from the table,

Returns:

NavigationProperty Map

openTransaction

void openTransaction()
              throws ODataServiceFault

This method opens the transaction.

Throws:

ODataServiceFault

commitTransaction

void commitTransaction()
                throws ODataServiceFault

This method commits the transaction.

Throws:

ODataServiceFault

rollbackTransaction

void rollbackTransaction()
                  throws ODataServiceFault

This method rollbacks the transaction.

Throws:

ODataServiceFault

updateReference

void updateReference(String rootTableName,
                     ODataEntry rootTableKeys,
                     String navigationTable,
                     ODataEntry navigationTableKeys)
              throws ODataServiceFault

This method updates the references of the table where the keys were imported.

Parameters:

rootTableName - Root - Table Name

rootTableKeys - Root - Entity keys (Primary Keys)

navigationTable - Navigation - Table Name

navigationTableKeys - Navigation - Entity Name (Primary Keys)

Throws:

ODataServiceFault

deleteReference

void deleteReference(String rootTableName,
                     ODataEntry rootTableKeys,
                     String navigationTable,
                     ODataEntry navigationTableKeys)
              throws ODataServiceFault

This method deletes the references of the table where the keys were imported.

Parameters:

rootTableName - Root - Table Name

rootTableKeys - Root - Entity keys (Primary Keys)

navigationTable - Navigation - Table Name

navigationTableKeys - Navigation - Entity Name (Primary Keys)

Throws:

ODataServiceFault