com.aspc.DBObj.Internal

Class DBRawField

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.DBField

com.aspc.DBObj.Internal.DBRawField

All Implemented Interfaces:

SecondaryCacheGroup, java.util.Comparator

public final class DBRawField
extends DBField

DBRawField.java THREAD MODE: MULTI-THREADED

Since:

January 6, 2001, 7:16 PM

Author:

Nigel Leck

Nested Class Summary

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

DBObject.DenormalizeAction

Field Summary

Fields inherited from class com.aspc.DBObj.DBField

cacheRowId, DBCLASS_GID, DBCLASS_NAME, DISABLE_LAZY_LOAD, PROPERTY_DISABLE_LAZY_LOAD, TYPE_BOOLEAN, TYPE_CUSTOM, TYPE_DATE, TYPE_DOUBLE, TYPE_INTEGER, TYPE_LONG, TYPE_MULTILINGUAL, TYPE_STRING, TYPE_TEXT, TYPE_TIMESTAMP

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description

DBRawField(DBClass def, GlobalKey id, GlobalKey classGid, GlobalKey rootClassKey, java.lang.String name, java.lang.String description, java.lang.String type, boolean keyFg, boolean searchFg, boolean derivedFg, boolean incrementalFg, boolean mandatoryFg, java.lang.String autoEnterVal, DataSource dataSource, long rowId, boolean uniqueFg, java.lang.String subType, boolean keyWordFg) Creates new DBRawField.

Method Summary

Modifier and Type	Method and Description
protected java.lang.Object	extGetValue(DBField field, FldParams params) This is the PRIMARY "get" method which returns the processed field value for this object.
GlobalKey	getBaseClassGid() The base class global id
GlobalKey	getClassGid()
java.lang.String	getDescription() The description of the field
java.lang.String	getName() A short method for getting the field name.
GlobalKey	getRawGlobalKey()
GlobalKey	getRawGlobalKey(DBField field)
long	getRawRowId()
boolean	isDerived()
boolean	isIncremental() Is this field marked as incremental ?
boolean	isKeyWord(java.lang.String... args)
boolean	isRawKey()
boolean	isRawMandatory()
boolean	isRawUnique()

Methods inherited from class com.aspc.DBObj.DBField

canParentClearChild, canParentRemoveChild, clearCache, compare, create, disableFieldRecycler, disableJournalData, displayName, eventFieldUpdated, extCheckModifyAccess, extFixUp, extGetDerivedValue, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extValidateField, findAutoEnterPreDefined, findClassGid, findKey, findLinkedClass, findLinkedDBClass, findOnChangeField, findSubType, findValidationMessage, getAutoEnterFormula, getAutoEnterPreDefined, getAutoEnterValue, getAutoFillPredefinedValue, getAutoFillValue, getBaseDBClass, getBaseDBClassAbstract, getClassGid, getDeprecatedTx, getDisplayFormat, getDisplayName, getDisplayType, getFactoryJavaClass, getFieldId, getFormula, getID, getIncrementalCacheSize, getIndexPrefix, getKey, getLayerField, getLinkDisplayName, getLinkedClass, getLinkedDBClass, getLinkedDBClassAbstract, getLinkedDBClassConcrete, getLinkedDBClassRootId, getMaxLength, getNotes, getOnChangeField, getOnChangeFormula, getOnChangePath, getOnChangeValue, getPlaceholder, getRecycleCount, getSampleBadValues, getSampleValues, getSampleValuesDelimiter, getSubType, getType, getUniqueKeyPrefix, getUpdateOnChangeField, getUpdateOnChangeFormula, getUpdateOnChangePath, getUpdateOnChangeValue, getValidateMaxValue, getValidateMinValue, getValidationFormula, getValidationMessage, getValidationMsg, getValidationRegularExpression, hasAutoEnterFormula, hasValidationFormula, isArray, isArrayFg, isArrayNoCache, isDeprecated, isDerivedFg, isEncrypted, isEncryptedFg, isFinalFg, isInClass, isIncrementalFg, isIndexable, isInternalUseOnly, isKey, isKeyFg, isLazyLoad, isLazyLoadFg, isLinked, isLinkedTounchOnChange, isMandatory, isMultiLingual, isNumber, isObscure, isObscureFg, isRecordingRecentLinks, isRecordRecentLinks, isRuntimeEval, isSearchable, isSearchFg, isUnique, makeDisplayName, makeFactory, makeFormattedString, makeQuery, makeRowId, makeSQLKeyString, makeSQLString, makeString, parse, preparedSQLKeyString, recycle, setArrayFg, setArrayNoCache, setAutoEnterFormula, setAutoEnterPreDefined, setAutoEnterValue, setCanParentClearChild, setCanParentRemoveChild, setClassGid, setDeprecated, setDeprecatedTx, setDerivedFg, setDescription, setDisableFieldRecycler, setDisableJournalData, setDisplayFormat, setDisplayName, setEncryptedFg, setFactoryJavaClass, setFinalFg, setFormula, setID, setIncrementalCacheSize, setIncrementalFg, setInternalUseOnly, setKeyFg, setKeyWord, setLazyLoadFg, setLinkDisplayName, setLinkedClass, setLinkedTounchOnChange, setMandatory, setMaxLength, setName, setNotes, setObscureFg, setOnChangeField, setOnChangeFormula, setOnChangePath, setOnChangeValue, setPlaceholder, setRecordRecentLinks, setSampleBadValues, setSampleValues, setSampleValuesDelimiter, setSearchFg, setSubType, setType, setUnique, setValidateMaxValue, setValidateMinValue, setValidationFormula, setValidationMessage, setValidationMsg, setValidationRegularExpression, sortLayerArray, sTypeName, toString

Methods inherited from class com.aspc.DBObj.DBObject

addReloadEventListener, archiveCheck, autoEnterCreate, calculateValue, calculateValue, calculateValue, callingRestoreByJournal, changeThreadMode, checkCreateAccess, checkDelete, checkDeleteAccess, checkModifyAccess, checkModifyAccess, checkReadAccess, copy, copyFields, copyIncludeField, copyInwardLinks, delete, denormalizedResult, displayLogName, displayValue, doSearch, dump, equals, eventDataLoaded, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extGetDerivedGlobalKey, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPreValidate, 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, touch, undelete, validateField, validateRecord, validateSubType

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Detail

DBRawField

public DBRawField(DBClass def,
                  GlobalKey id,
                  GlobalKey classGid,
                  GlobalKey rootClassKey,
                  java.lang.String name,
                  java.lang.String description,
                  java.lang.String type,
                  boolean keyFg,
                  boolean searchFg,
                  boolean derivedFg,
                  boolean incrementalFg,
                  boolean mandatoryFg,
                  java.lang.String autoEnterVal,
                  DataSource dataSource,
                  long rowId,
                  boolean uniqueFg,
                  java.lang.String subType,
                  boolean keyWordFg)
           throws java.lang.Exception

Creates new DBRawField.

Parameters:

def - the class

id -

classGid -

rootClassKey -

name -

description -

type - the type

keyFg -

searchFg -

derivedFg -

incrementalFg -

mandatoryFg -

autoEnterVal -

dataSource - the data source

rowId -

uniqueFg -

subType -

keyWordFg -

Throws:

java.lang.Exception - a serious problem

Method Detail

getName

@CheckReturnValue
public java.lang.String getName()

Description copied from class: DBField

A short method for getting the field name.

Overrides:

getName in class DBField

Returns:

the value

getDescription

@CheckReturnValue
public java.lang.String getDescription()

Description copied from class: DBField

The description of the field

Overrides:

getDescription in class DBField

Returns:

the value

getRawRowId

@CheckReturnValue
public long getRawRowId()

Returns:

the value

extGetValue

@CheckReturnValue
 @Nullable
protected java.lang.Object extGetValue(@Nullable
                                                                    DBField field,
                                                                    @Nullable
                                                                    FldParams params)

Description copied from class: DBObject

This is the PRIMARY "get" method which returns the processed field value for this object. If additional processing is require for a field the normal way of archiving this would be to declare it as derived and then add the processing to extGetDerivedValue but this method may be also overridden to add this additional functionality.

Please note: if a field is not declared DERIVED and the field value is changed by the overriding this method, a database search for this field may return unexpected results.
When overriding the extGetValue method the SAME value should be return. Examples of use are to blank fields that you don't have access to or to return ***** instead of the password. The database search uses getPureField which is final so you could do a search for a field value even if it is being blanked. Real security can only be given by creating an associated record and supplying a ACL to restrict access to it.

Overrides:

extGetValue in class DBObject

Parameters:

field - The field

params - the field parameters

Returns:

the value

getRawGlobalKey

@CheckReturnValue
 @Nullable
public GlobalKey getRawGlobalKey(@Nonnull
                                                              DBField field)

Parameters:

field - The field

Returns:

the value

isRawKey

@CheckReturnValue
public boolean isRawKey()

Returns:

the value

isDerived

@CheckReturnValue
public boolean isDerived()

Returns:

the value

isIncremental

@CheckReturnValue
public boolean isIncremental()

Description copied from class: DBField

Is this field marked as incremental ?

Overrides:

isIncremental in class DBField

Returns:

the value

isRawUnique

@CheckReturnValue
public boolean isRawUnique()

Returns:

the value

isRawMandatory

@CheckReturnValue
public boolean isRawMandatory()

Returns:

the value

isKeyWord

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

Description copied from class: DBField

Overrides:

isKeyWord in class DBField

Parameters:

args - The command line arguments

Returns:

the value

getRawGlobalKey

@CheckReturnValue
public GlobalKey getRawGlobalKey()

Returns:

the value

getClassGid

@CheckReturnValue
public GlobalKey getClassGid()

Returns:

the value

getBaseClassGid

@CheckReturnValue
public GlobalKey getBaseClassGid()

Description copied from class: DBField

The base class global id

Overrides:

getBaseClassGid in class DBField

Returns:

the value