com.aspc.job.statistic

Class DBJobStatistic

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.job.statistic.DBJobStatistic

All Implemented Interfaces:

SecondaryCacheGroup

public class DBJobStatistic
extends DBObject

A mirror version of the DBJob record that will not be deleted as often.

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 A mirror version of the DBJob record that will not be deleted as often.
static java.lang.String	DBCLASS_NAME A mirror version of the DBJob record that will not be deleted as often.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static DBJobStatistic	create(MutableDataSource mds) Make a new instance of this class.
protected void	extFixUp() fixes the following problem 1) preference group been removed
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
static DBJobStatistic	findKey(DataSource ds, int key) Find the target for this class by the primary key
DBQueue	findQueue(java.lang.String... args) The queue for this job.
DBJobStatus	findStatus(java.lang.String... args) The current status of this job.
DBJobStatus	findStoreStatus(java.lang.String... args) The backing stored of the job field ( when the job is deleted).
Login	findUserId(java.lang.String... args) Who the job is for.
java.lang.String	getCode(java.lang.String... args)
java.lang.String	getDisplayName(java.lang.String... args)
java.lang.String	getDroidHostname(java.lang.String... args)
java.lang.String	getDroidName(java.lang.String... args)
java.lang.String	getErrorTx(java.lang.String... args)
java.util.Date	getFinishedTS(java.lang.String... args)
int	getID(java.lang.String... args)
java.lang.String	getOnCompleteCommands(java.lang.String... args)
java.lang.String	getOnErrorCommands(java.lang.String... args)
java.lang.String	getOnRetryCommands(java.lang.String... args)
java.lang.String	getOnStartCommands(java.lang.String... args)
java.lang.String	getOnWarningCommands(java.lang.String... args)
java.lang.String	getProcessMsg(java.lang.String... args)
DBQueue	getQueue(java.lang.String... args)
java.util.Date	getQueuedTS(java.lang.String... args)
int	getRetryCount(java.lang.String... args)
java.lang.String	getRunnerName(java.lang.String... args)
java.util.Date	getStartedTS(java.lang.String... args)
DBJobStatus	getStatus(java.lang.String... args)
java.lang.String	getStoreCode(java.lang.String... args)
java.lang.String	getStoreDroidHostName(java.lang.String... args)
java.lang.String	getStoreDroidName(java.lang.String... args)
java.lang.String	getStoreErrorTx(java.lang.String... args)
java.util.Date	getStoreFinishedTS(java.lang.String... args)
java.lang.String	getStoreProcessMsg(java.lang.String... args)
int	getStoreRetryCount(java.lang.String... args)
java.lang.String	getStoreServerName(java.lang.String... args)
java.util.Date	getStoreStartedTS(java.lang.String... args)
DBJobStatus	getStoreStatus(java.lang.String... args)
long	getStoreTotalTimeMS(java.lang.String... args)
java.util.List<java.lang.String>	getStoreWaitForJob(java.lang.String... args)
java.lang.String	getStoreWarningTx(java.lang.String... args)
java.lang.String	getTotalTime(java.lang.String... args)
long	getTotalTimeMS(java.lang.String... args)
Login	getUserId(java.lang.String... args)
java.util.List<java.lang.String>	getWaitForJob(java.lang.String... args)
java.lang.String	getWarningTx(java.lang.String... args)
boolean	isStoreWaitCheckSuccessfulForJobs(java.lang.String... args)
boolean	isWaitCheckSuccessfulForJobs(java.lang.String... args)
static GlobalKey	makeJobKey(java.lang.String jobId) Makes a global key from an ascii key
static DBQuery<DBJobStatistic>	makeQuery(DataSource ds) Make a new QUERY for this class.
static SearchPlan	makeSearchPlan(DBQuery<DBObject> query) Allows for specific attributes to be set for the queries
DBJobStatistic	setID(int value, java.lang.String... args)
DBJobStatistic	setOnCompleteCommands(java.lang.String value, java.lang.String... args)
DBJobStatistic	setOnErrorCommands(java.lang.String value, java.lang.String... args)
DBJobStatistic	setOnRetryCommands(java.lang.String value, java.lang.String... args)
DBJobStatistic	setOnStartCommands(java.lang.String value, java.lang.String... args)
DBJobStatistic	setOnWarningCommands(java.lang.String value, java.lang.String... args)
DBJobStatistic	setQueue(com.aspc.dal.job.DBQueue value, java.lang.String... args)
DBJobStatistic	setQueuedTS(java.util.Date value, java.lang.String... args)
DBJobStatistic	setStoreCode(java.lang.String value, java.lang.String... args)
DBJobStatistic	setStoreDroidHostName(java.lang.String value, java.lang.String... args)
DBJobStatistic	setStoreDroidName(java.lang.String value, java.lang.String... args)
DBJobStatistic	setStoreErrorTx(java.lang.String value, java.lang.String... args)
DBJobStatistic	setStoreFinishedTS(java.util.Date value, java.lang.String... args)
DBJobStatistic	setStoreProcessMsg(java.lang.String value, java.lang.String... args)
DBJobStatistic	setStoreRetryCount(int value, java.lang.String... args)
DBJobStatistic	setStoreServerName(java.lang.String value, java.lang.String... args)
DBJobStatistic	setStoreStartedTS(java.util.Date value, java.lang.String... args)
DBJobStatistic	setStoreStatus(com.aspc.dal.job.DBJobStatus value, java.lang.String... args)
DBJobStatistic	setStoreTotalTimeMS(long value, java.lang.String... args)
DBJobStatistic	setStoreWaitCheckSuccessfulForJobs(boolean value, java.lang.String... args)
DBJobStatistic	setStoreWaitForJob(java.util.List<java.lang.String> value, java.lang.String... args)
DBJobStatistic	setStoreWarningTx(java.lang.String value, java.lang.String... args)
DBJobStatistic	setUserId(com.aspc.dal.dbobj.contact.Login 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, eventDataLoaded, eventFieldUpdated, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extGetDerivedGlobalKey, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidate, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, extValidateField, 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, 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

A mirror version of the DBJob record that will not be deleted as often.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

A mirror version of the DBJob record that will not be deleted as often.

Constructor Detail

DBJobStatistic

public DBJobStatistic(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

getID

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

setID

@Nonnull
public DBJobStatistic setID(int value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getCode

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

getDisplayName

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

getDroidHostname

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

getDroidName

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

getErrorTx

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

getFinishedTS

@CheckReturnValue
 @Nullable
public java.util.Date getFinishedTS(java.lang.String... args)

getOnCompleteCommands

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

setOnCompleteCommands

@Nonnull
public DBJobStatistic setOnCompleteCommands(java.lang.String value,
                                                     java.lang.String... args)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

getOnErrorCommands

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

setOnErrorCommands

@Nonnull
public DBJobStatistic setOnErrorCommands(java.lang.String value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getOnRetryCommands

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

setOnRetryCommands

@Nonnull
public DBJobStatistic setOnRetryCommands(java.lang.String value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getOnStartCommands

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

setOnStartCommands

@Nonnull
public DBJobStatistic setOnStartCommands(java.lang.String value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getOnWarningCommands

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

setOnWarningCommands

@Nonnull
public DBJobStatistic setOnWarningCommands(java.lang.String value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getProcessMsg

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

getQueue

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

findQueue

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

The queue for this job.

--> DBQueue (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBQueue

Throws:

NotFoundException - DBQueue was not found

setQueue

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

Throws:

java.lang.Exception

getQueuedTS

@CheckReturnValue
 @Nullable
public java.util.Date getQueuedTS(java.lang.String... args)

setQueuedTS

@Nonnull
public DBJobStatistic setQueuedTS(java.util.Date value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getRetryCount

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

getRunnerName

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

getStartedTS

@CheckReturnValue
 @Nullable
public java.util.Date getStartedTS(java.lang.String... args)

getStatus

@CheckReturnValue
 @Nullable
public DBJobStatus getStatus(java.lang.String... args)

findStatus

@CheckReturnValue
 @Nonnull
public final DBJobStatus findStatus(java.lang.String... args)
                                                         throws NotFoundException

The current status of this job.

--> DBJobStatus (String, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

DBJobStatus

Throws:

NotFoundException - DBJobStatus was not found

getStoreCode

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

setStoreCode

@Nonnull
public DBJobStatistic setStoreCode(java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getStoreDroidHostName

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

setStoreDroidHostName

@Nonnull
public DBJobStatistic setStoreDroidHostName(java.lang.String value,
                                                     java.lang.String... args)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

getStoreDroidName

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

setStoreDroidName

@Nonnull
public DBJobStatistic setStoreDroidName(java.lang.String value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getStoreErrorTx

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

setStoreErrorTx

@Nonnull
public DBJobStatistic setStoreErrorTx(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getStoreFinishedTS

@CheckReturnValue
 @Nullable
public java.util.Date getStoreFinishedTS(java.lang.String... args)

setStoreFinishedTS

@Nonnull
public DBJobStatistic setStoreFinishedTS(java.util.Date value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getStoreProcessMsg

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

setStoreProcessMsg

@Nonnull
public DBJobStatistic setStoreProcessMsg(java.lang.String value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getStoreRetryCount

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

setStoreRetryCount

@Nonnull
public DBJobStatistic setStoreRetryCount(int value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getStoreServerName

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

setStoreServerName

@Nonnull
public DBJobStatistic setStoreServerName(java.lang.String value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getStoreStartedTS

@CheckReturnValue
 @Nullable
public java.util.Date getStoreStartedTS(java.lang.String... args)

setStoreStartedTS

@Nonnull
public DBJobStatistic setStoreStartedTS(java.util.Date value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getStoreStatus

@CheckReturnValue
 @Nullable
public DBJobStatus getStoreStatus(java.lang.String... args)

findStoreStatus

@CheckReturnValue
 @Nonnull
public final DBJobStatus findStoreStatus(java.lang.String... args)
                                                              throws NotFoundException

The backing stored of the job field ( when the job is deleted).

--> DBJobStatus (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBJobStatus

Throws:

NotFoundException - DBJobStatus was not found

setStoreStatus

@Nonnull
public DBJobStatistic setStoreStatus(com.aspc.dal.job.DBJobStatus value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getStoreTotalTimeMS

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

setStoreTotalTimeMS

@Nonnull
public DBJobStatistic setStoreTotalTimeMS(long value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

isStoreWaitCheckSuccessfulForJobs

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

setStoreWaitCheckSuccessfulForJobs

@Nonnull
public DBJobStatistic setStoreWaitCheckSuccessfulForJobs(boolean value,
                                                                  java.lang.String... args)
                                                           throws java.lang.Exception

Throws:

java.lang.Exception

getStoreWaitForJob

@CheckReturnValue
 @Nonnull
public java.util.List<java.lang.String> getStoreWaitForJob(java.lang.String... args)

setStoreWaitForJob

@Nonnull
public DBJobStatistic setStoreWaitForJob(java.util.List<java.lang.String> value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getStoreWarningTx

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

setStoreWarningTx

@Nonnull
public DBJobStatistic setStoreWarningTx(java.lang.String value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getTotalTime

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

getTotalTimeMS

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

getUserId

@CheckReturnValue
 @Nullable
public Login getUserId(java.lang.String... args)

findUserId

@CheckReturnValue
 @Nonnull
public final Login findUserId(java.lang.String... args)
                                                   throws NotFoundException

Who the job is for.

--> Login (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Login

Throws:

NotFoundException - Login was not found

setUserId

@Nonnull
public DBJobStatistic setUserId(com.aspc.dal.dbobj.contact.Login value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

isWaitCheckSuccessfulForJobs

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

getWaitForJob

@CheckReturnValue
 @Nonnull
public java.util.List<java.lang.String> getWaitForJob(java.lang.String... args)

getWarningTx

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

create

@Nonnull
 @CheckReturnValue
public static DBJobStatistic 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<DBJobStatistic> 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 DBJobStatistic findKey(@Nonnull
                                                                 DataSource ds,
                                                                 int 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

extFixUp

@OverridingMethodsMustInvokeSuper
protected void extFixUp()
                                                   throws java.lang.Exception

fixes the following problem 1) preference group been removed

Overrides:

extFixUp in class DBObject

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 calculated value

Throws:

java.lang.Exception - A serious problem

makeJobKey

public static GlobalKey makeJobKey(java.lang.String jobId)
                            throws java.lang.Exception

Makes a global key from an ascii key

Parameters:

jobId - The ascii job id

Returns:

The Job global key.

Throws:

java.lang.Exception - A serious problem

makeSearchPlan

@CheckReturnValue
 @Nonnull
public static SearchPlan makeSearchPlan(@Nonnull
                                                                    DBQuery<DBObject> query)

Allows for specific attributes to be set for the queries

Parameters:

query - The calling query

Returns:

The search plan