com.aspc.DBObj.Archive.screen

Class SDBLogControl

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.Archive.screen.SDBLogControl

All Implemented Interfaces:

SecondaryCacheGroup

public class SDBLogControl
extends DBObject

Class for log filtering and messages.

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

Since:

29 September 2006

Author:

alex

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 java.lang.String	ABS_MIDDLE_ALIGN middle alignment.
static GlobalId	DBCLASS_GID Class for log filtering and messages
static java.lang.String	DBCLASS_NAME Class for log filtering and messages
static java.lang.String	SIZE_FULL 100 percent width.
static java.lang.String	VA_TOP Top alignment.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
SDBLogControl(DBClass def, DataSource dataSource) Creates new DBObject.

Method Summary

Modifier and Type	Method and Description
static SDBLogControl	create(MutableDataSource mds) Make a new instance of this class.
DBClass	findBaseClass(java.lang.String... args) The class that this filter applies to.
SDBLogFilterType	findFilterType(java.lang.String... args) The filter type : none, include or exclude.
static SDBLogControl	findKey(DataSource ds, int key) Find the target for this class by the primary key
DBMessage	findMessage(java.lang.String... args) The message to appear in view if the filter is not set.
DBClass	getBaseClass(java.lang.String... args)
java.lang.String	getCondition(java.lang.String... args)
DBObject[]	getFieldChangeList() Returns a list of fields associated to this condition
SDBLogFilterType	getFilterType(java.lang.String... args)
int	getID(java.lang.String... args)
static java.util.List	getLogControls(java.util.Map classesMap, DataSource ds) get immutable list of log controls
DBMessage	getMessage(java.lang.String... args)
boolean	isActionCreate(java.lang.String... args)
boolean	isActionDelete(java.lang.String... args)
boolean	isActionModify(java.lang.String... args)
static DBQuery<SDBLogControl>	makeQuery(DataSource ds) Make a new QUERY for this class.
boolean	matchesBaseClass(DBObject base) Checks the base class requirement.
boolean	matchesBaseClass(TransRecord record) Checks the base class requirement.
boolean	matchesBasicCondition(DBObject base) Checks basic requirements.
boolean	matchesBasicCondition(TransRecord record) Checks basic requirements.
boolean	matchesConditionClause(DBObject currObj) Checks condition.
boolean	matchesFieldCondition(DBObject base) Checks field requirements.
boolean	matchesFieldCondition(TransRecord record) Checks field requirements.
SDBLogControl	setActionCreate(boolean value, java.lang.String... args)
SDBLogControl	setActionDelete(boolean value, java.lang.String... args)
SDBLogControl	setActionModify(boolean value, java.lang.String... args)
SDBLogControl	setBaseClass(com.aspc.dal.dbobj.DBClass value, java.lang.String... args)
SDBLogControl	setCondition(java.lang.String value, java.lang.String... args)
SDBLogControl	setFilterType(com.aspc.dal.dbobj.archive.screen.SDBLogFilterType value, java.lang.String... args)
SDBLogControl	setID(int value, java.lang.String... args)
SDBLogControl	setMessage(com.aspc.dal.message.DBMessage 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, extFixUp, extGetDerivedGlobalKey, extGetDerivedValue, 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, 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

VA_TOP

public static final java.lang.String VA_TOP

Top alignment.

See Also:

Constant Field Values

SIZE_FULL

public static final java.lang.String SIZE_FULL

100 percent width.

See Also:

Constant Field Values

ABS_MIDDLE_ALIGN

public static final java.lang.String ABS_MIDDLE_ALIGN

middle alignment.

See Also:

Constant Field Values

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

Class for log filtering and messages

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Class for log filtering and messages

Constructor Detail

SDBLogControl

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

Creates new DBObject.

Parameters:

def - The class

dataSource - Your current data source

Throws:

java.lang.Exception - Failed to initiate the database object.

Method Detail

getID

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

setID

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

Throws:

java.lang.Exception

isActionCreate

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

setActionCreate

@Nonnull
public SDBLogControl setActionCreate(boolean value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

isActionDelete

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

setActionDelete

@Nonnull
public SDBLogControl setActionDelete(boolean value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

isActionModify

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

setActionModify

@Nonnull
public SDBLogControl setActionModify(boolean value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getBaseClass

@CheckReturnValue
 @Nullable
public DBClass getBaseClass(java.lang.String... args)

findBaseClass

@CheckReturnValue
 @Nonnull
public final DBClass findBaseClass(java.lang.String... args)
                                                        throws NotFoundException

The class that this filter applies to.

--> DBClass (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

DBClass

Throws:

NotFoundException - DBClass was not found

setBaseClass

@Nonnull
public SDBLogControl setBaseClass(com.aspc.dal.dbobj.DBClass value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getCondition

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

setCondition

@Nonnull
public SDBLogControl setCondition(java.lang.String value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getFilterType

@CheckReturnValue
 @Nullable
public SDBLogFilterType getFilterType(java.lang.String... args)

findFilterType

@CheckReturnValue
 @Nonnull
public final SDBLogFilterType findFilterType(java.lang.String... args)
                                                                  throws NotFoundException

The filter type : none, include or exclude.

--> SDBLogFilterType (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

SDBLogFilterType

Throws:

NotFoundException - SDBLogFilterType was not found

setFilterType

@Nonnull
public SDBLogControl setFilterType(com.aspc.dal.dbobj.archive.screen.SDBLogFilterType value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getMessage

@CheckReturnValue
 @Nullable
public DBMessage getMessage(java.lang.String... args)

findMessage

@CheckReturnValue
 @Nonnull
public final DBMessage findMessage(java.lang.String... args)
                                                        throws NotFoundException

The message to appear in view if the filter is not set.

--> DBMessage (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Message

Throws:

NotFoundException - DBMessage was not found

setMessage

@Nonnull
public SDBLogControl setMessage(com.aspc.dal.message.DBMessage value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static SDBLogControl 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<SDBLogControl> 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 SDBLogControl 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

getLogControls

public static java.util.List getLogControls(java.util.Map classesMap,
                                            DataSource ds)
                                     throws java.lang.Exception

get immutable list of log controls

Parameters:

ds - The DataSource

classesMap - The class map

Returns:

List

Throws:

java.lang.Exception - A serious problem occurs

matchesBaseClass

public boolean matchesBaseClass(TransRecord record)

Checks the base class requirement.

Parameters:

record - The transaction record

Returns:

true if condition matches

matchesBaseClass

public boolean matchesBaseClass(DBObject base)

Checks the base class requirement.

Parameters:

base - object

Returns:

true if condition matches

matchesFieldCondition

public boolean matchesFieldCondition(TransRecord record)

Checks field requirements.

Parameters:

record - The transaction record

Returns:

true if condition matches

matchesFieldCondition

public boolean matchesFieldCondition(DBObject base)

Checks field requirements.

Parameters:

base - object

Returns:

true if condition matches

matchesBasicCondition

public boolean matchesBasicCondition(TransRecord record)

Checks basic requirements.

Parameters:

record - The transaction record

Returns:

true if condition matches

matchesBasicCondition

public boolean matchesBasicCondition(DBObject base)

Checks basic requirements.

Parameters:

base - object

Returns:

true if condition matches

matchesConditionClause

public boolean matchesConditionClause(DBObject currObj)
                               throws java.lang.Exception

Checks condition.

Parameters:

currObj - The current db object

Returns:

true if condition matches

Throws:

java.lang.Exception - If something went wrong

getFieldChangeList

public DBObject[] getFieldChangeList()
                              throws java.lang.Exception

Returns a list of fields associated to this condition

Returns:

list of fields

Throws:

java.lang.Exception - a serious error