com.cs.software.engine.datastore.database

Class TableAccess

java.lang.Object

com.cs.software.engine.datastore.database.TableAccess

All Implemented Interfaces:

DataStoreTableIntf

public class TableAccess
extends Object
implements DataStoreTableIntf

TableAccess manages access to a single table. Methods are available to insert, update, delete, and view rows.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<DataStoreParamIntf>	batchFields
protected DBTableUtil	dbTableUtil
protected Map<String,DataStoreParamIntf>	fieldMap
protected List<DataStoreParamIntf>	fields

Fields inherited from interface com.cs.software.engine.datastore.DataStoreTableIntf

TABLE_DELETE, TABLE_INSERT, TABLE_UPDATE, TABLE_VIEW_BY_KEY

Constructor Summary

Constructors

Constructor and Description
TableAccess(String aPoolName, String aTableName)

Method Summary

Modifier and Type	Method and Description
void	applyTableData(DatabaseQuery aDatabaseAdapter, int aType, Map<String,Object> aParameters)
void	applyTableData(DatabaseQuery aDatabaseAdapter, int aType, Map<String,Object> aParameters, boolean aTransaction, boolean aByUseTag)
void	cleanUp()
void	createFieldMap(Map<String,String> aNewFieldMap) This function will replace the original key for column mappings with a new key value.
int[]	doBatch(DatabaseQuery aDatabaseAdapter, int aType, List<Map<String,Object>> aDataList)
int	doInsertSql(DatabaseQuery aDatabaseAdapter)
int	doInsertSql(DatabaseQuery aDatabaseAdapter, boolean aTransaction)
int	doInsertSql(DatabaseQuery aDatabaseAdapter, boolean aTransaction, boolean aByUseTag)
void	doQuery(String aRefName, String aSqlStr, DatabaseQuery aDatabaseAdapter)
int	doSql(DatabaseQuery aDatabaseAdapter, String aSql)
int	doUpdateSql(DatabaseQuery aDatabaseAdapter)
int	doUpdateSql(DatabaseQuery aDatabaseAdapter, boolean aTransaction)
int	doUpdateSql(DatabaseQuery aDatabaseAdapter, boolean aTransaction, boolean aByUseTag)
DataStoreParamIntf	getDBParam(String aFieldName)
String	getDeleteSql()
String	getFieldStr(DatabaseQuery aDatabaseAdapter, String aColName)
Long	getIdentityLongValue()
Object	getIdentityValue()
String	getInsertSql(boolean aByUseTag)
List<DataStoreParamIntf>	getParameterList()
Map<String,DataStoreParamIntf>	getParameterMap()
String	getPoolName()
String	getPrimaryKeyFieldName()
String	getTableName()
String	getUpdateSql(boolean aByUseTag, boolean sqlServer)
String	getViewName()
String	getViewSql()
String	getXmlData(DatabaseQuery aDatabaseAdapter, String aTag)
void	resetIdentityValue()
void	setFieldFormat(DatabaseQuery aDatabaseAdapter, int aCol, Format aFormat)
void	setFieldFormat(DatabaseQuery aDatabaseAdapter, String aFieldName, Format aFormat)
void	setFieldsUse(boolean aFlag)
void	setIdentityField(String aDBField, String aSequence) This routine in used to set the Identity Field and Sequence Used for oracle.
void	setIdentityValue(Object aValue)
void	setObject(String aFieldName, Object aData)
void	setObject(String aFieldName, String aData)
void	setObjectList(String aFieldName, Object aData)
void	setObjectList(String aFieldName, String aData)
void	setUse(String aFieldName, boolean aFlag)

Methods inherited from class java.lang.Object

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

Field Detail

dbTableUtil

protected DBTableUtil dbTableUtil

fields

protected List<DataStoreParamIntf> fields

batchFields

protected List<DataStoreParamIntf> batchFields

fieldMap

protected Map<String,DataStoreParamIntf> fieldMap

Constructor Detail

TableAccess

public TableAccess(String aPoolName,
                   String aTableName)

Method Detail

createFieldMap

public void createFieldMap(Map<String,String> aNewFieldMap)

This function will replace the original key for column mappings with a new key value.

Specified by:

createFieldMap in interface DataStoreTableIntf

getIdentityValue

public Object getIdentityValue()

Specified by:

getIdentityValue in interface DataStoreTableIntf

getIdentityLongValue

public Long getIdentityLongValue()

Specified by:

getIdentityLongValue in interface DataStoreTableIntf

setIdentityValue

public void setIdentityValue(Object aValue)

Specified by:

setIdentityValue in interface DataStoreTableIntf

resetIdentityValue

public void resetIdentityValue()

Specified by:

resetIdentityValue in interface DataStoreTableIntf

getPrimaryKeyFieldName

public String getPrimaryKeyFieldName()

Specified by:

getPrimaryKeyFieldName in interface DataStoreTableIntf

setIdentityField

public void setIdentityField(String aDBField,
                             String aSequence)

This routine in used to set the Identity Field and Sequence Used for oracle.

Specified by:

setIdentityField in interface DataStoreTableIntf

setFieldsUse

public void setFieldsUse(boolean aFlag)

Specified by:

setFieldsUse in interface DataStoreTableIntf

getPoolName

public String getPoolName()

Specified by:

getPoolName in interface DataStoreTableIntf

getTableName

public String getTableName()

Specified by:

getTableName in interface DataStoreTableIntf

getViewName

public String getViewName()

Specified by:

getViewName in interface DataStoreTableIntf

getParameterMap

public Map<String,DataStoreParamIntf> getParameterMap()

Specified by:

getParameterMap in interface DataStoreTableIntf

getParameterList

public List<DataStoreParamIntf> getParameterList()

Specified by:

getParameterList in interface DataStoreTableIntf

setUse

public void setUse(String aFieldName,
                   boolean aFlag)

Specified by:

setUse in interface DataStoreTableIntf

getDBParam

public DataStoreParamIntf getDBParam(String aFieldName)

Specified by:

getDBParam in interface DataStoreTableIntf

setObject

public void setObject(String aFieldName,
                      Object aData)

Specified by:

setObject in interface DataStoreTableIntf

setObject

public void setObject(String aFieldName,
                      String aData)

Specified by:

setObject in interface DataStoreTableIntf

setObjectList

public void setObjectList(String aFieldName,
                          Object aData)

Specified by:

setObjectList in interface DataStoreTableIntf

setObjectList

public void setObjectList(String aFieldName,
                          String aData)

Specified by:

setObjectList in interface DataStoreTableIntf

getViewSql

public String getViewSql()

Specified by:

getViewSql in interface DataStoreTableIntf

getInsertSql

public String getInsertSql(boolean aByUseTag)

Specified by:

getInsertSql in interface DataStoreTableIntf

getUpdateSql

public String getUpdateSql(boolean aByUseTag,
                           boolean sqlServer)

Specified by:

getUpdateSql in interface DataStoreTableIntf

getDeleteSql

public String getDeleteSql()

Specified by:

getDeleteSql in interface DataStoreTableIntf

doQuery

public void doQuery(String aRefName,
                    String aSqlStr,
                    DatabaseQuery aDatabaseAdapter)
             throws Exception

Specified by:

doQuery in interface DataStoreTableIntf

Throws:

Exception

doInsertSql

public int doInsertSql(DatabaseQuery aDatabaseAdapter)
                throws Exception

Specified by:

doInsertSql in interface DataStoreTableIntf

Throws:

Exception

doInsertSql

public int doInsertSql(DatabaseQuery aDatabaseAdapter,
                       boolean aTransaction)
                throws Exception

Specified by:

doInsertSql in interface DataStoreTableIntf

Throws:

Exception

doInsertSql

public int doInsertSql(DatabaseQuery aDatabaseAdapter,
                       boolean aTransaction,
                       boolean aByUseTag)
                throws Exception

Specified by:

doInsertSql in interface DataStoreTableIntf

Throws:

Exception

doUpdateSql

public int doUpdateSql(DatabaseQuery aDatabaseAdapter)
                throws Exception

Specified by:

doUpdateSql in interface DataStoreTableIntf

Throws:

Exception

doUpdateSql

public int doUpdateSql(DatabaseQuery aDatabaseAdapter,
                       boolean aTransaction)
                throws Exception

Specified by:

doUpdateSql in interface DataStoreTableIntf

Throws:

Exception

doUpdateSql

public int doUpdateSql(DatabaseQuery aDatabaseAdapter,
                       boolean aTransaction,
                       boolean aByUseTag)
                throws Exception

Specified by:

doUpdateSql in interface DataStoreTableIntf

Throws:

Exception

doSql

public int doSql(DatabaseQuery aDatabaseAdapter,
                 String aSql)
          throws Exception

Specified by:

doSql in interface DataStoreTableIntf

Throws:

Exception

applyTableData

public void applyTableData(DatabaseQuery aDatabaseAdapter,
                           int aType,
                           Map<String,Object> aParameters)
                    throws Exception

Specified by:

applyTableData in interface DataStoreTableIntf

Throws:

Exception

applyTableData

public void applyTableData(DatabaseQuery aDatabaseAdapter,
                           int aType,
                           Map<String,Object> aParameters,
                           boolean aTransaction,
                           boolean aByUseTag)
                    throws Exception

Specified by:

applyTableData in interface DataStoreTableIntf

Throws:

Exception

setFieldFormat

public void setFieldFormat(DatabaseQuery aDatabaseAdapter,
                           String aFieldName,
                           Format aFormat)

Specified by:

setFieldFormat in interface DataStoreTableIntf

setFieldFormat

public void setFieldFormat(DatabaseQuery aDatabaseAdapter,
                           int aCol,
                           Format aFormat)

Specified by:

setFieldFormat in interface DataStoreTableIntf

getFieldStr

public String getFieldStr(DatabaseQuery aDatabaseAdapter,
                          String aColName)

Specified by:

getFieldStr in interface DataStoreTableIntf

getXmlData

public String getXmlData(DatabaseQuery aDatabaseAdapter,
                         String aTag)

Specified by:

getXmlData in interface DataStoreTableIntf

doBatch

public int[] doBatch(DatabaseQuery aDatabaseAdapter,
                     int aType,
                     List<Map<String,Object>> aDataList)
              throws Exception

Specified by:

doBatch in interface DataStoreTableIntf

Throws:

Exception

cleanUp

public void cleanUp()

Specified by:

cleanUp in interface DataStoreTableIntf