com.unvired.database

Interface IDataManager

public interface IDataManager

IDataManager provides access to the application's database. IDataManager provides methods to get, insert, modify and delete data into / from the database.

IDataManager deals with data in terms of Java Objects - .

IDataManager also allows execution of custom SQL statements. All methods which allow execution of custom SQL statements start with 'execute'.

How to get access to IDataManager: Use to get access to the IDataManager.

Example: {@code: ApplicationManager applicationManager = ApplicationManager.getInstance(); IDataManager dataManager = applicationManager.getDataManager();

SQLite is used as the underlying database.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IDataManager.ORDER_TYPE

Method Summary

Modifier and Type	Method and Description
void	beginTransaction() Do not use.
IDataStructure	checkDuplicateGID(IDataStructure dataStructure)
void	close()
int	count(java.lang.String structureName, java.lang.String whereClause) Get the count of the records in the database table which match the where clause.
void	createIndex(java.lang.String indexName, java.lang.String structureName, java.lang.String[] fieldNames)
void	createSavepoint(java.lang.String savePointName) Method createSavepoint.
void	createTable(java.lang.String structureName, java.lang.String[] columnNames, java.lang.String[] columnTypes, java.lang.String[] primaryKeys)
void	createTable(java.lang.String structureName, java.lang.String[] columnNames, java.lang.String[] columnTypes, java.lang.String[] primaryKeys, java.lang.String[] uniqueKeys)
void	createTable(java.lang.String structureName, java.lang.String[] columnNames, java.lang.String[] columnTypes, java.lang.String[] primaryKeys, java.lang.String[] uniqueKeys, boolean[] mandatoryFields, java.lang.String[] foreignKeys, java.lang.String headerStructureName, java.lang.String[] headerStructureKeys)
void	delete(IDataStructure dataStructure) Delete the data structure from the database.
void	delete(java.lang.String structureName) Deletes all rows in the table.
void	delete(java.lang.String structureName, java.lang.String whereClause) Deletes all rows in the table that satisfy the where clause.
void	dropDatabase()
void	dropIndex(java.lang.String indexName)
void	dropTable(java.lang.String structureName)
void	endTransaction() Do not use.
void	execute(java.lang.String sqlStatement) Executes a single SQL statement that does not return data.
void	executeBindQuery(java.lang.String sqlStatement, java.lang.Object[] columnValues) Executes a single SQL statement that does not return data.
Cursor	executeQuery(java.lang.String sqlStatement) Executes a single SQL statement returning Cursor over the result set.
boolean	exists()
IDataStructure[]	get(java.lang.String structureName) Get data from the database as IDataStructure objects for the given table name.
IDataStructure[]	get(java.lang.String structureName, java.lang.Class className) Do not use.
IDataStructure[]	get(java.lang.String structureName, java.lang.String whereClause) Get data from the database as IDataStructure objects for the given table name.
IDataStructure[]	get(java.lang.String structureName, java.lang.String[] orderByFields) Get data from the database as IDataStructure objects for the given table name.
IDataStructure[]	get(java.lang.String structureName, java.lang.String[] orderByFields, java.lang.Class className) Do not use.
IDataStructure[]	get(java.lang.String structureName, java.lang.String[] orderByFields, IDataManager.ORDER_TYPE orderType)
IDataStructure[]	get(java.lang.String structureName, java.lang.String whereClause, java.lang.Class className) Do not use.
IDataStructure[]	get(java.lang.String structureName, java.lang.String whereClause, java.lang.String[] orderByFields) Get data from the database as IDataStructure objects for the given table name.
IDataStructure[]	get(java.lang.String structureName, java.lang.String whereClause, java.lang.String[] orderByFields, java.lang.Class className) Do not use.
IDataStructure[]	get(java.lang.String structureName, java.lang.String whereClause, java.lang.String[] orderByFields, IDataManager.ORDER_TYPE orderType) Get data from the database as IDataStructure objects for the given table name.
java.util.Hashtable<java.lang.String,IDataStructure[]>	getAllChildren(IDataStructure headerDataStructure) Get all the children structures / items from the children tables for the give header data structure.
java.util.Hashtable<java.lang.String,JSONArray>	getAllChildren(com.unvired.model.JSDataStructure headerDataStructure) Get all the children structures / items from the children tables for the give header data structure.
IDataStructure	getBasedOnGID(IDataStructure dataStructure) Get the IDataStructure from the database based on GID.
IDataStructure[]	getChildren(java.lang.String structureName, IDataStructure headerDataStructure) Get all the children structures / items from the child table for the give header data structure.
JSONArray	getChildren(java.lang.String tableName, com.unvired.model.JSDataStructure headerDataStructure) Get all the children structures / items from the child table for the give header data structure.
IDataStructure[]	getChildren(java.lang.String structureName, java.lang.String[] orderByFields, IDataStructure headerDataStructure) Get all the children structures / items from the child table for the give header data structure.
IDataStructure[]	getChildren(java.lang.String structureName, java.lang.String whereClause, java.lang.String[] orderByFields, IDataStructure headerDataStructure) Get all the children structures / items from the child table for the give header data structure.
JSONArray	getJSON(java.lang.String tableName, java.lang.String whereClause) Get data from the database as JSDataStructure objects for the given table name.
JSONArray	getJSONDataStructuresFromCursor(Cursor cursor)
<T> java.util.List<T>	getTypedDS(java.lang.String tableName, java.lang.String whereClause, java.lang.String[] orderByFields, java.lang.Class className) Get data from the database as "typed" IDataStructure objects for the given table name.
void	insert(IDataStructure dataStructure) Insert the IDataStructure into the database.
void	insertJSON(java.lang.String tableName, JSONObject jsonObject)
void	insertOrUpdateBasedOnGID(IDataStructure dataStructure) Inserts or updates the IDataStructure into the database.
void	insertOrUpdateBasedOnGIDJSON(java.lang.String tableName, JSONObject jsonObject)
java.lang.Object	max(java.lang.String structureName, java.lang.String fieldName, java.lang.String whereClause) Get the maximum value of the required field in the database table which match the where clause.
java.lang.Object	min(java.lang.String structureName, java.lang.String fieldName, java.lang.String whereClause) Get the minimum value of the required field in the database table which match the where clause.
void	openOrCreate(java.lang.String key)
void	printDBSize()
void	releaseSavepoint(java.lang.String savePointName) Method releaseSavepoint.
void	rollbackToSavepoint(java.lang.String savePointName) Method rollbackToSavepoint.
java.lang.Object	total(java.lang.String structureName, java.lang.String fieldName, java.lang.String whereClause) Get the total value of the required field in the database table which match the where clause.
void	update(IDataStructure dataStructure) Update the IDataStructure into the database.
void	update(java.lang.String structureName, java.lang.String[] columnNames, java.lang.Object[] columnValues, java.lang.String whereClause) Update the table rows' columns with the provided values based on the where clause.
void	updateJSON(java.lang.String tableName, JSONObject jsonObject, java.lang.String whereClause)

Method Detail

openOrCreate

void openOrCreate(java.lang.String key)
           throws DBException

Throws:

DBException

exists

boolean exists()
        throws DBException

Throws:

DBException

close

void close()
    throws DBException

Throws:

DBException

beginTransaction

void beginTransaction()
               throws DBException

Do not use. Use executeTransaction(...).

Throws:

DBException

endTransaction

void endTransaction()
             throws DBException

Do not use. Use executeTransaction(...).

Throws:

DBException

dropDatabase

void dropDatabase()
           throws DBException

Throws:

DBException

dropTable

void dropTable(java.lang.String structureName)
        throws DBException

Throws:

DBException

createTable

void createTable(java.lang.String structureName,
                 java.lang.String[] columnNames,
                 java.lang.String[] columnTypes,
                 java.lang.String[] primaryKeys)
          throws DBException

Throws:

DBException

createTable

void createTable(java.lang.String structureName,
                 java.lang.String[] columnNames,
                 java.lang.String[] columnTypes,
                 java.lang.String[] primaryKeys,
                 java.lang.String[] uniqueKeys)
          throws DBException

Throws:

DBException

createTable

void createTable(java.lang.String structureName,
                 java.lang.String[] columnNames,
                 java.lang.String[] columnTypes,
                 java.lang.String[] primaryKeys,
                 java.lang.String[] uniqueKeys,
                 boolean[] mandatoryFields,
                 java.lang.String[] foreignKeys,
                 java.lang.String headerStructureName,
                 java.lang.String[] headerStructureKeys)
          throws DBException

Throws:

DBException

createIndex

void createIndex(java.lang.String indexName,
                 java.lang.String structureName,
                 java.lang.String[] fieldNames)
          throws DBException

Throws:

DBException

dropIndex

void dropIndex(java.lang.String indexName)
        throws DBException

Throws:

DBException

checkDuplicateGID

IDataStructure checkDuplicateGID(IDataStructure dataStructure)
                          throws DBException

Throws:

DBException

insert

void insert(IDataStructure dataStructure)
     throws DBException

Insert the IDataStructure into the database. Create an instance of the IDataStructure (implementation). Set the required fields. Insert the data structure.

Parameters:

dataStructure - Data Structure (header or item / structure) that is to be inserted in the database

Throws:

DBException - Throws a DBException if the DB is inaccessible

insertOrUpdateBasedOnGID

void insertOrUpdateBasedOnGID(IDataStructure dataStructure)
                       throws DBException

Inserts or updates the IDataStructure into the database. Data structure is identified based on the GID fields in the data model and if it exists the data structure is updated, otherwise inserted.

Convenience method used when it is not known if the data structure is already existing in the database.

Parameters:

dataStructure - Data Structure (header or item / structure) that is to be inserted / updates in the database

Throws:

DBException - Throws a DBException if the DB is inaccessible

delete

void delete(IDataStructure dataStructure)
     throws DBException

Delete the data structure from the database.

Parameters:

dataStructure - Data Structure (header or item / structure) that is to be inserted / updates in the database

Throws:

DBException - Throws a DBException if the DB is inaccessible

delete

void delete(java.lang.String structureName)
     throws DBException

Deletes all rows in the table.

Parameters:

structureName - Table where data should be deleted.

Throws:

DBException - Throws a DBException if the DB is inaccessible

delete

void delete(java.lang.String structureName,
            java.lang.String whereClause)
     throws DBException

Deletes all rows in the table that satisfy the where clause.

Where clause has to be manually constructed with the correct keywords supported by the database. Ex: WHERE sales_order_status = '1' AND customer_no = 'abc'

Parameters:

structureName - Table where data should be deleted.

whereClause - Where clause to filter the rows

Throws:

DBException - Throws a DBException if the DB is inaccessible

update

void update(IDataStructure dataStructure)
     throws DBException

Update the IDataStructure into the database. Update an instance of the IDataStructure (implementation). Set the required fields. Update the data structure.

The data structure can be obtained using get(..) methods before updating.

Parameters:

dataStructure - Data Structure (header or item / structure) that is to be updated in the database

Throws:

DBException - Throws a DBException if the DB is inaccessible

update

void update(java.lang.String structureName,
            java.lang.String[] columnNames,
            java.lang.Object[] columnValues,
            java.lang.String whereClause)
     throws DBException

Update the table rows' columns with the provided values based on the where clause.

Where clause has to be manually constructed with the correct keywords supported by the database. Ex: WHERE sales_order_status = '1' AND customer_no = 'abc'

Parameters:

structureName - Table required to be updated

columnNames - Array of column names that has to be updated

columnValues - Array of column values for the column names

whereClause - Where clause to filter the rows

Throws:

DBException - Throws a DBException if the DB is inaccessible

get

IDataStructure[] get(java.lang.String structureName)
              throws DBException

Get data from the database as IDataStructure objects for the given table name.

Parameters:

structureName - Table name from where data has to be fetched

Returns:

IDataStructure[] Array of data structure objects from the table

Throws:

DBException - Throws a DBException if the DB is inaccessible

get

IDataStructure[] get(java.lang.String structureName,
                     java.lang.String[] orderByFields)
              throws DBException

Get data from the database as IDataStructure objects for the given table name. The data structures are ordered by the fields provided in the array.

Parameters:

structureName - Table name from where data has to be fetched

orderByFields - String[] Array of fields to order the data fetched from the database. If there are multiple fields then the data is ordered according to the array index.

Returns:

IDataStructure[] Array of data structure objects from the table

Throws:

DBException - Throws a DBException if the DB is inaccessible

get

IDataStructure[] get(java.lang.String structureName,
                     java.lang.String[] orderByFields,
                     IDataManager.ORDER_TYPE orderType)
              throws DBException

Throws:

DBException

get

IDataStructure[] get(java.lang.String structureName,
                     java.lang.String whereClause)
              throws DBException

Get data from the database as IDataStructure objects for the given table name. Data is fetched based on the 'where clause'. 'where clause' should NOT contain the key word 'where'. Note all values have to be within single quotes.

Example for 'where clause':
  // Raw code
  String whereClause = "SALES_ORDER_TYPE = 'ABC' AND TOTAL_AMOUNT > '10000'";

  // Using some constants
  String whereClause = SALES_ORDER_HEADER.SALES_ORDER_TYPE  + " = '" + AppConstants.SALES_ORDER_STANDARD_TYPE + "' AND"
  					SALES_ORDER_HEADER.TOTAL_AMOUNT + " > '" + totalAmount + "'";

  
  

Parameters:

structureName - Table name from where data has to be fetched

whereClause - Where clause to filter data

Returns:

IDataStructure[] Array of data structure objects from the table

Throws:

DBException - Throws a DBException if the DB is inaccessible

get

IDataStructure[] get(java.lang.String structureName,
                     java.lang.String whereClause,
                     java.lang.String[] orderByFields)
              throws DBException

Get data from the database as IDataStructure objects for the given table name. The data structures are ordered by the fields provided in the array. Data is fetched based on the 'where clause'. The data structures are ordered by the fields provided in the array. 'where clause' should NOT contain the key word 'where'. Note all values have to be within single quotes.

Example for 'where clause':
   // Raw code
  String whereClause = "SALES_ORDER_TYPE = 'ABC' AND TOTAL_AMOUNT > '10000'";

  // Using some constants
  String whereClause = SALES_ORDER_HEADER.SALES_ORDER_TYPE  + " = '" + AppConstants.SALES_ORDER_STANDARD_TYPE + "' AND"
  					SALES_ORDER_HEADER.TOTAL_AMOUNT + " > '" + totalAmount + "'";

  
  

Parameters:

structureName - Table name from where data has to be fetched

whereClause - Where clause to filter data

orderByFields - String[] Array of fields to order the data fetched from the database. If there are multiple fields then the data is ordered according to the array index.

Returns:

IDataStructure[] Array of data structure objects from the table

Throws:

DBException - Throws a DBException if the DB is inaccessible

get

IDataStructure[] get(java.lang.String structureName,
                     java.lang.String whereClause,
                     java.lang.String[] orderByFields,
                     IDataManager.ORDER_TYPE orderType)
              throws DBException

Get data from the database as IDataStructure objects for the given table name. The data structures are ordered by the fields provided in the array. Data is fetched based on the 'where clause'. The data structures are ordered by the fields provided in the array. 'where clause' should NOT contain the key word 'where'. Note all values have to be within single quotes.

Example for 'where clause':
   // Raw code
  String whereClause = "SALES_ORDER_TYPE = 'ABC' AND TOTAL_AMOUNT > '10000'";

  // Using some constants
  String whereClause = SALES_ORDER_HEADER.SALES_ORDER_TYPE  + " = '" + AppConstants.SALES_ORDER_STANDARD_TYPE + "' AND"
  					SALES_ORDER_HEADER.TOTAL_AMOUNT + " > '" + totalAmount + "'";

  
  

Parameters:

structureName - Table name from where data has to be fetched

whereClause - Where clause to filter data

orderByFields - String[] Array of fields to order the data fetched from the database. If there are

orderType - order by ascending or descending. multiple fields then the data is ordered according to the array index.

Returns:

IDataStructure[] Array of data structure objects from the table

Throws:

DBException - Throws a DBException if the DB is inaccessible

get

IDataStructure[] get(java.lang.String structureName,
                     java.lang.Class className)
              throws DBException

Do not use.

Throws:

DBException

get

IDataStructure[] get(java.lang.String structureName,
                     java.lang.String[] orderByFields,
                     java.lang.Class className)
              throws DBException

Do not use.

Throws:

DBException

get

IDataStructure[] get(java.lang.String structureName,
                     java.lang.String whereClause,
                     java.lang.Class className)
              throws DBException

Do not use.

Throws:

DBException

get

IDataStructure[] get(java.lang.String structureName,
                     java.lang.String whereClause,
                     java.lang.String[] orderByFields,
                     java.lang.Class className)
              throws DBException

Do not use.

Throws:

DBException

getBasedOnGID

IDataStructure getBasedOnGID(IDataStructure dataStructure)
                      throws DBException

Get the IDataStructure from the database based on GID.

Parameters:

dataStructure - Data Structure (header or item / structure) that is to be fetched from the database

Throws:

DBException - Throws a DBException if the DB is inaccessible

getChildren

IDataStructure[] getChildren(java.lang.String structureName,
                             IDataStructure headerDataStructure)
                      throws DBException

Get all the children structures / items from the child table for the give header data structure. Ex: Get sales order items from table sales_order_items based on sales order header.

Parameters:

structureName - Table name from where data has to be fetched

headerDataStructure - Header data structure

Returns:

IDataStructure[] Array of data structure objects from the table

Throws:

DBException - Throws a DBException if the DB is inaccessible

getChildren

IDataStructure[] getChildren(java.lang.String structureName,
                             java.lang.String whereClause,
                             java.lang.String[] orderByFields,
                             IDataStructure headerDataStructure)
                      throws DBException

Get all the children structures / items from the child table for the give header data structure. Ex: Get sales order items from table sales_order_items based on sales order header. The data structures are ordered by the fields provided in the array. Data is fetched based on the 'where clause'. The data structures are ordered by the fields provided in the array. 'where clause' should NOT contain the key word 'where'. Note all values have to be within single quotes.

Example for 'where clause':
   // Raw code
  String whereClause = "SALES_ORDER_TYPE = 'ABC' AND TOTAL_AMOUNT > '10000'";

  // Using some constants
  String whereClause = SALES_ORDER_HEADER.SALES_ORDER_TYPE  + " = '" + AppConstants.SALES_ORDER_STANDARD_TYPE + "' AND"
  					SALES_ORDER_HEADER.TOTAL_AMOUNT + " > '" + totalAmount + "'";

  
  

Parameters:

structureName - Table name from where data has to be fetched

whereClause - Where clause to filter data

orderByFields - String[] Array of fields to order the data fetched from the database. If there are multiple fields then the data is ordered according to the array index.

headerDataStructure - Header data structure

Returns:

IDataStructure[] Array of data structure objects from the table

Throws:

DBException - Throws a DBException if the DB is inaccessible

getChildren

IDataStructure[] getChildren(java.lang.String structureName,
                             java.lang.String[] orderByFields,
                             IDataStructure headerDataStructure)
                      throws DBException

Get all the children structures / items from the child table for the give header data structure. The data structures are ordered by the fields provided in the array. Ex: Get sales order items from table sales_order_items based on sales order header.

Parameters:

structureName - Table name from where data has to be fetched

orderByFields - String[] Array of fields to order the data fetched from the database. If there are multiple fields then the data is ordered according to the array index.

headerDataStructure - Header data structure

Returns:

IDataStructure[] Array of data structure objects from the table

Throws:

DBException - Throws a DBException if the DB is inaccessible

getAllChildren

java.util.Hashtable<java.lang.String,IDataStructure[]> getAllChildren(IDataStructure headerDataStructure)
                                                               throws DBException

Get all the children structures / items from the children tables for the give header data structure. Ex: Get customer sales areas, customer ship to addresses based on customer header.

Parameters:

headerDataStructure - Header data structure.

Returns:

Hashtable. Hashtable of data structure objects from the children tables. The hashtable contains the child structure / item name as the key and an array of data structures as the value.

Throws:

DBException - Throws a DBException if the DB is inaccessible

count

int count(java.lang.String structureName,
          java.lang.String whereClause)
   throws DBException

Get the count of the records in the database table which match the where clause. 'where clause' should NOT contain the key word 'where'. Note all values have to be within single quotes.

Example for 'where clause':
   // Raw code
  String whereClause = "SALES_ORDER_TYPE = 'ABC' AND TOTAL_AMOUNT > '10000'";

  // Using some constants
  String whereClause = SALES_ORDER_HEADER.SALES_ORDER_TYPE  + " = '" + AppConstants.SALES_ORDER_STANDARD_TYPE + "' AND"
  					SALES_ORDER_HEADER.TOTAL_AMOUNT + " > '" + totalAmount + "'";

  
  

Parameters:

structureName - Table name from where data has to be fetched

whereClause - Where clause to filter data

Returns:

int Number of records

Throws:

DBException - Throws a DBException if the DB is inaccessible

max

java.lang.Object max(java.lang.String structureName,
                     java.lang.String fieldName,
                     java.lang.String whereClause)
              throws DBException

Get the maximum value of the required field in the database table which match the where clause. 'where clause' should NOT contain the key word 'where'. Note all values have to be within single quotes.

Example for 'where clause':
   // Raw code
  String whereClause = "SALES_ORDER_TYPE = 'ABC' AND TOTAL_AMOUNT > '10000'";

  // Using some constants
  String whereClause = SALES_ORDER_HEADER.SALES_ORDER_TYPE  + " = '" + AppConstants.SALES_ORDER_STANDARD_TYPE + "' AND"
  					SALES_ORDER_HEADER.TOTAL_AMOUNT + " > '" + totalAmount + "'";

  
  

Parameters:

structureName - Table name from where data has to be fetched

fieldName - Field whose max value is required

whereClause - Where clause to filter data

Returns:

Object Max value - Integer, Long, Float, Double or String based on field type

Throws:

DBException - Throws a DBException if the DB is inaccessible

min

java.lang.Object min(java.lang.String structureName,
                     java.lang.String fieldName,
                     java.lang.String whereClause)
              throws DBException

Get the minimum value of the required field in the database table which match the where clause. 'where clause' should NOT contain the key word 'where'. Note all values have to be within single quotes.

Example for 'where clause':
   // Raw code
  String whereClause = "SALES_ORDER_TYPE = 'ABC' AND TOTAL_AMOUNT > '10000'";

  // Using some constants
  String whereClause = SALES_ORDER_HEADER.SALES_ORDER_TYPE  + " = '" + AppConstants.SALES_ORDER_STANDARD_TYPE + "' AND"
  					SALES_ORDER_HEADER.TOTAL_AMOUNT + " > '" + totalAmount + "'";

  
  

Parameters:

structureName - Table name from where data has to be fetched

fieldName - Field whose min value is required

whereClause - Where clause to filter data

Returns:

Object Min value - Integer, Long, Float, Double or String based on field type

Throws:

DBException - Throws a DBException if the DB is inaccessible

total

java.lang.Object total(java.lang.String structureName,
                       java.lang.String fieldName,
                       java.lang.String whereClause)
                throws DBException

Get the total value of the required field in the database table which match the where clause. 'where clause' should NOT contain the key word 'where'. Note all values have to be within single quotes.

Example for 'where clause':
   // Raw code
  String whereClause = "SALES_ORDER_TYPE = 'ABC' AND TOTAL_AMOUNT > '10000'";

  // Using some constants
  String whereClause = SALES_ORDER_HEADER.SALES_ORDER_TYPE  + " = '" + AppConstants.SALES_ORDER_STANDARD_TYPE + "' AND"
  					SALES_ORDER_HEADER.TOTAL_AMOUNT + " > '" + totalAmount + "'";

  
  

Parameters:

structureName - Table name from where data has to be fetched

fieldName - Field whose min value is required

whereClause - Where clause to filter data

Returns:

Object Total value - Integer, Long, Float, Double or String based on field type

Throws:

DBException - Throws a DBException if the DB is inaccessible

execute

void execute(java.lang.String sqlStatement)
      throws DBException

Executes a single SQL statement that does not return data. SQL statement CANNOT be a SELECT, MAX, MIN, TOTAL, etc. statement.

Parameters:

sqlStatement - Single SQL statement that has to be executed

Throws:

DBException - Throws a DBException if the DB is inaccessible

executeBindQuery

void executeBindQuery(java.lang.String sqlStatement,
                      java.lang.Object[] columnValues)
               throws DBException

Executes a single SQL statement that does not return data. SQL statement CANNOT be a SELECT, MAX, MIN, TOTAL, etc. statement. The values for the fields can be bound using the column values.

Parameters:

sqlStatement - Single SQL statement that has to be executed

columnValues - Column values that have to be bound to the SQL statement

Throws:

DBException - Throws a DBException if the DB is inaccessible

executeQuery

Cursor executeQuery(java.lang.String sqlStatement)
             throws DBException

Executes a single SQL statement returning Cursor over the result set.

Parameters:

sqlStatement - Single SQL statement that has to be executed

Returns:

Cursor android.database.Cursor to the result set from the database

Throws:

DBException - Throws a DBException if the DB is inaccessible

rollbackToSavepoint

void rollbackToSavepoint(java.lang.String savePointName)
                  throws DBException

Method rollbackToSavepoint.

Parameters:

savePointName - String

Throws:

DBException

releaseSavepoint

void releaseSavepoint(java.lang.String savePointName)
               throws DBException

Method releaseSavepoint.

Parameters:

savePointName - String

Throws:

DBException

createSavepoint

void createSavepoint(java.lang.String savePointName)
              throws DBException

Method createSavepoint.

Parameters:

savePointName - String

Throws:

DBException

getTypedDS

<T> java.util.List<T> getTypedDS(java.lang.String tableName,
                                 java.lang.String whereClause,
                                 java.lang.String[] orderByFields,
                                 java.lang.Class className)
                          throws DBException

Get data from the database as "typed" IDataStructure objects for the given table name. The data structures are ordered by the fields provided in the array. Data is fetched based on the 'where clause'. The data structures are ordered by the fields provided in the array. 'where clause' should NOT contain the key word 'where'. Note all values have to be within single quotes.

Example for 'where clause':
   // Raw code
  String whereClause = "SALES_ORDER_TYPE = 'ABC' AND TOTAL_AMOUNT > '10000'";

  // Using some constants
  String whereClause = SALES_ORDER_HEADER.SALES_ORDER_TYPE  + " = '" + AppConstants.SALES_ORDER_STANDARD_TYPE + "' AND"
  					SALES_ORDER_HEADER.TOTAL_AMOUNT + " > '" + totalAmount + "'";

  
  

Parameters:

tableName - Table name from where data has to be fetched

whereClause - Where clause to filter data

orderByFields - String[] Array of fields to order the data fetched from the database. If there are multiple fields then the data is ordered according to the array index.

Returns:

IDataStructure List of the data structure type objects from the table. No need to run a loop and cast.

Throws:

DBException - Throws a DBException if the DB is inaccessible

printDBSize

void printDBSize()

insertJSON

void insertJSON(java.lang.String tableName,
                JSONObject jsonObject)
         throws DBException

Throws:

DBException

getJSON

JSONArray getJSON(java.lang.String tableName,
                  java.lang.String whereClause)
           throws DBException

Get data from the database as JSDataStructure objects for the given table name. Data is fetched based on the 'where clause'. 'where clause' should NOT contain the key word 'where'. Note all values have to be within single quotes.

Parameters:

tableName - Table name from where data has to be fetched

whereClause - Where clause to filter data

Returns:

JSONArray Array of JSDataStructure objects from the table

Throws:

DBException - Throws a DBException if the DB is inaccessible. For example:

See Also:

get(String, String)

getChildren

JSONArray getChildren(java.lang.String tableName,
                      com.unvired.model.JSDataStructure headerDataStructure)
               throws DBException

Get all the children structures / items from the child table for the give header data structure. Ex: Get sales order items from table sales_order_items based on sales order header.

Parameters:

tableName - Table name from where data has to be fetched

headerDataStructure - Header data structure

Returns:

JSONArray Array of data structure objects from the table

Throws:

DBException - Throws a DBException if the DB is inaccessible

getAllChildren

java.util.Hashtable<java.lang.String,JSONArray> getAllChildren(com.unvired.model.JSDataStructure headerDataStructure)
                                                        throws DBException

Get all the children structures / items from the children tables for the give header data structure. Ex: Get customer sales areas, customer ship to addresses based on customer header.

Parameters:

headerDataStructure - Header data structure.

Returns:

HashtableHashtable of data structure objects from the children tables. The hashtable contains the child structure / item name as the key and an array of data structures as the value.

Throws:

DBException - Throws a DBException if the DB is inaccessible

updateJSON

void updateJSON(java.lang.String tableName,
                JSONObject jsonObject,
                java.lang.String whereClause)
         throws DBException

Throws:

DBException

insertOrUpdateBasedOnGIDJSON

void insertOrUpdateBasedOnGIDJSON(java.lang.String tableName,
                                  JSONObject jsonObject)
                           throws DBException

Throws:

DBException

getJSONDataStructuresFromCursor

JSONArray getJSONDataStructuresFromCursor(Cursor cursor)
                                   throws DBException

Throws:

DBException