org.singlet.dao
Interface SingletDAO

All Known Implementing Classes:
SingletDAOImpl

public interface SingletDAO


Method Summary
 int delete(java.sql.Connection conn, java.lang.String sqlId, java.util.LinkedHashMap<java.lang.String,java.lang.String> whereMap)
          This method is used to delete data in database.
 void executeDDL(java.sql.Connection conn, java.lang.String sqlId)
          This method is used to execute DDL queries.
 int insert(java.sql.Connection conn, java.lang.String sqlId, java.util.LinkedHashMap<java.lang.String,java.lang.String> dataMap)
          This method is used to insert or update data in database.
 java.lang.String[] insert(java.sql.Connection conn, java.lang.String sqlId, java.util.LinkedHashMap<java.lang.String,java.lang.String> dataMap, boolean generateKeys)
           
 int[] insertBatch(java.sql.Connection conn, java.lang.String sqlId, java.util.List<java.util.LinkedHashMap<java.lang.String,java.lang.String>> batchMapList, java.lang.Integer batchCount)
          This method is used to insert or update data in database in batches.
 int insertUpdate(java.sql.Connection conn, java.lang.String sqlId, java.util.LinkedHashMap<java.lang.String,java.lang.String> dataMap)
          This method is used to insert or update data in database.
 java.lang.Object read(java.sql.Connection conn, java.lang.String sqlId, java.util.LinkedHashMap<java.lang.String,java.lang.String> whereMap)
          This method is used to read data from database.
 java.lang.Object read(java.sql.Connection conn, java.lang.String sqlId, java.util.LinkedHashMap<java.lang.String,java.lang.String> whereMap, java.lang.String outputType)
          This method is used to read data from database.
 java.lang.Object read(java.sql.Connection conn, java.lang.String sqlId, java.util.LinkedHashMap<java.lang.String,java.lang.String> whereMap, java.lang.String sortName, java.lang.String sortOrder, java.lang.String outputType)
          This method is used to read data from database.
 java.lang.Object read(java.sql.Connection conn, java.lang.String sqlId, java.util.LinkedHashMap<java.lang.String,java.lang.String> whereMap, java.lang.String sortName, java.lang.String sortOrder, java.lang.String outputType, java.lang.Integer startLimit, java.lang.Integer endLimit)
          This method is used to read data from database.
 int update(java.sql.Connection conn, java.lang.String sqlId, java.util.LinkedHashMap<java.lang.String,java.lang.String> setMap, java.util.LinkedHashMap<java.lang.String,java.lang.String> whereMap)
          This method is used to update data in database.
 

Method Detail

insert

int insert(java.sql.Connection conn,
           java.lang.String sqlId,
           java.util.LinkedHashMap<java.lang.String,java.lang.String> dataMap)
           throws DataException,
                  java.lang.Exception
This method is used to insert or update data in database.

Parameters:
conn - - database connection
sqlId - - id for the SQL defined in configuration file
dataMap - - data that need to be updated
Returns:
int - number of records inserted
Throws:
DataException - - exception due to SQL execution
java.lang.Exception

insert

java.lang.String[] insert(java.sql.Connection conn,
                          java.lang.String sqlId,
                          java.util.LinkedHashMap<java.lang.String,java.lang.String> dataMap,
                          boolean generateKeys)
                          throws DataException
Throws:
DataException

insertUpdate

int insertUpdate(java.sql.Connection conn,
                 java.lang.String sqlId,
                 java.util.LinkedHashMap<java.lang.String,java.lang.String> dataMap)
                 throws DataException
This method is used to insert or update data in database.

Parameters:
conn - - database connection
sqlId - - id for the SQL defined in configuration file
dataMap -
Returns:
int - number of records inserted
Throws:
DataException - - exception due to SQL execution

insertBatch

int[] insertBatch(java.sql.Connection conn,
                  java.lang.String sqlId,
                  java.util.List<java.util.LinkedHashMap<java.lang.String,java.lang.String>> batchMapList,
                  java.lang.Integer batchCount)
                  throws DataException
This method is used to insert or update data in database in batches.

Parameters:
conn - - database connection
sqlId - - id for the SQL defined in configuration file
batchMapList - - list of mapped data to insert
batchCount - - no of records to be executed in batch at one time. Say if there are 100 records need to be inserted and batch count is 50 update will be executed 2 times.
Returns:
int[] - number of records inserted
Throws:
DataException - - exception due to SQL execution

read

java.lang.Object read(java.sql.Connection conn,
                      java.lang.String sqlId,
                      java.util.LinkedHashMap<java.lang.String,java.lang.String> whereMap)
                      throws DataException
This method is used to read data from database.

Parameters:
conn - - database connection
sqlId - - id for the SQL defined in configuration file
whereMap - - data which maps to where clause of the query
Returns:
2D String Array
Throws:
DataException - - exception due to SQL execution

read

java.lang.Object read(java.sql.Connection conn,
                      java.lang.String sqlId,
                      java.util.LinkedHashMap<java.lang.String,java.lang.String> whereMap,
                      java.lang.String outputType)
                      throws DataException
This method is used to read data from database.

Parameters:
conn - - database connection
sqlId - - id for the sql defined in configuration file
whereMap - - data which maps to where clause of the query
outputType - - type of expected output (JSON/2D Array)
Returns:
JSON String or 2D String Array(default)
Throws:
DataException - - exception due to sql execution

read

java.lang.Object read(java.sql.Connection conn,
                      java.lang.String sqlId,
                      java.util.LinkedHashMap<java.lang.String,java.lang.String> whereMap,
                      java.lang.String sortName,
                      java.lang.String sortOrder,
                      java.lang.String outputType)
                      throws DataException
This method is used to read data from database.

Parameters:
conn - - database connection
sqlId - - id for the SQL defined in configuration file
whereMap - - data which maps to where clause of the query
sortName - - column name in query which need to be sorted.
sortOrder - - order by in query(asc/desc)
outputType - - type of expected output (JSON/2D Array)
Returns:
JSON String or 2D String Array(default)
Throws:
DataException - - exception due to SQL execution

read

java.lang.Object read(java.sql.Connection conn,
                      java.lang.String sqlId,
                      java.util.LinkedHashMap<java.lang.String,java.lang.String> whereMap,
                      java.lang.String sortName,
                      java.lang.String sortOrder,
                      java.lang.String outputType,
                      java.lang.Integer startLimit,
                      java.lang.Integer endLimit)
                      throws DataException
This method is used to read data from database. It supports only MySQL with this release 1.0.1

Parameters:
conn - - database connection
sqlId - - id for the SQL defined in configuration file
whereMap - - data which maps to where clause of the query
sortName - - column name in query which need to be sorted.
sortOrder - - order by in query(asc/desc)
outputType - - type of expected output (JSON/2D Array)
startLimit - - starting row of the result to be retrieved(help in pagination)
endLimit - - ending row of the result to be retrieved(help in pagination)
Returns:
JSON String or 2D String Array(default)
Throws:
DataException - - exception due to SQL execution

update

int update(java.sql.Connection conn,
           java.lang.String sqlId,
           java.util.LinkedHashMap<java.lang.String,java.lang.String> setMap,
           java.util.LinkedHashMap<java.lang.String,java.lang.String> whereMap)
           throws DataException
This method is used to update data in database.

Parameters:
conn - - database connection
sqlId - - id for the SQL defined in configuration file
setMap - - data which maps set clause of the query
whereMap - - data which maps to where clause of the query
Returns:
int - number of records updated
Throws:
DataException - - exception due to SQL execution

delete

int delete(java.sql.Connection conn,
           java.lang.String sqlId,
           java.util.LinkedHashMap<java.lang.String,java.lang.String> whereMap)
           throws DataException
This method is used to delete data in database.

Parameters:
conn - - database connection
sqlId - - id for the SQL defined in configuration file
whereMap - - data which maps to where clause of the query
Returns:
int - number of records deleted
Throws:
DataException - - exception due to SQL execution

executeDDL

void executeDDL(java.sql.Connection conn,
                java.lang.String sqlId)
                throws DataException
This method is used to execute DDL queries.

Parameters:
conn - - database connection
sqlId - - id for the SQL defined in config file
Throws:
DataException