com.aspc.commander.dbobj

Class DBCommand

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.commander.dbobj.DBCommand

All Implemented Interfaces:

SecondaryCacheGroup

public class DBCommand
extends DBObject

The DBCommand defines an OSQL command.

data model
THREAD MODE: MIXED, SINGLE-THREADED when called from MutableDataSource else MULTI-THREADED

Since:

4 December 2003

Author:

Nigel Leck

Nested Class Summary

Nested classes/interfaces inherited from class com.aspc.DBObj.DBObject

DBObject.DenormalizeAction

Field Summary

Fields

Modifier and Type	Field and Description
static GlobalId	DBCLASS_GID The DBCommand defines an OSQL command.
static java.lang.String	DBCLASS_NAME The DBCommand defines an OSQL command.
static java.lang.String	LIST_ADMIN_USERS_RESET DBCommand: ADMIN_USERS_RESET
static java.lang.String	LIST_BEST_ROW_IDENTIFIER DBCommand: BEST_ROW_IDENTIFIER
static java.lang.String	LIST_CACHE DBCommand: CACHE
static java.lang.String	LIST_CATALOGS DBCommand: CATALOGS
static java.lang.String	LIST_COLUMN_PRIVILEGES DBCommand: COLUMN_PRIVILEGES
static java.lang.String	LIST_COLUMNS DBCommand: COLUMNS
static java.lang.String	LIST_COMMIT DBCommand: COMMIT
static java.lang.String	LIST_COPY DBCommand: COPY
static java.lang.String	LIST_CREATE_COMPONENT DBCommand: CREATE_COMPONENT
static java.lang.String	LIST_CREATE_EMAIL DBCommand: CREATE_EMAIL
static java.lang.String	LIST_CROSS_REFERENCE DBCommand: CROSS_REFERENCE
static java.lang.String	LIST_CURSOR DBCommand: CURSOR
static java.lang.String	LIST_DELETE DBCommand: DELETE
static java.lang.String	LIST_DISCOVER DBCommand: DISCOVER
static java.lang.String	LIST_DROID DBCommand: DROID
static java.lang.String	LIST_EDITION DBCommand: EDITION
static java.lang.String	LIST_EMAIL_SCREEN DBCommand: EMAIL_SCREEN
static java.lang.String	LIST_EXPORTED_KEYS DBCommand: EXPORTED_KEYS
static java.lang.String	LIST_EXTRACT_WORDS DBCommand: EXTRACT_WORDS
static java.lang.String	LIST_FILE DBCommand: FILE
static java.lang.String	LIST_FILE_SYNC DBCommand: FILE_SYNC
static java.lang.String	LIST_FILE_SYNC_MANUAL DBCommand: FILE_SYNC_MANUAL
static java.lang.String	LIST_FORGOTPASSWD DBCommand: FORGOTPASSWD
static java.lang.String	LIST_HEALTH DBCommand: HEALTH
static java.lang.String	LIST_HELP DBCommand: HELP
static java.lang.String	LIST_IMPORT DBCommand: IMPORT
static java.lang.String	LIST_IMPORTED_KEYS DBCommand: IMPORTED_KEYS
static java.lang.String	LIST_INDEX_INFO DBCommand: INDEX_INFO
static java.lang.String	LIST_INSERT DBCommand: INSERT
static java.lang.String	LIST_JOB DBCommand: JOB
static java.lang.String	LIST_LOG DBCommand: LOG
static java.lang.String	LIST_LOG_FILELOCATION_ERROR DBCommand: LOG_FILELOCATION_ERROR
static java.lang.String	LIST_LOGICAL_LOCK DBCommand: LOGICAL_LOCK
static java.lang.String	LIST_MAGIC DBCommand: MAGIC
static java.lang.String	LIST_MAP DBCommand: MAP
static java.lang.String	LIST_MEMORY DBCommand: MEMORY
static java.lang.String	LIST_MERGE DBCommand: MERGE
static java.lang.String	LIST_MESSAGE DBCommand: MESSAGE
static java.lang.String	LIST_MOVE_COMPONENT DBCommand: MOVE_COMPONENT
static java.lang.String	LIST_NOTIFY DBCommand: NOTIFY
static java.lang.String	LIST_PASSWD DBCommand: PASSWD
static java.lang.String	LIST_PREFERENCE DBCommand: PREFERENCE
static java.lang.String	LIST_PRIMARY_KEYS DBCommand: PRIMARY_KEYS
static java.lang.String	LIST_PROCEDURE_COLUMNS DBCommand: PROCEDURE_COLUMNS
static java.lang.String	LIST_PROCEDURES DBCommand: PROCEDURES
static java.lang.String	LIST_PROCESS DBCommand: PROCESS
static java.lang.String	LIST_RAISE_EVENT DBCommand: RAISE_EVENT
static java.lang.String	LIST_RECORDVALIDATE DBCommand: RECORDVALIDATE
static java.lang.String	LIST_RELOAD DBCommand: RELOAD
static java.lang.String	LIST_REPORT DBCommand: REPORT
static java.lang.String	LIST_REST DBCommand: REST
static java.lang.String	LIST_RETRIEVE_LOG DBCommand: RETRIEVE_LOG
static java.lang.String	LIST_REVERSE DBCommand: REVERSE
static java.lang.String	LIST_ROLLBACK DBCommand: ROLLBACK
static java.lang.String	LIST_SAVEPOINT DBCommand: SAVEPOINT
static java.lang.String	LIST_SCHEMAS DBCommand: SCHEMAS
static java.lang.String	LIST_SELECT DBCommand: SELECT
static java.lang.String	LIST_SEND_EMAIL DBCommand: SEND_EMAIL
static java.lang.String	LIST_SEQUENCE DBCommand: SEQUENCE
static java.lang.String	LIST_SHUTDOWN DBCommand: SHUTDOWN
static java.lang.String	LIST_SITE_SPIDER DBCommand: SITE_SPIDER
static java.lang.String	LIST_SLEEP DBCommand: SLEEP
static java.lang.String	LIST_SNAP_TO DBCommand: SNAP_TO
static java.lang.String	LIST_STATSPART DBCommand: STATSPART
static java.lang.String	LIST_STORE_WORDS DBCommand: STORE_WORDS
static java.lang.String	LIST_STORED_RESULT DBCommand: STORED_RESULT
static java.lang.String	LIST_SUPER_TABLES DBCommand: SUPER_TABLES
static java.lang.String	LIST_SUPER_TYPES DBCommand: SUPER_TYPES
static java.lang.String	LIST_SYNC DBCommand: SYNC
static java.lang.String	LIST_SYSTEM_STATS DBCommand: SYSTEM_STATS
static java.lang.String	LIST_TABLE_PRIVILEGES DBCommand: TABLE_PRIVILEGES
static java.lang.String	LIST_TABLES DBCommand: TABLES
static java.lang.String	LIST_TASK DBCommand: TASK
static java.lang.String	LIST_TRANSACTION DBCommand: TRANSACTION
static java.lang.String	LIST_TRANSACTION_LOG DBCommand: TRANSACTION_LOG
static java.lang.String	LIST_UPDATE DBCommand: UPDATE
static java.lang.String	LIST_VALIDATE DBCommand: VALIDATE
static java.lang.String	LIST_VERSION_COLUMNS DBCommand: VERSION_COLUMNS

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
DBCommand(DBClass def, DataSource dataSource) Std.

Method Summary

Modifier and Type	Method and Description
int	checkMaxProcesses()
double	checkProcessWeight()
static DBCommand	create(MutableDataSource mds) Make a new instance of this class.
protected void	eventDataLoaded() When the underlying DBData is changed/ loaded.
void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) update dependent fields.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
protected void	extSetValue(DBField field, java.lang.Object value, FldParams params) We prevent some values from being set by a user.
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for a particular field.
static DBCommand	find(java.lang.String sql, DataSource ds, java.util.AbstractMap cache) The command for this sql
DBQueue	findFarmQueue(java.lang.String... args) The queue that we will farm requests into.
static DBCommand	findKey(DataSource ds, java.lang.String key) Find the target for this class by the primary key
long	getAllocatedTimeToLog(java.lang.String... args)
java.lang.String	getCode(java.lang.String... args)
java.lang.reflect.Constructor	getConstructor()
java.lang.String	getDescription(java.lang.String... args)
java.lang.String	getFarmJavaClassName(java.lang.String... args)
DBQueue	getFarmQueue(java.lang.String... args)
java.lang.String	getFarmRegularExpression(java.lang.String... args)
java.lang.String	getFarmTimeOut(java.lang.String... args)
java.lang.String	getJavaClassName(java.lang.String... args)
int	getMaxProcesses(java.lang.String... args)
Pattern	getPattern()
double	getProcessWeight(java.lang.String... args)
java.lang.String	getSyntax(java.lang.String... args)
java.lang.String	getUsage(java.lang.String... args)
boolean	hasFullAccess(java.lang.String... args)
boolean	isFarmable(java.lang.String... args)
boolean	isFinalFg(java.lang.String... args)
boolean	isSecuredData(java.lang.String... args)
static java.lang.String	makeCode(java.lang.String sql)
java.util.regex.Pattern	makeFarmPattern() make the farm regular expression
static DBQuery<DBCommand>	makeQuery(DataSource ds) Make a new QUERY for this class.
DBCommand	setAllocatedTimeToLog(long value, java.lang.String... args)
DBCommand	setCode(java.lang.String value, java.lang.String... args)
DBCommand	setDescription(java.lang.String value, java.lang.String... args)
DBCommand	setFarmable(boolean value, java.lang.String... args)
DBCommand	setFarmJavaClassName(java.lang.String value, java.lang.String... args)
DBCommand	setFarmQueue(com.aspc.dal.job.DBQueue value, java.lang.String... args)
DBCommand	setFarmRegularExpression(java.lang.String value, java.lang.String... args)
DBCommand	setFarmTimeOut(java.lang.String value, java.lang.String... args)
DBCommand	setFinalFg(boolean value, java.lang.String... args)
DBCommand	setJavaClassName(java.lang.String value, java.lang.String... args)
DBCommand	setMaxProcesses(int value, java.lang.String... args)
DBCommand	setProcessWeight(double value, java.lang.String... args)
DBCommand	setSecuredData(boolean value, java.lang.String... args)
DBCommand	setSyntax(java.lang.String value, java.lang.String... args)
DBCommand	setUsage(java.lang.String value, java.lang.String... args)

Methods inherited from class com.aspc.DBObj.DBObject

addReloadEventListener, archiveCheck, autoEnterCreate, calculateValue, calculateValue, calculateValue, callingRestoreByJournal, changeThreadMode, checkCreateAccess, checkDelete, checkDeleteAccess, checkModifyAccess, checkModifyAccess, checkReadAccess, clearCache, copy, copyFields, copyIncludeField, copyInwardLinks, delete, denormalizedResult, displayLogName, displayName, displayValue, doSearch, dump, equals, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetDerivedGlobalKey, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidate, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extUndelete, extValidateDelete, extValidateRecord, fetchLinkHolder, findGlobalKey, findGlobalKey, findGlobalKey, findGlobalKey, findLinkedObject, findLinkedObject, findLinkedObject, findRawData, fireEventDataLoaded, fixUp, forceLockedTransaction, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getChangedFieldInfo, getChangedFields, getDate, getDate, getDate, getDate, getDate, getDefaultValue, getDisableOnChangeEvent, getDouble, getDouble, getDouble, getDouble, getDouble, getFieldDouble, getFieldInt, getFieldLong, getFieldString, getFormattedString, getFormattedString, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getInt, getInt, getInt, getInt, getInt, getInt, getInwardLinkage, getKeyString, getKeyValue, getLinkedObject, getLinkedObject, getLinkedObject, getLinkedObjectByKey, getLinkedRowId, getLinkedRowId, getLinkedRowIdByData, getLinkHolder, getLockedTransaction, getLong, getLong, getLong, getLong, getLong, getLong, getMutableArrayValue, getMutableArrayValue, getOriginalKey, getOriginalValue, getOriginalValue, getProcessedValue, getPureValue, getRawData, getRawValue, getRawValue, getRowId, getRowKey, getSecondaryCacheGroupKey, getSrcLayerID, getString, getString, getString, getString, getString, getString, getValue, getValue, getValue, getValue, hasAutoChanged, hasAutoChanged, hasChanged, hasChangedByUser, hasChangedByUserField, hasChangedByUserField, hasFieldChanged, hasFieldChanged, hashCode, hasStoredResult, iCheckDeleteAccess, iCheckModifyAccess, iCheckReadAccess, iGetDenormalizedMap, iGetRawValue, iPlaceDenormalizedResult, iPostSaveOrDeleteRecord, iPreSaveOrDeleteRecord, iPreValidate, iRaiseEvents, iSaveOrDeleteRecord, isBrokenLink, isBrokenLink, isChanged, isDataCacheKnownToBeDirty, isDeleted, isEmpty, iSetValue, isForceReindex, isKeyWordField, isMandatory, isNew, isNull, isNull, isOnChange, isReindex, iValidateRecord, lastTouched, makeArchiveDataLoader, makeClone, makeDataLoader, makeDenormalizedDoc, makeLinkedArray, makeModifyAccessException, makeSearchPlan, makeWriteProvider, manualDenormalizeOnSave, markSavePoint, optLockedTransaction, registerWatchedObject, reindex, releaseDenormalized, removeReloadEventListener, restoreByJournal, rollbackTo, setBoolean, setBoolean, setBoolean, setBoolean, setDisableOnChangeEvent, setDouble, setDouble, setInt, setInt, setLong, setLong, setRawData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, touch, undelete, validateField, validateRecord, validateSubType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

The DBCommand defines an OSQL command.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

The DBCommand defines an OSQL command.

LIST_ADMIN_USERS_RESET

public static final java.lang.String LIST_ADMIN_USERS_RESET

DBCommand: ADMIN_USERS_RESET

See Also:

Constant Field Values

LIST_BEST_ROW_IDENTIFIER

public static final java.lang.String LIST_BEST_ROW_IDENTIFIER

DBCommand: BEST_ROW_IDENTIFIER

See Also:

Constant Field Values

LIST_CACHE

public static final java.lang.String LIST_CACHE

DBCommand: CACHE

See Also:

Constant Field Values

LIST_CATALOGS

public static final java.lang.String LIST_CATALOGS

DBCommand: CATALOGS

See Also:

Constant Field Values

LIST_COLUMN_PRIVILEGES

public static final java.lang.String LIST_COLUMN_PRIVILEGES

DBCommand: COLUMN_PRIVILEGES

See Also:

Constant Field Values

LIST_COLUMNS

public static final java.lang.String LIST_COLUMNS

DBCommand: COLUMNS

See Also:

Constant Field Values

LIST_COMMIT

public static final java.lang.String LIST_COMMIT

DBCommand: COMMIT

See Also:

Constant Field Values

LIST_COPY

public static final java.lang.String LIST_COPY

DBCommand: COPY

See Also:

Constant Field Values

LIST_CREATE_COMPONENT

public static final java.lang.String LIST_CREATE_COMPONENT

DBCommand: CREATE_COMPONENT

See Also:

Constant Field Values

LIST_CREATE_EMAIL

public static final java.lang.String LIST_CREATE_EMAIL

DBCommand: CREATE_EMAIL

See Also:

Constant Field Values

LIST_CROSS_REFERENCE

public static final java.lang.String LIST_CROSS_REFERENCE

DBCommand: CROSS_REFERENCE

See Also:

Constant Field Values

LIST_CURSOR

public static final java.lang.String LIST_CURSOR

DBCommand: CURSOR

See Also:

Constant Field Values

LIST_DELETE

public static final java.lang.String LIST_DELETE

DBCommand: DELETE

See Also:

Constant Field Values

LIST_DISCOVER

public static final java.lang.String LIST_DISCOVER

DBCommand: DISCOVER

See Also:

Constant Field Values

LIST_DROID

public static final java.lang.String LIST_DROID

DBCommand: DROID

See Also:

Constant Field Values

LIST_EDITION

public static final java.lang.String LIST_EDITION

DBCommand: EDITION

See Also:

Constant Field Values

LIST_EMAIL_SCREEN

public static final java.lang.String LIST_EMAIL_SCREEN

DBCommand: EMAIL_SCREEN

See Also:

Constant Field Values

LIST_EXPORTED_KEYS

public static final java.lang.String LIST_EXPORTED_KEYS

DBCommand: EXPORTED_KEYS

See Also:

Constant Field Values

LIST_EXTRACT_WORDS

public static final java.lang.String LIST_EXTRACT_WORDS

DBCommand: EXTRACT_WORDS

See Also:

Constant Field Values

LIST_FILE

public static final java.lang.String LIST_FILE

DBCommand: FILE

See Also:

Constant Field Values

LIST_FILE_SYNC

public static final java.lang.String LIST_FILE_SYNC

DBCommand: FILE_SYNC

See Also:

Constant Field Values

LIST_FILE_SYNC_MANUAL

public static final java.lang.String LIST_FILE_SYNC_MANUAL

DBCommand: FILE_SYNC_MANUAL

See Also:

Constant Field Values

LIST_FORGOTPASSWD

public static final java.lang.String LIST_FORGOTPASSWD

DBCommand: FORGOTPASSWD

See Also:

Constant Field Values

LIST_HEALTH

public static final java.lang.String LIST_HEALTH

DBCommand: HEALTH

See Also:

Constant Field Values

LIST_HELP

public static final java.lang.String LIST_HELP

DBCommand: HELP

See Also:

Constant Field Values

LIST_IMPORT

public static final java.lang.String LIST_IMPORT

DBCommand: IMPORT

See Also:

Constant Field Values

LIST_IMPORTED_KEYS

public static final java.lang.String LIST_IMPORTED_KEYS

DBCommand: IMPORTED_KEYS

See Also:

Constant Field Values

LIST_INDEX_INFO

public static final java.lang.String LIST_INDEX_INFO

DBCommand: INDEX_INFO

See Also:

Constant Field Values

LIST_INSERT

public static final java.lang.String LIST_INSERT

DBCommand: INSERT

See Also:

Constant Field Values

LIST_JOB

public static final java.lang.String LIST_JOB

DBCommand: JOB

See Also:

Constant Field Values

LIST_LOG

public static final java.lang.String LIST_LOG

DBCommand: LOG

See Also:

Constant Field Values

LIST_LOG_FILELOCATION_ERROR

public static final java.lang.String LIST_LOG_FILELOCATION_ERROR

DBCommand: LOG_FILELOCATION_ERROR

See Also:

Constant Field Values

LIST_LOGICAL_LOCK

public static final java.lang.String LIST_LOGICAL_LOCK

DBCommand: LOGICAL_LOCK

See Also:

Constant Field Values

LIST_MAGIC

public static final java.lang.String LIST_MAGIC

DBCommand: MAGIC

See Also:

Constant Field Values

LIST_MAP

public static final java.lang.String LIST_MAP

DBCommand: MAP

See Also:

Constant Field Values

LIST_MEMORY

public static final java.lang.String LIST_MEMORY

DBCommand: MEMORY

See Also:

Constant Field Values

LIST_MERGE

public static final java.lang.String LIST_MERGE

DBCommand: MERGE

See Also:

Constant Field Values

LIST_MESSAGE

public static final java.lang.String LIST_MESSAGE

DBCommand: MESSAGE

See Also:

Constant Field Values

LIST_MOVE_COMPONENT

public static final java.lang.String LIST_MOVE_COMPONENT

DBCommand: MOVE_COMPONENT

See Also:

Constant Field Values

LIST_NOTIFY

public static final java.lang.String LIST_NOTIFY

DBCommand: NOTIFY

See Also:

Constant Field Values

LIST_PASSWD

public static final java.lang.String LIST_PASSWD

DBCommand: PASSWD

See Also:

Constant Field Values

LIST_PREFERENCE

public static final java.lang.String LIST_PREFERENCE

DBCommand: PREFERENCE

See Also:

Constant Field Values

LIST_PRIMARY_KEYS

public static final java.lang.String LIST_PRIMARY_KEYS

DBCommand: PRIMARY_KEYS

See Also:

Constant Field Values

LIST_PROCEDURE_COLUMNS

public static final java.lang.String LIST_PROCEDURE_COLUMNS

DBCommand: PROCEDURE_COLUMNS

See Also:

Constant Field Values

LIST_PROCEDURES

public static final java.lang.String LIST_PROCEDURES

DBCommand: PROCEDURES

See Also:

Constant Field Values

LIST_PROCESS

public static final java.lang.String LIST_PROCESS

DBCommand: PROCESS

See Also:

Constant Field Values

LIST_RAISE_EVENT

public static final java.lang.String LIST_RAISE_EVENT

DBCommand: RAISE_EVENT

See Also:

Constant Field Values

LIST_RECORDVALIDATE

public static final java.lang.String LIST_RECORDVALIDATE

DBCommand: RECORDVALIDATE

See Also:

Constant Field Values

LIST_RELOAD

public static final java.lang.String LIST_RELOAD

DBCommand: RELOAD

See Also:

Constant Field Values

LIST_REPORT

public static final java.lang.String LIST_REPORT

DBCommand: REPORT

See Also:

Constant Field Values

LIST_REST

public static final java.lang.String LIST_REST

DBCommand: REST

See Also:

Constant Field Values

LIST_RETRIEVE_LOG

public static final java.lang.String LIST_RETRIEVE_LOG

DBCommand: RETRIEVE_LOG

See Also:

Constant Field Values

LIST_REVERSE

public static final java.lang.String LIST_REVERSE

DBCommand: REVERSE

See Also:

Constant Field Values

LIST_ROLLBACK

public static final java.lang.String LIST_ROLLBACK

DBCommand: ROLLBACK

See Also:

Constant Field Values

LIST_SAVEPOINT

public static final java.lang.String LIST_SAVEPOINT

DBCommand: SAVEPOINT

See Also:

Constant Field Values

LIST_SCHEMAS

public static final java.lang.String LIST_SCHEMAS

DBCommand: SCHEMAS

See Also:

Constant Field Values

LIST_SELECT

public static final java.lang.String LIST_SELECT

DBCommand: SELECT

See Also:

Constant Field Values

LIST_SEND_EMAIL

public static final java.lang.String LIST_SEND_EMAIL

DBCommand: SEND_EMAIL

See Also:

Constant Field Values

LIST_SEQUENCE

public static final java.lang.String LIST_SEQUENCE

DBCommand: SEQUENCE

See Also:

Constant Field Values

LIST_SHUTDOWN

public static final java.lang.String LIST_SHUTDOWN

DBCommand: SHUTDOWN

See Also:

Constant Field Values

LIST_SITE_SPIDER

public static final java.lang.String LIST_SITE_SPIDER

DBCommand: SITE_SPIDER

See Also:

Constant Field Values

LIST_SLEEP

public static final java.lang.String LIST_SLEEP

DBCommand: SLEEP

See Also:

Constant Field Values

LIST_SNAP_TO

public static final java.lang.String LIST_SNAP_TO

DBCommand: SNAP_TO

See Also:

Constant Field Values

LIST_STATSPART

public static final java.lang.String LIST_STATSPART

DBCommand: STATSPART

See Also:

Constant Field Values

LIST_STORE_WORDS

public static final java.lang.String LIST_STORE_WORDS

DBCommand: STORE_WORDS

See Also:

Constant Field Values

LIST_STORED_RESULT

public static final java.lang.String LIST_STORED_RESULT

DBCommand: STORED_RESULT

See Also:

Constant Field Values

LIST_SUPER_TABLES

public static final java.lang.String LIST_SUPER_TABLES

DBCommand: SUPER_TABLES

See Also:

Constant Field Values

LIST_SUPER_TYPES

public static final java.lang.String LIST_SUPER_TYPES

DBCommand: SUPER_TYPES

See Also:

Constant Field Values

LIST_SYNC

public static final java.lang.String LIST_SYNC

DBCommand: SYNC

See Also:

Constant Field Values

LIST_SYSTEM_STATS

public static final java.lang.String LIST_SYSTEM_STATS

DBCommand: SYSTEM_STATS

See Also:

Constant Field Values

LIST_TABLE_PRIVILEGES

public static final java.lang.String LIST_TABLE_PRIVILEGES

DBCommand: TABLE_PRIVILEGES

See Also:

Constant Field Values

LIST_TABLES

public static final java.lang.String LIST_TABLES

DBCommand: TABLES

See Also:

Constant Field Values

LIST_TASK

public static final java.lang.String LIST_TASK

DBCommand: TASK

See Also:

Constant Field Values

LIST_TRANSACTION

public static final java.lang.String LIST_TRANSACTION

DBCommand: TRANSACTION

See Also:

Constant Field Values

LIST_TRANSACTION_LOG

public static final java.lang.String LIST_TRANSACTION_LOG

DBCommand: TRANSACTION_LOG

See Also:

Constant Field Values

LIST_UPDATE

public static final java.lang.String LIST_UPDATE

DBCommand: UPDATE

See Also:

Constant Field Values

LIST_VALIDATE

public static final java.lang.String LIST_VALIDATE

DBCommand: VALIDATE

See Also:

Constant Field Values

LIST_VERSION_COLUMNS

public static final java.lang.String LIST_VERSION_COLUMNS

DBCommand: VERSION_COLUMNS

See Also:

Constant Field Values

Constructor Detail

DBCommand

public DBCommand(DBClass def,
                 DataSource dataSource)
          throws java.lang.Exception

Std. DBObject constructor.

Parameters:

def - The class of this object

dataSource - The datasource for this object

Throws:

java.lang.Exception - A serious problem occurred

Method Detail

getCode

@CheckReturnValue
 @Nonnull
public java.lang.String getCode(java.lang.String... args)

setCode

@Nonnull
public DBCommand setCode(java.lang.String value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:

java.lang.Exception

getAllocatedTimeToLog

@CheckReturnValue
public long getAllocatedTimeToLog(java.lang.String... args)

setAllocatedTimeToLog

@Nonnull
public DBCommand setAllocatedTimeToLog(long value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getDescription

@CheckReturnValue
 @Nonnull
public java.lang.String getDescription(java.lang.String... args)

setDescription

@Nonnull
public DBCommand setDescription(java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getFarmJavaClassName

@CheckReturnValue
 @Nonnull
public java.lang.String getFarmJavaClassName(java.lang.String... args)

setFarmJavaClassName

@Nonnull
public DBCommand setFarmJavaClassName(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getFarmQueue

@CheckReturnValue
 @Nullable
public DBQueue getFarmQueue(java.lang.String... args)

findFarmQueue

@CheckReturnValue
 @Nonnull
public final DBQueue findFarmQueue(java.lang.String... args)
                                                        throws NotFoundException

The queue that we will farm requests into.

--> DBQueue (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBQueue

Throws:

NotFoundException - DBQueue was not found

setFarmQueue

@Nonnull
public DBCommand setFarmQueue(com.aspc.dal.job.DBQueue value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getFarmRegularExpression

@CheckReturnValue
 @Nonnull
public java.lang.String getFarmRegularExpression(java.lang.String... args)

setFarmRegularExpression

@Nonnull
public DBCommand setFarmRegularExpression(java.lang.String value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

getFarmTimeOut

@CheckReturnValue
 @Nonnull
public java.lang.String getFarmTimeOut(java.lang.String... args)

setFarmTimeOut

@Nonnull
public DBCommand setFarmTimeOut(java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

isFarmable

@CheckReturnValue
public boolean isFarmable(java.lang.String... args)

setFarmable

@Nonnull
public DBCommand setFarmable(boolean value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

isFinalFg

@CheckReturnValue
public boolean isFinalFg(java.lang.String... args)

setFinalFg

@Nonnull
public DBCommand setFinalFg(boolean value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

hasFullAccess

@CheckReturnValue
public boolean hasFullAccess(java.lang.String... args)

getJavaClassName

@CheckReturnValue
 @Nonnull
public java.lang.String getJavaClassName(java.lang.String... args)

setJavaClassName

@Nonnull
public DBCommand setJavaClassName(java.lang.String value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getMaxProcesses

@CheckReturnValue
public int getMaxProcesses(java.lang.String... args)

setMaxProcesses

@Nonnull
public DBCommand setMaxProcesses(int value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getProcessWeight

@CheckReturnValue
public double getProcessWeight(java.lang.String... args)

setProcessWeight

@Nonnull
public DBCommand setProcessWeight(double value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

isSecuredData

@CheckReturnValue
public boolean isSecuredData(java.lang.String... args)

setSecuredData

@Nonnull
public DBCommand setSecuredData(boolean value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getSyntax

@CheckReturnValue
 @Nonnull
public java.lang.String getSyntax(java.lang.String... args)

setSyntax

@Nonnull
public DBCommand setSyntax(java.lang.String value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getUsage

@CheckReturnValue
 @Nonnull
public java.lang.String getUsage(java.lang.String... args)

setUsage

@Nonnull
public DBCommand setUsage(java.lang.String value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static DBCommand create(@Nonnull
                                                           MutableDataSource mds)
                                                    throws java.lang.Exception

Make a new instance of this class.

Parameters:

mds - the datasource

Returns:

the new record

Throws:

java.lang.Exception - an object of this class could not be created

makeQuery

@Nonnull
 @CheckReturnValue
public static DBQuery<DBCommand> makeQuery(@Nonnull
                                                                       DataSource ds)
                                                                throws NotFoundException

Make a new QUERY for this class.

Parameters:

ds - the datasource

Returns:

the new QUERY

Throws:

NotFoundException - if class could not be found

findKey

@Nonnull
 @CheckReturnValue
public static DBCommand findKey(@Nonnull
                                                            DataSource ds,
                                                            @Nonnull
                                                            java.lang.String key)
                                                     throws NotFoundException,
                                                            java.lang.Exception

Find the target for this class by the primary key

Parameters:

ds - the datasource

key - the value

Returns:

the target

Throws:

NotFoundException - if target could not be found

java.lang.Exception - a serious problem

makeFarmPattern

public java.util.regex.Pattern makeFarmPattern()

make the farm regular expression

Returns:

the pattern

makeCode

public static java.lang.String makeCode(java.lang.String sql)

Parameters:

sql -

Returns:

the value

find

public static DBCommand find(java.lang.String sql,
                             DataSource ds,
                             java.util.AbstractMap cache)
                      throws java.lang.Exception

The command for this sql

Parameters:

ds - the data source

cache -

sql - The sql to check

Returns:

The command

Throws:

java.lang.Exception - A serious problem

eventFieldUpdated

@OverridingMethodsMustInvokeSuper
public void eventFieldUpdated(@Nonnull
                                                                DBField field,
                                                                @Nullable
                                                                java.lang.Object previous,
                                                                @Nullable
                                                                GlobalKey previousKey,
                                                                @Nullable
                                                                FldParams params)
                                                         throws java.lang.Exception

update dependent fields.

Overrides:

eventFieldUpdated in class DBObject

Parameters:

field - The field updated.

previous - The previous value for this field.

previousKey - The previous key

params - The parameters used

Throws:

java.lang.Exception - a serious problem

checkProcessWeight

public double checkProcessWeight()
                          throws java.lang.Exception

Returns:

the value

Throws:

java.lang.Exception - a serious problem

checkMaxProcesses

public int checkMaxProcesses()
                      throws java.lang.Exception

Returns:

the value

Throws:

java.lang.Exception - a serious problem

getConstructor

public java.lang.reflect.Constructor getConstructor()
                                             throws java.lang.Exception

Returns:

the value

Throws:

java.lang.Exception - a serious problem

getPattern

public Pattern getPattern()

Returns:

the value

extValidateField

@CheckReturnValue
 @OverridingMethodsMustInvokeSuper
 @Nullable
protected ValidationError extValidateField(@Nonnull
                                                                                                           DBField field,
                                                                                                           @Nonnull
                                                                                                           ValidationList list)
                                                                                                    throws java.lang.Exception

Additional validation for a particular field.

Overrides:

extValidateField in class DBObject

Parameters:

list - The validation list

field - The field to be validated

Returns:

The validation error

Throws:

java.lang.Exception - A serious problem

eventDataLoaded

@OverridingMethodsMustInvokeSuper
protected void eventDataLoaded()

When the underlying DBData is changed/ loaded.

Overrides:

eventDataLoaded in class DBObject

extSetValue

protected void extSetValue(@Nonnull
                           DBField field,
                           @Nullable
                           java.lang.Object value,
                           @Nullable
                           FldParams params)
                    throws java.lang.Exception

We prevent some values from being set by a user.

Overrides:

extSetValue in class DBObject

Parameters:

value - the value

field - The field that is being changed

params - The extra parameters

Throws:

java.lang.Exception - A serious problem

extGetDerivedValue

@CheckReturnValue
protected java.lang.Object extGetDerivedValue(@Nonnull
                                                                DBField field,
                                                                @Nullable
                                                                FldParams params)
                                                         throws java.lang.Exception

Calculate the derived value for this field.

Overrides:

extGetDerivedValue in class DBObject

Parameters:

field - The field to get

params - The parameters for this field eg. language= or default=

Returns:

the value

Throws:

java.lang.Exception - A serious problem