org.wso2.carbon.dataservices.core.odata

Class RDBMSDataHandler

java.lang.Object

org.wso2.carbon.dataservices.core.odata.RDBMSDataHandler

All Implemented Interfaces:

ODataDataHandler

public class RDBMSDataHandler
extends Object
implements ODataDataHandler

This class implements RDBMS datasource related operations for ODataDataHandler.

See Also:

ODataDataHandler

Field Summary

Fields

Modifier and Type	Field and Description
static String	MSSQL_SERVER
static String	ORACLE_SERVER
static String	TABLE
static String	TABLE_NAME
static String	VIEW

Constructor Summary

Constructors

Constructor and Description
RDBMSDataHandler(DataSource dataSource, String configId)

Method Summary

Modifier and Type	Method and Description
void	commitTransaction() This method commits the transaction.
boolean	deleteEntityInTable(String tableName, ODataEntry entry) This method deletes entity from table.
void	deleteReference(String rootTable, 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 entry) 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 rootTable, ODataEntry rootTableKeys, String navigationTable, ODataEntry navigationTableKeys) This method updates the references of the table where the keys were imported.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TABLE_NAME

public static final String TABLE_NAME

See Also:

Constant Field Values

TABLE

public static final String TABLE

See Also:

Constant Field Values

VIEW

public static final String VIEW

See Also:

Constant Field Values

ORACLE_SERVER

public static final String ORACLE_SERVER

See Also:

Constant Field Values

MSSQL_SERVER

public static final String MSSQL_SERVER

See Also:

Constant Field Values

Constructor Detail

RDBMSDataHandler

public RDBMSDataHandler(DataSource dataSource,
                        String configId)
                 throws ODataServiceFault

Throws:

ODataServiceFault

Method Detail

getNavigationProperties

public Map<String,NavigationTable> getNavigationProperties()

Description copied from interface: ODataDataHandler

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

Specified by:

getNavigationProperties in interface ODataDataHandler

Returns:

NavigationProperty Map

openTransaction

public void openTransaction()
                     throws ODataServiceFault

Description copied from interface: ODataDataHandler

This method opens the transaction.

Specified by:

openTransaction in interface ODataDataHandler

Throws:

ODataServiceFault

commitTransaction

public void commitTransaction()
                       throws ODataServiceFault

Description copied from interface: ODataDataHandler

This method commits the transaction.

Specified by:

commitTransaction in interface ODataDataHandler

Throws:

ODataServiceFault

rollbackTransaction

public void rollbackTransaction()
                         throws ODataServiceFault

Description copied from interface: ODataDataHandler

This method rollbacks the transaction.

Specified by:

rollbackTransaction in interface ODataDataHandler

Throws:

ODataServiceFault

updateReference

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

Description copied from interface: ODataDataHandler

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

Specified by:

updateReference in interface ODataDataHandler

Parameters:

rootTable - Root - Table Name

rootTableKeys - Root - Entity keys (Primary Keys)

navigationTable - Navigation - Table Name

navigationTableKeys - Navigation - Entity Name (Primary Keys)

Throws:

ODataServiceFault

deleteReference

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

Description copied from interface: ODataDataHandler

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

Specified by:

deleteReference in interface ODataDataHandler

Parameters:

rootTable - Root - Table Name

rootTableKeys - Root - Entity keys (Primary Keys)

navigationTable - Navigation - Table Name

navigationTableKeys - Navigation - Entity Name (Primary Keys)

Throws:

ODataServiceFault

readTable

public List<ODataEntry> readTable(String tableName)
                           throws ODataServiceFault

Description copied from interface: ODataDataHandler

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

Specified by:

readTable in interface ODataDataHandler

Parameters:

tableName - Name of the table

Returns:

EntityCollection

Throws:

ODataServiceFault

See Also:

DataEntry

getTableList

public List<String> getTableList()

Description copied from interface: ODataDataHandler

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

Specified by:

getTableList in interface ODataDataHandler

Returns:

Table list.

getPrimaryKeys

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

Description copied from interface: ODataDataHandler

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.

Specified by:

getPrimaryKeys in interface ODataDataHandler

Returns:

Primary Key Map

insertEntityToTable

public ODataEntry insertEntityToTable(String tableName,
                                      ODataEntry entry)
                               throws ODataServiceFault

Description copied from interface: ODataDataHandler

This method inserts entity to table.

Specified by:

insertEntityToTable in interface ODataDataHandler

Parameters:

tableName - Name of the table

entry - Entity

Throws:

ODataServiceFault

readTableWithKeys

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

Description copied from interface: ODataDataHandler

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

Specified by:

readTableWithKeys in interface ODataDataHandler

Parameters:

tableName - Name of the table

keys - Keys to check

Returns:

EntityCollection

Throws:

ODataServiceFault

See Also:

DataEntry

updateEntityInTable

public boolean updateEntityInTable(String tableName,
                                   ODataEntry newProperties)
                            throws ODataServiceFault

Description copied from interface: ODataDataHandler

This method updates entity in table.

Specified by:

updateEntityInTable in interface ODataDataHandler

Parameters:

tableName - Name of the table

newProperties - New Properties

Throws:

ODataServiceFault

updateEntityInTableTransactional

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

Description copied from interface: ODataDataHandler

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

Specified by:

updateEntityInTableTransactional in interface ODataDataHandler

Parameters:

tableName - Table Name

oldProperties - Old Properties

newProperties - New Properties

Throws:

ODataServiceFault

deleteEntityInTable

public boolean deleteEntityInTable(String tableName,
                                   ODataEntry entry)
                            throws ODataServiceFault

Description copied from interface: ODataDataHandler

This method deletes entity from table.

Specified by:

deleteEntityInTable in interface ODataDataHandler

Parameters:

tableName - Name of the table

entry - Entity

Throws:

ODataServiceFault

getTableMetadata

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

Description copied from interface: ODataDataHandler

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.

Specified by:

getTableMetadata in interface ODataDataHandler

Returns:

Database Metadata

See Also:

DataColumn