com.cs.software.api

Interface DataStoreIntf

All Superinterfaces:

FrameworkIntf, Serializable, TransportIntf

public interface DataStoreIntf
extends TransportIntf

Author:

Steve Crombie

Field Summary

Fields inherited from interface com.cs.software.api.FrameworkIntf

CATEGROY_ADAPTER, CATEGROY_APP, CATEGROY_DB_CON, CATEGROY_DB_POOL, CATEGROY_ENGINE, CATEGROY_MODULE, CATEGROY_POOL_MGR, CATEGROY_QUEUE, CATEGROY_THREAD_MGR, CATEGROY_WORKER, COMMAND_DEREGISTER_KEY, COMMAND_PAUSE, COMMAND_REGISTER_KEY, COMMAND_RESTART, COMMAND_SHUTDOWN, COMMAND_START, COMMAND_STOP, FLAG_FALSE, FLAG_TRUE, PARAM_JVM_STR, PARAM_JVMID_STR, PARAM_SERVERNAME_STR, PARAM_SERVICEACTIVE_STR, PARAM_SERVICECATAGORY_STR, PARAM_SERVICENAME_STR, PARAM_SERVICERUNNING_STR, TYPE_CLUSTER, TYPE_DISPLAY_STR, TYPE_EVENT, TYPE_JVM, TYPE_JVM_STR, TYPE_MAX, TYPE_SERVER, TYPE_SERVICE

Method Summary

Modifier and Type	Method and Description
void	applyTableData(int aType, Map<String,Object> aParameters)
void	applyTableData(int aType, Map<String,Object> aParameters, boolean aTransaction, boolean aByUseTag)
void	cleanUp()
int[]	doBatch(int aType, List<Map<String,Object>> aDataList)
int	doInsertSql()
int	doInsertSql(boolean aTransaction)
int	doInsertSql(boolean aTransaction, boolean aByUseTag)
int	doSql(String aSql, List<Object> aParams)
int	doUpdateSql()
int	doUpdateSql(boolean aTransaction)
int	doUpdateSql(boolean aTransaction, boolean aByUseTag)
DataStoreParamIntf	getDataStoreParam(String aFieldName)
Long	getIdentityLongValue()
Object	getIdentityValue()
List<DataStoreParamIntf>	getParameterList()
Map<String,DataStoreParamIntf>	getParameterMap()
String	getPoolName()
String	getPrimaryKeyFieldName()
String	getTableName()
void	logError(MessageIntf aMsg, Map<String,Object> anErrorParams, String anErrorMsg, int anErrorCode)
void	resetIdentityValue()
void	saveStats(Map<String,Object> aStatsData)
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	setPoolName(String aPoolName)
void	setTableName(String aTableName)
void	setUse(String aFieldName, boolean aFlag)

Methods inherited from interface com.cs.software.api.TransportIntf

addMsg, addTransport, close, getMsg, getMsgNoWait, getTransportName, getUserHashCode, init, initTransport, isListener, isReader, isWriter, processMsgListner, readMsg, readMsg, removeTransport, setListener, setReader, setWriter, size

Methods inherited from interface com.cs.software.api.FrameworkIntf

addInProcess, addTotalErrorNumber, addTotalMsgNumber, addTotalProcessed, deRegister, doEventMessage, doMessage, getInProcess, getJvmId, getJvmService, getName, getStats, getTotalErrorNumber, getTotalMsgNumber, getTotalProcessed, initMessage, isActive, isRunning, register, resetTotals, setActive, setRunning, subtractInProcess

Method Detail

logError

void logError(MessageIntf aMsg,
              Map<String,Object> anErrorParams,
              String anErrorMsg,
              int anErrorCode)
       throws Exception

Throws:

Exception

saveStats

void saveStats(Map<String,Object> aStatsData)
        throws Exception

Throws:

Exception

getTableName

String getTableName()

setTableName

void setTableName(String aTableName)

getPoolName

String getPoolName()

setPoolName

void setPoolName(String aPoolName)

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)

setUse

void setUse(String aFieldName,
            boolean aFlag)

getParameterMap

Map<String,DataStoreParamIntf> getParameterMap()

getParameterList

List<DataStoreParamIntf> getParameterList()

getDataStoreParam

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

doInsertSql

int doInsertSql()
         throws Exception

Throws:

Exception

doInsertSql

int doInsertSql(boolean aTransaction)
         throws Exception

Throws:

Exception

doInsertSql

int doInsertSql(boolean aTransaction,
                boolean aByUseTag)
         throws Exception

Throws:

Exception

doUpdateSql

int doUpdateSql()
         throws Exception

Throws:

Exception

doUpdateSql

int doUpdateSql(boolean aTransaction)
         throws Exception

Throws:

Exception

doUpdateSql

int doUpdateSql(boolean aTransaction,
                boolean aByUseTag)
         throws Exception

Throws:

Exception

doSql

int doSql(String aSql,
          List<Object> aParams)
   throws Exception

Throws:

Exception

applyTableData

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

Throws:

Exception

applyTableData

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

Throws:

Exception

doBatch

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

Throws:

Exception

cleanUp

void cleanUp()