com.aspc.pref.screen

Class SDBCustomizedColumnPref

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.pref.DBPref

com.aspc.pref.screen.SDBCustomizedColumnPref

All Implemented Interfaces:

SecondaryCacheGroup

public class SDBCustomizedColumnPref
extends DBPref

User can add their preferred report columns into their report screen.

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

Since:

10 December 2014

Author:

Lei Gao

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 User can add their preferred report columns into their report screen.
static java.lang.String	DBCLASS_NAME User can add their preferred report columns into their report screen.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
SDBCustomizedColumnPref(DBClass def, DataSource dataSource)

Method Summary

Modifier and Type	Method and Description
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Handles the calculation of values for derived fields
protected void	extPreValidate() OVERRIDE To add functionality to before validation is called.
SDBContainerPref	findContainer(java.lang.String... args) Component preference that contains this column preference.
DBClass	findFilterBaseClass(java.lang.String... args) Class that the field path is based on.
DBSortOrder	findOrderBy(java.lang.String... args) Allow the user to sort ascending or descending.
int	getColumnOrder(java.lang.String... args)
double	getColumnOrderDisplaySeq(java.lang.String... args)
SDBContainerPref	getContainer(java.lang.String... args)
java.lang.String	getDisplayFormat(java.lang.String... args)
java.lang.String	getDisplayLabel(java.lang.String... args)
java.lang.String	getFieldPath(java.lang.String... args)
java.lang.String	getFieldPathDesc(java.lang.String... args)
DBClass	getFilterBaseClass(java.lang.String... args)
java.lang.String	getFilterFieldParameters(java.lang.String... args)
java.lang.String	getFilterFieldPath(java.lang.String... args)
java.lang.String	getFilterSrcFieldPath(java.lang.String... args)
java.lang.String	getFilterSymbol(java.lang.String... args)
java.lang.String	getFilterValue(java.lang.String... args)
java.lang.String	getFilterValue2(java.lang.String... args)
java.lang.String	getLabel(java.lang.String... args)
DBSortOrder	getOrderBy(java.lang.String... args)
int	getSortNr(java.lang.String... args)
int	getWidth(java.lang.String... args)
boolean	isFilterBy(java.lang.String... args)
boolean	isHidden(java.lang.String... args)
boolean	isIncludesHTMLTags(java.lang.String... args)
SDBCustomizedColumnPref	setColumnOrder(int value, java.lang.String... args)
SDBCustomizedColumnPref	setContainer(com.aspc.dal.pref.screen.SDBContainerPref value, java.lang.String... args)
SDBCustomizedColumnPref	setDisplayFormat(java.lang.String value, java.lang.String... args)
SDBCustomizedColumnPref	setDisplayLabel(java.lang.String value, java.lang.String... args)
SDBCustomizedColumnPref	setFieldPath(java.lang.String value, java.lang.String... args)
SDBCustomizedColumnPref	setFilterBy(boolean value, java.lang.String... args)
SDBCustomizedColumnPref	setFilterSrcFieldPath(java.lang.String value, java.lang.String... args)
SDBCustomizedColumnPref	setFilterSymbol(java.lang.String value, java.lang.String... args)
SDBCustomizedColumnPref	setFilterValue(java.lang.String value, java.lang.String... args)
SDBCustomizedColumnPref	setFilterValue2(java.lang.String value, java.lang.String... args)
SDBCustomizedColumnPref	setHidden(boolean value, java.lang.String... args)
SDBCustomizedColumnPref	setIncludesHTMLTags(boolean value, java.lang.String... args)
SDBCustomizedColumnPref	setOrderBy(com.aspc.dal.dbobj.misc.DBSortOrder value, java.lang.String... args)
SDBCustomizedColumnPref	setSortNr(int value, java.lang.String... args)
SDBCustomizedColumnPref	setWidth(int value, java.lang.String... args)

Methods inherited from class com.aspc.pref.DBPref

create, extFixUp, findKey, findPrefGroup, getID, getPrefGroup, isActive, makeQuery, setID, setPrefGroup

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

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

User can add their preferred report columns into their report screen.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

User can add their preferred report columns into their report screen.

Constructor Detail

SDBCustomizedColumnPref

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

Throws:

java.lang.Exception

Method Detail

getColumnOrder

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

setColumnOrder

@Nonnull
public SDBCustomizedColumnPref setColumnOrder(int value,
                                                       java.lang.String... args)
                                                throws java.lang.Exception

Throws:

java.lang.Exception

getColumnOrderDisplaySeq

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

getContainer

@CheckReturnValue
 @Nullable
public SDBContainerPref getContainer(java.lang.String... args)

findContainer

@CheckReturnValue
 @Nonnull
public final SDBContainerPref findContainer(java.lang.String... args)
                                                                 throws NotFoundException

Component preference that contains this column preference.

--> SDBContainerPref (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

SDBContainerPref

Throws:

NotFoundException - SDBContainerPref was not found

setContainer

@Nonnull
public SDBCustomizedColumnPref setContainer(com.aspc.dal.pref.screen.SDBContainerPref value,
                                                     java.lang.String... args)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

getDisplayFormat

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

setDisplayFormat

@Nonnull
public SDBCustomizedColumnPref setDisplayFormat(java.lang.String value,
                                                         java.lang.String... args)
                                                  throws java.lang.Exception

Throws:

java.lang.Exception

getDisplayLabel

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

setDisplayLabel

@Nonnull
public SDBCustomizedColumnPref setDisplayLabel(java.lang.String value,
                                                        java.lang.String... args)
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

getFieldPath

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

setFieldPath

@Nonnull
public SDBCustomizedColumnPref setFieldPath(java.lang.String value,
                                                     java.lang.String... args)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

getFieldPathDesc

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

getFilterBaseClass

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

findFilterBaseClass

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

Class that the field path is based on.

--> DBClass (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

DBClass

Throws:

NotFoundException - DBClass was not found

isFilterBy

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

setFilterBy

@Nonnull
public SDBCustomizedColumnPref setFilterBy(boolean value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getFilterFieldParameters

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

getFilterFieldPath

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

getFilterSrcFieldPath

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

setFilterSrcFieldPath

@Nonnull
public SDBCustomizedColumnPref setFilterSrcFieldPath(java.lang.String value,
                                                              java.lang.String... args)
                                                       throws java.lang.Exception

Throws:

java.lang.Exception

getFilterSymbol

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

setFilterSymbol

@Nonnull
public SDBCustomizedColumnPref setFilterSymbol(java.lang.String value,
                                                        java.lang.String... args)
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

getFilterValue

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

setFilterValue

@Nonnull
public SDBCustomizedColumnPref setFilterValue(java.lang.String value,
                                                       java.lang.String... args)
                                                throws java.lang.Exception

Throws:

java.lang.Exception

getFilterValue2

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

setFilterValue2

@Nonnull
public SDBCustomizedColumnPref setFilterValue2(java.lang.String value,
                                                        java.lang.String... args)
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

isHidden

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

setHidden

@Nonnull
public SDBCustomizedColumnPref setHidden(boolean value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

isIncludesHTMLTags

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

setIncludesHTMLTags

@Nonnull
public SDBCustomizedColumnPref setIncludesHTMLTags(boolean value,
                                                            java.lang.String... args)
                                                     throws java.lang.Exception

Throws:

java.lang.Exception

getLabel

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

getOrderBy

@CheckReturnValue
 @Nullable
public DBSortOrder getOrderBy(java.lang.String... args)

findOrderBy

@CheckReturnValue
 @Nonnull
public final DBSortOrder findOrderBy(java.lang.String... args)
                                                          throws NotFoundException

Allow the user to sort ascending or descending.

--> DBSortOrder (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBSortOrder

Throws:

NotFoundException - DBSortOrder was not found

setOrderBy

@Nonnull
public SDBCustomizedColumnPref setOrderBy(com.aspc.dal.dbobj.misc.DBSortOrder value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

getSortNr

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

setSortNr

@Nonnull
public SDBCustomizedColumnPref setSortNr(int value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getWidth

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

setWidth

@Nonnull
public SDBCustomizedColumnPref setWidth(int value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

extGetDerivedValue

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

Description copied from class: DBPref

Handles the calculation of values for derived fields

Overrides:

extGetDerivedValue in class DBPref

Parameters:

field - The derived field that a value is required for

params - Field parameters providing information for the calculation of values

Returns:

The calculated value

Throws:

java.lang.Exception - a serious problem

extPreValidate

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

Description copied from class: DBObject

OVERRIDE To add functionality to before validation is called.

THIS IS YOUR LAST CHANCE TO MAKE CHANGES BEFORE VALIDATIONS.

Overrides:

extPreValidate in class DBObject

Throws:

java.lang.Exception - a serious problem