com.cs.software.engine.datastore

Interface DataStoreTableIntf

All Known Implementing Classes:

TableAccess

public interface 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
static int	TABLE_DELETE
static int	TABLE_INSERT
static int	TABLE_UPDATE
static int	TABLE_VIEW_BY_KEY

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

Field Detail

TABLE_INSERT

static final int TABLE_INSERT

See Also:

Constant Field Values

TABLE_UPDATE

static final int TABLE_UPDATE

See Also:

Constant Field Values

TABLE_DELETE

static final int TABLE_DELETE

See Also:

Constant Field Values

TABLE_VIEW_BY_KEY

static final int TABLE_VIEW_BY_KEY

See Also:

Constant Field Values

Method Detail

createFieldMap

void createFieldMap(Map<String,String> aNewFieldMap)

getIdentityValue

Object getIdentityValue()

getIdentityLongValue

Long getIdentityLongValue()

setIdentityValue

void setIdentityValue(Object aValue)

resetIdentityValue

void resetIdentityValue()

getPrimaryKeyFieldName

String getPrimaryKeyFieldName()

setIdentityField

void setIdentityField(String aDBField,
                      String aSequence)

setFieldsUse

void setFieldsUse(boolean aFlag)

getPoolName

String getPoolName()

getTableName

String getTableName()

getViewName

String getViewName()

getParameterMap

Map<String,DataStoreParamIntf> getParameterMap()

getParameterList

List<DataStoreParamIntf> getParameterList()

setUse

void setUse(String aFieldName,
            boolean aFlag)

getDBParam

DataStoreParamIntf getDBParam(String aFieldName)

setObject

void setObject(String aFieldName,
               Object aData)

setObject

void setObject(String aFieldName,
               String aData)

setObjectList

void setObjectList(String aFieldName,
                   Object aData)

setObjectList

void setObjectList(String aFieldName,
                   String aData)

getViewSql

String getViewSql()

getInsertSql

String getInsertSql(boolean aByUseTag)

getUpdateSql

String getUpdateSql(boolean aByUseTag,
                    boolean sqlServer)

getDeleteSql

String getDeleteSql()

doQuery

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

Throws:

Exception

doInsertSql

int doInsertSql(DatabaseQuery aDatabaseAdapter)
         throws Exception

Throws:

Exception

doInsertSql

int doInsertSql(DatabaseQuery aDatabaseAdapter,
                boolean aTransaction)
         throws Exception

Throws:

Exception

doInsertSql

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

Throws:

Exception

doUpdateSql

int doUpdateSql(DatabaseQuery aDatabaseAdapter)
         throws Exception

Throws:

Exception

doUpdateSql

int doUpdateSql(DatabaseQuery aDatabaseAdapter,
                boolean aTransaction)
         throws Exception

Throws:

Exception

doUpdateSql

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

Throws:

Exception

doSql

int doSql(DatabaseQuery aDatabaseAdapter,
          String aSql)
   throws Exception

Throws:

Exception

applyTableData

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

Throws:

Exception

applyTableData

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

Throws:

Exception

setFieldFormat

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

setFieldFormat

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

getFieldStr

String getFieldStr(DatabaseQuery aDatabaseAdapter,
                   String aColName)

getXmlData

String getXmlData(DatabaseQuery aDatabaseAdapter,
                  String aTag)

doBatch

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

Throws:

Exception

cleanUp

void cleanUp()