com.aspc.pref.screen

Class SDBColumnPref

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.pref.DBPref

com.aspc.pref.screen.SDBComponentPref

com.aspc.pref.screen.SDBColumnPref

All Implemented Interfaces:

SecondaryCacheGroup

public class SDBColumnPref
extends SDBComponentPref

The column preference.

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 column preference.
static java.lang.String	DBCLASS_NAME The column preference.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	extFixUp() Extended fixup
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
protected void	extPreValidate() Updates the in memory universe before validating
protected ValidationError	extValidateField(DBField field, ValidationList list) Validates the fields of the restriction itself
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.
DBField	findFilterCompListDisplayField(java.lang.String... args) The field value to be displayed in the combo box or multi select component.
SDBSearchComponentType	findFilterCompType(java.lang.String... args) The type of component displayed to the user.
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)
DBClass	getFilterBaseClass(java.lang.String... args)
java.lang.String	getFilterCompDefaultSymbol(java.lang.String... args)
DBField	getFilterCompListDisplayField(java.lang.String... args)
java.lang.String	getFilterCompListFilter(java.lang.String... args)
int	getFilterCompListLength(java.lang.String... args)
java.lang.String	getFilterCompListSortOrder(java.lang.String... args)
int	getFilterCompSeqInteger(java.lang.String... args)
SDBSearchComponentType	getFilterCompType(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)
boolean	isFilterBy(java.lang.String... args)
boolean	isFilterCompListIsSorted(java.lang.String... args)
boolean	isFilterCompListUseInOperator(java.lang.String... args)
SDBColumnPref	setColumnOrder(int value, java.lang.String... args)
SDBColumnPref	setContainer(com.aspc.dal.pref.screen.SDBContainerPref value, java.lang.String... args)
SDBColumnPref	setFilterBy(boolean value, java.lang.String... args)
SDBColumnPref	setFilterSrcFieldPath(java.lang.String value, java.lang.String... args)
SDBColumnPref	setFilterSymbol(java.lang.String value, java.lang.String... args)
SDBColumnPref	setFilterValue(java.lang.String value, java.lang.String... args)
SDBColumnPref	setFilterValue2(java.lang.String value, java.lang.String... args)
SDBColumnPref	setOrderBy(com.aspc.dal.dbobj.misc.DBSortOrder value, java.lang.String... args)
SDBColumnPref	setSortNr(int value, java.lang.String... args)

Methods inherited from class com.aspc.pref.screen.SDBComponentPref

fetchPrefGroup, findComponent, findVisibility, getComponent, getDerivedComponentCol, getDerivedComponentFieldPathDesc, getSudoComponent, getVisibility, getWidth, isDerivedComponentHidden, isHidden, setComponent, setHidden, setVisibility, setWidth

Methods inherited from class com.aspc.pref.DBPref

create, 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, 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 column preference.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

The column preference.

Constructor Detail

SDBColumnPref

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

getColumnOrder

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

setColumnOrder

@Nonnull
public SDBColumnPref 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 SDBColumnPref setContainer(com.aspc.dal.pref.screen.SDBContainerPref value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

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 SDBColumnPref setFilterBy(boolean value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getFilterCompDefaultSymbol

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

getFilterCompListDisplayField

@CheckReturnValue
 @Nullable
public DBField getFilterCompListDisplayField(java.lang.String... args)

findFilterCompListDisplayField

@CheckReturnValue
 @Nonnull
public final DBField findFilterCompListDisplayField(java.lang.String... args)
                                                                         throws NotFoundException

The field value to be displayed in the combo box or multi select component.

--> DBField (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

DBField

Throws:

NotFoundException - DBField was not found

getFilterCompListFilter

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

isFilterCompListIsSorted

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

getFilterCompListLength

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

getFilterCompListSortOrder

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

isFilterCompListUseInOperator

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

getFilterCompSeqInteger

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

getFilterCompType

@CheckReturnValue
 @Nullable
public SDBSearchComponentType getFilterCompType(java.lang.String... args)

findFilterCompType

@CheckReturnValue
 @Nonnull
public final SDBSearchComponentType findFilterCompType(java.lang.String... args)
                                                                            throws NotFoundException

The type of component displayed to the user.

--> SDBSearchComponentType (String, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

SDBSearchComponentType

Throws:

NotFoundException - SDBSearchComponentType was not found

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 SDBColumnPref 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 SDBColumnPref 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 SDBColumnPref 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 SDBColumnPref setFilterValue2(java.lang.String 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 SDBColumnPref 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 SDBColumnPref setSortNr(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

Calculate the derived value for this field.

Overrides:

extGetDerivedValue in class SDBComponentPref

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

extPreValidate

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

Updates the in memory universe before validating

Overrides:

extPreValidate in class DBObject

Throws:

java.lang.Exception - failure to update the universe

extValidateField

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

Validates the fields of the restriction itself

Overrides:

extValidateField in class SDBComponentPref

Parameters:

list - The validation list

field - The field to validated

Returns:

The validation error or warning.

Throws:

java.lang.Exception - A serious problem

extFixUp

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

Extended fixup

Overrides:

extFixUp in class SDBComponentPref

Throws:

java.lang.Exception - failure to fixup