org.wso2.carbon.dataservices.core.odata

Class MongoDataHandler

java.lang.Object

org.wso2.carbon.dataservices.core.odata.MongoDataHandler

All Implemented Interfaces:

ODataDataHandler

public class MongoDataHandler
extends Object
implements ODataDataHandler

This class implements MongoDB datasource related operations for ODataDataHandler.

Constructor Summary

Constructors

Constructor and Description
MongoDataHandler(String configId, org.jongo.Jongo jongo)

Method Summary

Modifier and Type	Method and Description
void	commitTransaction() This method commits the transaction.
boolean	deleteEntityInTable(String tableName, ODataEntry entity) This method deletes the entity from the collection for a given key.
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 primary keys of all the collections in the database.
List<String>	getTableList() This method creates a list of collections available in the DB.
Map<String,Map<String,DataColumn>>	getTableMetadata() This method returns database collection metadata.
ODataEntry	insertEntityToTable(String tableName, ODataEntry entity) This method inserts a given entity to the given collection.
void	openTransaction() This method opens the transaction.
List<ODataEntry>	readTable(String tableName) This method reads the data for a given collection.
List<ODataEntry>	readTableWithKeys(String tableName, ODataEntry keys) This method reads the collection data for a given key(i.e.
void	rollbackTransaction() This method rollbacks the transaction.
boolean	updateEntityInTable(String tableName, ODataEntry newProperties) This method updates the given entity in the given collection.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

MongoDataHandler

public MongoDataHandler(String configId,
                        org.jongo.Jongo jongo)

Method Detail

getTableMetadata

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

This method returns database collection metadata. Returns a map with collection name as the key, and the values containing maps with column name as the map key, and the values of the column name map will be a DataColumn object, which represents the column.

Specified by:

getTableMetadata in interface ODataDataHandler

Returns:

Database Metadata

See Also:

DataColumn

getTableList

public List<String> getTableList()

This method creates a list of collections available in the DB.

Specified by:

getTableList in interface ODataDataHandler

Returns:

Table list.

getPrimaryKeys

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

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

Specified by:

getPrimaryKeys in interface ODataDataHandler

Returns:

Primary Key Map

readTable

public List<ODataEntry> readTable(String tableName)

This method reads the data for a given collection. Returns a list of DataEntry objects.

Specified by:

readTable in interface ODataDataHandler

Parameters:

tableName - Name of the table

Returns:

EntityCollection

See Also:

DataEntry

readTableWithKeys

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

This method reads the collection data for a given key(i.e. _id). Returns 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

insertEntityToTable

public ODataEntry insertEntityToTable(String tableName,
                                      ODataEntry entity)

This method inserts a given entity to the given collection.

Specified by:

insertEntityToTable in interface ODataDataHandler

Parameters:

tableName - Name of the table

entity - Entity

Throws:

ODataServiceFault

deleteEntityInTable

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

This method deletes the entity from the collection for a given key.

Specified by:

deleteEntityInTable in interface ODataDataHandler

Parameters:

tableName - Name of the table

entity - Entity

Throws:

ODataServiceFault

updateEntityInTable

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

This method updates the given entity in the given collection.

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

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

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()

This method opens the transaction.

Specified by:

openTransaction in interface ODataDataHandler

commitTransaction

public void commitTransaction()

This method commits the transaction.

Specified by:

commitTransaction in interface ODataDataHandler

rollbackTransaction

public void rollbackTransaction()

This method rollbacks the transaction.

Specified by:

rollbackTransaction in interface ODataDataHandler

updateReference

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

Specified by:

updateReference in interface ODataDataHandler

Parameters:

rootTableName - 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 rootTableName,
                            ODataEntry rootTableKeys,
                            String navigationTable,
                            ODataEntry navigationTableKeys)
                     throws ODataServiceFault

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

Specified by:

deleteReference in interface ODataDataHandler

Parameters:

rootTableName - Root - Table Name

rootTableKeys - Root - Entity keys (Primary Keys)

navigationTable - Navigation - Table Name

navigationTableKeys - Navigation - Entity Name (Primary Keys)

Throws:

ODataServiceFault