DBField (stSoftware API)

java.lang.Object
- com.aspc.DBObj.DBObject
- - com.aspc.DBObj.DBField

All Implemented Interfaces:

SecondaryCacheGroup, java.util.Comparator

Direct Known Subclasses:

DBRawField, DBSpecialField
```
public class DBField
extends DBObject
implements java.util.Comparator
```
DBField is a field for a DBClass. DBField itself is a DBObject.
Generic DBObject.

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

Since:

August 9, 2000, 4:29 PM

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
`protected long`	`cacheRowId` The cache of the row id needed for performance reasons.
`static GlobalId`	`DBCLASS_GID` DBField
`static java.lang.String`	`DBCLASS_NAME` DBField
`static boolean`	`DISABLE_LAZY_LOAD` disabled the lazy load of data.
`static java.lang.String`	`PROPERTY_DISABLE_LAZY_LOAD` The property to disable the lazy load of data.
`static int`	`TYPE_BOOLEAN` Field type of Boolean
`static int`	`TYPE_CUSTOM` Field type of CUSTOM
`static int`	`TYPE_DATE` Field type of Date
`static int`	`TYPE_DOUBLE` Field type of Double
`static int`	`TYPE_INTEGER` Field type of Integer
`static int`	`TYPE_LONG` Field type of Long
`static int`	`TYPE_MULTILINGUAL` Field type of MultiLingual Text
`static int`	`TYPE_STRING` Field type of String
`static int`	`TYPE_TEXT` Field type of Text
`static int`	`TYPE_TIMESTAMP` Field type of DATETIME

Fields inherited from class com.aspc.DBObj.DBObject
ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors
Constructor and Description

DBField(DBClass def, DataSource dataSource)
Std.

Constructors
Constructor and Description
`DBField(DBClass def, DataSource dataSource)` Std.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canParentClearChild()` Can the delete of the parent record clear this field.
`boolean`	`canParentRemoveChild()` When the linked object is deleted, is this object automatically removed.
`protected void`	`clearCache(GlobalKey changedKey)` Clear out all cached data.
`int`	`compare(java.lang.Object inValue, java.lang.Object inCmpValue)` compare one object to another
`static DBField`	`create(MutableDataSource mds)` Make a new instance of this class.
`boolean`	`disableFieldRecycler(java.lang.String... args)`
`boolean`	`disableJournalData(java.lang.String... args)`
`java.lang.String`	`displayName()` Get the label for this field.
`protected void`	`eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params)` update dependent fields.
`protected void`	`extCheckModifyAccess(DBField field)` Can this field be modified ?
`protected void`	`extFixUp()` The extended fix up routine for known problems.
`protected java.lang.Object`	`extGetDerivedValue(DBField field, FldParams params)` Returns the derived value of this field.
`protected void`	`extPostSaveRecord(long transNr)` mark the index as dirty if this is a searchable field
`protected void`	`extPreDeleteRecord()` touch the interface if we are adding or deleting fields
`protected void`	`extPreSaveRecord()` touch the interface if we are adding or deleting fields
`protected ValidationError`	`extValidateField(DBField field, ValidationList list)` Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.
`AutoEnterPredefined`	`findAutoEnterPreDefined(java.lang.String... args)` System defined auto enter type.
`DBClassAbstract`	`findClassGid(java.lang.String... args)` The DBClass for this field.
`static DBField`	`findKey(DataSource ds, int key)` Find the target for this class by the primary key
`DBClassAbstract`	`findLinkedClass(java.lang.String... args)` The DBClass that this field points.
`DBClass`	`findLinkedDBClass()` The class that this field is linked to.
`DBField`	`findOnChangeField(java.lang.String... args)` When this field changes auto enter the onChange Formula/Value.
`DBFieldSubType`	`findSubType(java.lang.String... args)` subcategory type.
`DBMessage`	`findValidationMessage(java.lang.String... args)` The validation message.
`DBFormula`	`getAutoEnterFormula()` The auto enter formula for this field
`AutoEnterPredefined`	`getAutoEnterPreDefined(java.lang.String... args)`
`java.lang.String`	`getAutoEnterValue(java.lang.String... args)`
`java.lang.String`	`getAutoFillPredefinedValue()` Predefined auto fill values.
`java.lang.String`	`getAutoFillValue()` The auto fill value.
`GlobalKey`	`getBaseClassGid()` The base class global id
`DBClass`	`getBaseDBClass()` The base class for this field
`DBClassAbstract`	`getBaseDBClassAbstract()` The base class for this field
`DBClassAbstract`	`getClassGid(java.lang.String... args)`
`java.lang.String`	`getDeprecatedTx(java.lang.String... args)`
`java.lang.String`	`getDescription()` The description of the field
`java.lang.String`	`getDisplayFormat(java.lang.String... args)`
`java.lang.String`	`getDisplayName(java.lang.String... args)`
`java.lang.String`	`getDisplayType(java.lang.String... args)`
`java.lang.String`	`getFactoryJavaClass(java.lang.String... args)`
`GlobalKeyId`	`getFieldId()` The global ID for the field
`DBFormula`	`getFormula()` Get the formula for this field.
`int`	`getID(java.lang.String... args)`
`int`	`getIncrementalCacheSize(java.lang.String... args)`
`java.lang.String`	`getIndexPrefix()` The raw index table for this field.
`java.lang.String`	`getKey()` A shorthand method to get the field 's key.
`LayerField`	`getLayerField(LayerField[] array)` INTERNAL ONLY: search and return the field layer data.
`java.lang.String`	`getLinkDisplayName(java.lang.String... args)`
`DBClassAbstract`	`getLinkedClass(java.lang.String... args)`
`DBClass`	`getLinkedDBClass()` The class that this field is linked to.
`DBClassAbstract`	`getLinkedDBClassAbstract()` The class that this field is linked to.
`DBClassConcrete`	`getLinkedDBClassConcrete()` The class that this field is linked to.
`GlobalKeyId`	`getLinkedDBClassRootId()` The class that this field is linked to.
`int`	`getMaxLength(java.lang.String... args)`
`java.lang.String`	`getName()` A short method for getting the field name.
`java.lang.String`	`getNotes(java.lang.String... args)`
`DBField`	`getOnChangeField(java.lang.String... args)`
`java.lang.String`	`getOnChangeFormula(java.lang.String... args)`
`java.lang.String`	`getOnChangePath(java.lang.String... args)`
`java.lang.String`	`getOnChangeValue(java.lang.String... args)`
`java.lang.String`	`getPlaceholder(java.lang.String... args)`
`long`	`getRecycleCount()` The count of recycled values
`java.lang.String`	`getSampleBadValues(java.lang.String... args)`
`java.lang.String`	`getSampleValues(java.lang.String... args)`
`java.lang.String`	`getSampleValuesDelimiter(java.lang.String... args)`
`DBFieldSubType`	`getSubType(java.lang.String... args)`
`int`	`getType()` The field type
`java.lang.String`	`getUniqueKeyPrefix()` The key table name.
`DBField`	`getUpdateOnChangeField()` The update on change field.
`DBFormula`	`getUpdateOnChangeFormula()` The on change formula.
`Path`	`getUpdateOnChangePath()` The on change path
`java.lang.String`	`getUpdateOnChangeValue()` The on change value
`java.lang.String`	`getValidateMaxValue(java.lang.String... args)`
`java.lang.String`	`getValidateMinValue(java.lang.String... args)`
`DBFormula`	`getValidationFormula()` Get the validation formula
`DBMessage`	`getValidationMessage(java.lang.String... args)`
`java.lang.String`	`getValidationMsg(java.lang.String... args)`
`java.lang.String`	`getValidationRegularExpression(java.lang.String... args)`
`boolean`	`hasAutoEnterFormula()` Does this field have an auto enter formula ?
`boolean`	`hasValidationFormula()` Does this field have an validation formula ?
`boolean`	`isArray()` Is this field marked as an Array.
`boolean`	`isArrayFg(java.lang.String... args)`
`boolean`	`isArrayNoCache(java.lang.String... args)`
`boolean`	`isDeprecated(java.lang.String... args)`
`boolean`	`isDerivedFg(java.lang.String... args)`
`boolean`	`isEncrypted()` Is this field marked as encrypted.
`boolean`	`isEncryptedFg(java.lang.String... args)`
`boolean`	`isFinalFg(java.lang.String... args)`
`boolean`	`isInClass(java.lang.String... args)`
`boolean`	`isIncremental()` Is this field marked as incremental ?
`boolean`	`isIncrementalFg(java.lang.String... args)`
`boolean`	`isIndexable()` Is the field indexable ?
`boolean`	`isInternalUseOnly(java.lang.String... args)`
`boolean`	`isKey()` Is this the key field.
`boolean`	`isKeyFg(java.lang.String... args)`
`boolean`	`isKeyWord(java.lang.String... args)`
`boolean`	`isLazyLoad()` Is this field marked as lazy load ? .
`boolean`	`isLazyLoadFg(java.lang.String... args)`
`boolean`	`isLinked()` Is this field linked ? Make this very fast
`boolean`	`isLinkedTounchOnChange(java.lang.String... args)`
`boolean`	`isMandatory()` Is this field marked as mandatory.
`boolean`	`isMultiLingual()` Is this field multilingual ?
`boolean`	`isNumber()` is this field a number(float, integer or long) field?
`boolean`	`isObscure()` Is this field marked as obscure.
`boolean`	`isObscureFg(java.lang.String... args)`
`boolean`	`isRecordingRecentLinks()` Should we record the recent links ?
`boolean`	`isRecordRecentLinks(java.lang.String... args)`
`boolean`	`isRuntimeEval()` A field is runtime evaluated if it has a formula or if it is flagged as derived.
`boolean`	`isSearchable()` If marked as searchable or a key field or linked to another class.
`boolean`	`isSearchFg(java.lang.String... args)`
`boolean`	`isUnique()` Is the field marked as unique ?
`static java.lang.String`	`makeDisplayName(java.lang.String fieldName)` converts a single mixed case word into multiple words based on the change of case.
`FieldValueFactory`	`makeFactory()` make factory for this field.
`java.lang.String`	`makeFormattedString(DataSource ds, java.lang.Object inValue, java.lang.String specificFormat, FldParams params)` Make a formatted version of the value
`static DBQuery<DBField>`	`makeQuery(DataSource ds)` Make a new QUERY for this class.
`long`	`makeRowId()` Get & Cache the row id
`java.lang.String`	`makeSQLKeyString(DataSource ds, java.lang.Object inValue)` Convert the value to the SQL key format.
`java.lang.String`	`makeSQLString(DataSource ds, java.lang.Object value)` Varchar(255)
`java.lang.String`	`makeString(DataSource ds, java.lang.Object inValue)` Make a string version of the passed value
`java.lang.Object`	`parse(DataSource ds, java.lang.Object inData)` Parse the object to be the object type of this field.
`java.lang.Object`	`preparedSQLKeyString(DataSource ds, java.lang.Object inValue)` Convert the value to the SQL key format.
`LayerField`	`recycle(LayerField lf)` Recycle the layer field.
`DBField`	`setArrayFg(boolean value, java.lang.String... args)`
`DBField`	`setArrayNoCache(boolean value, java.lang.String... args)`
`DBField`	`setAutoEnterFormula(java.lang.String value, java.lang.String... args)`
`DBField`	`setAutoEnterPreDefined(com.aspc.dal.dbobj.misc.AutoEnterPredefined value, java.lang.String... args)`
`DBField`	`setAutoEnterValue(java.lang.String value, java.lang.String... args)`
`DBField`	`setCanParentClearChild(boolean value, java.lang.String... args)`
`DBField`	`setCanParentRemoveChild(boolean value, java.lang.String... args)`
`DBField`	`setClassGid(com.aspc.dal.dbobj.DBClassAbstract value, java.lang.String... args)`
`DBField`	`setDeprecated(boolean value, java.lang.String... args)`
`DBField`	`setDeprecatedTx(java.lang.String value, java.lang.String... args)`
`DBField`	`setDerivedFg(boolean value, java.lang.String... args)`
`DBField`	`setDescription(java.lang.String value, java.lang.String... args)`
`DBField`	`setDisableFieldRecycler(boolean value, java.lang.String... args)`
`DBField`	`setDisableJournalData(boolean value, java.lang.String... args)`
`DBField`	`setDisplayFormat(java.lang.String value, java.lang.String... args)`
`DBField`	`setDisplayName(java.lang.String value, java.lang.String... args)`
`DBField`	`setEncryptedFg(boolean value, java.lang.String... args)`
`DBField`	`setFactoryJavaClass(java.lang.String value, java.lang.String... args)`
`DBField`	`setFinalFg(boolean value, java.lang.String... args)`
`DBField`	`setFormula(java.lang.String value, java.lang.String... args)`
`DBField`	`setID(int value, java.lang.String... args)`
`DBField`	`setIncrementalCacheSize(int value, java.lang.String... args)`
`DBField`	`setIncrementalFg(boolean value, java.lang.String... args)`
`DBField`	`setInternalUseOnly(boolean value, java.lang.String... args)`
`DBField`	`setKeyFg(boolean value, java.lang.String... args)`
`DBField`	`setKeyWord(boolean value, java.lang.String... args)`
`DBField`	`setLazyLoadFg(boolean value, java.lang.String... args)`
`DBField`	`setLinkDisplayName(java.lang.String value, java.lang.String... args)`
`DBField`	`setLinkedClass(com.aspc.dal.dbobj.DBClassAbstract value, java.lang.String... args)`
`DBField`	`setLinkedTounchOnChange(boolean value, java.lang.String... args)`
`DBField`	`setMandatory(boolean value, java.lang.String... args)`
`DBField`	`setMaxLength(int value, java.lang.String... args)`
`DBField`	`setName(java.lang.String value, java.lang.String... args)`
`DBField`	`setNotes(java.lang.String value, java.lang.String... args)`
`DBField`	`setObscureFg(boolean value, java.lang.String... args)`
`DBField`	`setOnChangeField(com.aspc.dal.dbobj.DBField value, java.lang.String... args)`
`DBField`	`setOnChangeFormula(java.lang.String value, java.lang.String... args)`
`DBField`	`setOnChangePath(java.lang.String value, java.lang.String... args)`
`DBField`	`setOnChangeValue(java.lang.String value, java.lang.String... args)`
`DBField`	`setPlaceholder(java.lang.String value, java.lang.String... args)`
`DBField`	`setRecordRecentLinks(boolean value, java.lang.String... args)`
`DBField`	`setSampleBadValues(java.lang.String value, java.lang.String... args)`
`DBField`	`setSampleValues(java.lang.String value, java.lang.String... args)`
`DBField`	`setSampleValuesDelimiter(java.lang.String value, java.lang.String... args)`
`DBField`	`setSearchFg(boolean value, java.lang.String... args)`
`DBField`	`setSubType(com.aspc.dal.dbobj.misc.DBFieldSubType value, java.lang.String... args)`
`DBField`	`setType(com.aspc.dal.dbobj.misc.FieldTypes value, java.lang.String... args)`
`DBField`	`setUnique(boolean value, java.lang.String... args)`
`DBField`	`setValidateMaxValue(java.lang.String value, java.lang.String... args)`
`DBField`	`setValidateMinValue(java.lang.String value, java.lang.String... args)`
`DBField`	`setValidationFormula(java.lang.String value, java.lang.String... args)`
`DBField`	`setValidationMessage(com.aspc.dal.message.DBMessage value, java.lang.String... args)`
`DBField`	`setValidationMsg(java.lang.String value, java.lang.String... args)`
`DBField`	`setValidationRegularExpression(java.lang.String value, java.lang.String... args)`
`static void`	`sortLayerArray(LayerField[] array)` Sort the layer data.
`static java.lang.String`	`sTypeName(int type)` The human name for this field type
`java.lang.String`	`toString()` The display name of this field

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

Field Detail
- DBCLASS_NAME
```
public static final java.lang.String DBCLASS_NAME
```
  DBField
  
  See Also:
  
  Constant Field Values
- DBCLASS_GID
```
public static final GlobalId DBCLASS_GID
```
  DBField
- PROPERTY_DISABLE_LAZY_LOAD
```
public static final java.lang.String PROPERTY_DISABLE_LAZY_LOAD
```
  The property to disable the lazy load of data.
  
  See Also:
  
  Constant Field Values
- DISABLE_LAZY_LOAD
```
public static final boolean DISABLE_LAZY_LOAD
```
  disabled the lazy load of data.
- TYPE_INTEGER
```
public static final int TYPE_INTEGER
```
  Field type of Integer
  
  See Also:
  
  Constant Field Values
- TYPE_DOUBLE
```
public static final int TYPE_DOUBLE
```
  Field type of Double
  
  See Also:
  
  Constant Field Values
- TYPE_BOOLEAN
```
public static final int TYPE_BOOLEAN
```
  Field type of Boolean
  
  See Also:
  
  Constant Field Values
- TYPE_DATE
```
public static final int TYPE_DATE
```
  Field type of Date
  
  See Also:
  
  Constant Field Values
- TYPE_TIMESTAMP
```
public static final int TYPE_TIMESTAMP
```
  Field type of DATETIME
  
  See Also:
  
  Constant Field Values
- TYPE_STRING
```
public static final int TYPE_STRING
```
  Field type of String
  
  See Also:
  
  Constant Field Values
- TYPE_TEXT
```
public static final int TYPE_TEXT
```
  Field type of Text
  
  See Also:
  
  Constant Field Values
- TYPE_LONG
```
public static final int TYPE_LONG
```
  Field type of Long
  
  See Also:
  
  Constant Field Values
- TYPE_MULTILINGUAL
```
public static final int TYPE_MULTILINGUAL
```
  Field type of MultiLingual Text
  
  See Also:
  
  Constant Field Values
- TYPE_CUSTOM
```
public static final int TYPE_CUSTOM
```
  Field type of CUSTOM
  
  See Also:
  
  Constant Field Values
- cacheRowId
```
protected long cacheRowId
```
  The cache of the row id needed for performance reasons.

Constructor Detail
- DBField
```
public DBField(@Nonnull
               DBClass def,
               @Nonnull
               DataSource dataSource)
        throws java.lang.Exception
```
  Std. DBObject constructor. TODO - Why have a constructor def and dataSource def should have dataSource
  
  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 DBField setID(int value,
                              java.lang.String... args)
                       throws java.lang.Exception

Throws:: java.lang.Exception

isArrayFg

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

setArrayFg

@Nonnull
public DBField setArrayFg(boolean value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:: java.lang.Exception

isArrayNoCache

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

setArrayNoCache

@Nonnull
public DBField setArrayNoCache(boolean value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:: java.lang.Exception

setAutoEnterFormula

@Nonnull
public DBField setAutoEnterFormula(java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:: java.lang.Exception

getAutoEnterPreDefined

@CheckReturnValue
 @Nullable
public AutoEnterPredefined getAutoEnterPreDefined(java.lang.String... args)

findAutoEnterPreDefined
```
@CheckReturnValue
 @Nonnull
public final AutoEnterPredefined findAutoEnterPreDefined(java.lang.String... args)
                                                                              throws NotFoundException
```
System defined auto enter type. These include "Modified By User", "Create Time"

When a new instance of a DBClass is created all fields with an auto enter items will be populated. The DBObject is not considered as changed if only auto enter values are entered.

--> AutoEnterPredefined (String, Searchable)

Parameters:

args - the optional arguments

Returns:

AutoEnterPredefined

Throws:

NotFoundException - AutoEnterPredefined was not found

setAutoEnterPreDefined

@Nonnull
public DBField setAutoEnterPreDefined(com.aspc.dal.dbobj.misc.AutoEnterPredefined value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:: java.lang.Exception

getAutoEnterValue

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

setAutoEnterValue

@Nonnull
public DBField setAutoEnterValue(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:: java.lang.Exception

setCanParentClearChild

@Nonnull
public DBField setCanParentClearChild(boolean value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:: java.lang.Exception

setCanParentRemoveChild

@Nonnull
public DBField setCanParentRemoveChild(boolean value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:: java.lang.Exception

getClassGid

@CheckReturnValue
 @Nullable
public DBClassAbstract getClassGid(java.lang.String... args)

findClassGid
```
@CheckReturnValue
 @Nonnull
public final DBClassAbstract findClassGid(java.lang.String... args)
                                                               throws NotFoundException
```
The DBClass for this field. A DBClass may consist of one or many DBFields. Only one field maybe a key.

--> DBClassAbstract (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

DBClassAbstract

Throws:

NotFoundException - DBClassAbstract was not found

setClassGid

@Nonnull
public DBField setClassGid(com.aspc.dal.dbobj.DBClassAbstract value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:: java.lang.Exception

isDeprecated

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

setDeprecated

@Nonnull
public DBField setDeprecated(boolean value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:: java.lang.Exception

getDeprecatedTx

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

setDeprecatedTx

@Nonnull
public DBField setDeprecatedTx(java.lang.String value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:: java.lang.Exception

isDerivedFg

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

setDerivedFg

@Nonnull
public DBField setDerivedFg(boolean value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:: java.lang.Exception

setDescription

@Nonnull
public DBField setDescription(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:: java.lang.Exception

disableFieldRecycler

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

setDisableFieldRecycler

@Nonnull
public DBField setDisableFieldRecycler(boolean value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:: java.lang.Exception

disableJournalData

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

setDisableJournalData

@Nonnull
public DBField setDisableJournalData(boolean 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 DBField setDisplayFormat(java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:: java.lang.Exception

getDisplayName

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

setDisplayName

@Nonnull
public DBField setDisplayName(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:: java.lang.Exception

getDisplayType

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

isEncryptedFg

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

setEncryptedFg

@Nonnull
public DBField setEncryptedFg(boolean value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:: java.lang.Exception

getFactoryJavaClass

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

setFactoryJavaClass

@Nonnull
public DBField setFactoryJavaClass(java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:: java.lang.Exception

isFinalFg

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

setFinalFg

@Nonnull
public DBField setFinalFg(boolean value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:: java.lang.Exception

setFormula

@Nonnull
public DBField setFormula(java.lang.String value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:: java.lang.Exception

getIncrementalCacheSize

@CheckReturnValue
 @Nonnegative
public int getIncrementalCacheSize(java.lang.String... args)

setIncrementalCacheSize

@Nonnull
public DBField setIncrementalCacheSize(int value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:: java.lang.Exception

isIncrementalFg

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

setIncrementalFg

@Nonnull
public DBField setIncrementalFg(boolean value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:: java.lang.Exception

isInternalUseOnly

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

setInternalUseOnly

@Nonnull
public DBField setInternalUseOnly(boolean value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:: java.lang.Exception

isInClass

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

isKeyFg

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

setKeyFg

@Nonnull
public DBField setKeyFg(boolean value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:: java.lang.Exception

isKeyWord

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

setKeyWord

@Nonnull
public DBField setKeyWord(boolean value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:: java.lang.Exception

isLazyLoadFg

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

setLazyLoadFg

@Nonnull
public DBField setLazyLoadFg(boolean value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:: java.lang.Exception

getLinkDisplayName

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

setLinkDisplayName

@Nonnull
public DBField setLinkDisplayName(java.lang.String value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:: java.lang.Exception

getLinkedClass

@CheckReturnValue
 @Nullable
public DBClassAbstract getLinkedClass(java.lang.String... args)

findLinkedClass
```
@CheckReturnValue
 @Nonnull
public final DBClassAbstract findLinkedClass(java.lang.String... args)
                                                                  throws NotFoundException
```
The DBClass that this field points.

--> DBClassAbstract (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

DBClassAbstract

Throws:

NotFoundException - DBClassAbstract was not found

setLinkedClass

@Nonnull
public DBField setLinkedClass(com.aspc.dal.dbobj.DBClassAbstract value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:: java.lang.Exception

isLinkedTounchOnChange

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

setLinkedTounchOnChange

@Nonnull
public DBField setLinkedTounchOnChange(boolean value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:: java.lang.Exception

setMandatory

@Nonnull
public DBField setMandatory(boolean value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:: java.lang.Exception

getMaxLength

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

setMaxLength

@Nonnull
public DBField setMaxLength(int value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:: java.lang.Exception

setName

@Nonnull
public DBField setName(java.lang.String value,
                                java.lang.String... args)
                         throws java.lang.Exception

Throws:: java.lang.Exception

getNotes

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

setNotes

@Nonnull
public DBField setNotes(java.lang.String value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:: java.lang.Exception

isObscureFg

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

setObscureFg

@Nonnull
public DBField setObscureFg(boolean value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:: java.lang.Exception

getOnChangeField

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

findOnChangeField
```
@CheckReturnValue
 @Nonnull
public final DBField findOnChangeField(java.lang.String... args)
                                                            throws NotFoundException
```
When this field changes auto enter the onChange Formula/Value.

--> DBField (String)

Parameters:

args - the optional arguments

Returns:

DBField

Throws:

NotFoundException - DBField was not found

setOnChangeField

@Nonnull
public DBField setOnChangeField(com.aspc.dal.dbobj.DBField value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:: java.lang.Exception

getOnChangeFormula

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

setOnChangeFormula

@Nonnull
public DBField setOnChangeFormula(java.lang.String value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:: java.lang.Exception

getOnChangePath

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

setOnChangePath

@Nonnull
public DBField setOnChangePath(java.lang.String value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:: java.lang.Exception

getOnChangeValue

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

setOnChangeValue

@Nonnull
public DBField setOnChangeValue(java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:: java.lang.Exception

getPlaceholder

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

setPlaceholder

@Nonnull
public DBField setPlaceholder(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:: java.lang.Exception

isRecordRecentLinks

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

setRecordRecentLinks

@Nonnull
public DBField setRecordRecentLinks(boolean value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:: java.lang.Exception

getSampleBadValues

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

setSampleBadValues

@Nonnull
public DBField setSampleBadValues(java.lang.String value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:: java.lang.Exception

getSampleValues

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

setSampleValues

@Nonnull
public DBField setSampleValues(java.lang.String value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:: java.lang.Exception

getSampleValuesDelimiter

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

setSampleValuesDelimiter

@Nonnull
public DBField setSampleValuesDelimiter(java.lang.String value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:: java.lang.Exception

isSearchFg

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

setSearchFg

@Nonnull
public DBField setSearchFg(boolean value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:: java.lang.Exception

getSubType

@CheckReturnValue
 @Nullable
public DBFieldSubType getSubType(java.lang.String... args)

findSubType

@CheckReturnValue
 @Nonnull
public final DBFieldSubType findSubType(java.lang.String... args)
                                                             throws NotFoundException

subcategory type.

--> DBFieldSubType (String, Searchable)

Parameters:: args - the optional arguments
Returns:: Field Sub type
Throws:: NotFoundException - DBFieldSubType was not found

setSubType

@Nonnull
public DBField setSubType(com.aspc.dal.dbobj.misc.DBFieldSubType value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:: java.lang.Exception

setType

@Nonnull
public DBField setType(com.aspc.dal.dbobj.misc.FieldTypes value,
                                java.lang.String... args)
                         throws java.lang.Exception

Throws:: java.lang.Exception

setUnique

@Nonnull
public DBField setUnique(boolean value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:: java.lang.Exception

getValidateMaxValue

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

setValidateMaxValue

@Nonnull
public DBField setValidateMaxValue(java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:: java.lang.Exception

getValidateMinValue

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

setValidateMinValue

@Nonnull
public DBField setValidateMinValue(java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:: java.lang.Exception

setValidationFormula

@Nonnull
public DBField setValidationFormula(java.lang.String value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:: java.lang.Exception

getValidationMessage

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

findValidationMessage

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

The validation message.

--> DBMessage (String, Searchable)

Parameters:: args - the optional arguments
Returns:: Message
Throws:: NotFoundException - DBMessage was not found

setValidationMessage

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

Throws:: java.lang.Exception

getValidationMsg

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

setValidationMsg

@Nonnull
public DBField setValidationMsg(java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:: java.lang.Exception

getValidationRegularExpression

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

setValidationRegularExpression

@Nonnull
public DBField setValidationRegularExpression(java.lang.String value,
                                                       java.lang.String... args)
                                                throws java.lang.Exception

Throws:: java.lang.Exception

create

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

getFieldId

@CheckReturnValue
 @Nonnull
public final GlobalKeyId getFieldId()

The global ID for the field

Returns:: The global ID

canParentRemoveChild
```
@CheckReturnValue
public boolean canParentRemoveChild()
```
When the linked object is deleted, is this object automatically removed.

Returns:

True if we should auto delete.

canParentClearChild
```
@CheckReturnValue
public boolean canParentClearChild()
```
Can the delete of the parent record clear this field.

Returns:

TRUE if it maybe cleared.

displayName
```
@CheckReturnValue
 @Nonnull
public java.lang.String displayName()
```
Get the label for this field.

Overrides:

displayName in class DBObject

Returns:

the label.

getKey
```
@CheckReturnValue
 @Nonnull
public final java.lang.String getKey()
```
A shorthand method to get the field 's key.

Returns:

The field 's key

isNumber
```
@CheckReturnValue
public boolean isNumber()
```
is this field a number(float, integer or long) field?

Returns:

the value

isMultiLingual
```
@CheckReturnValue
public boolean isMultiLingual()
```
Is this field multilingual ?

Returns:

TRUE if this field is multilingual.

extFixUp
```
@OverridingMethodsMustInvokeSuper
protected void extFixUp()
                                                   throws java.lang.Exception
```
The extended fix up routine for known problems. This routine will be called by the method fixUp() in DBObject.

Overrides:

extFixUp in class DBObject

Throws:

java.lang.Exception - a serious problem

extValidateField
```
@CheckReturnValue
 @OverridingMethodsMustInvokeSuper
 @Nullable
protected ValidationError extValidateField(@Nonnull
                                                                                                           DBField field,
                                                                                                           @Nonnull
                                                                                                           ValidationList list)
                                                                                                    throws java.lang.Exception
```
Description copied from class: DBObject

Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.

OVERRIDE this method to add validation to a field but call iValidateField to perform the full validation for a field.

This method should be READ ONLY. Don't create DBObjects here.
When overriding this method the following code stub should be used.
ValidationError ve;
ve = super.extValidateField( field, list);
if( ve != null) return ve;
if( field.getName().equalsIgnoreCase( DBFIELD_FIELD1))
{
return list.createError( DBMessage.LIST_DB_MY_ERROR, this, field);
}
else if( field.getName().equalsIgnoreCase( DBFIELD_FIELD2))
{
....
}

Overrides:

extValidateField in class DBObject

Parameters:

field - The field to be validated

list - The validation list

Returns:

the error or warning.

Throws:

java.lang.Exception - a serious error

getUniqueKeyPrefix
```
@CheckReturnValue
 @Nonnull
public final java.lang.String getUniqueKeyPrefix()
                                                                      throws NotFoundException
```
The key table name. NB: Sybase as of version 12.5 does not support timezone so we must store the TIMESTAMP fields in milliseconds
from GMT. If we doing it for TIMESTAMP I'll also do it for DATES.

Returns:

The table name

Throws:

NotFoundException - A serious problem.

getIndexPrefix

@CheckReturnValue
 @Nonnull
public final java.lang.String getIndexPrefix()
                                                                  throws NotFoundException

The raw index table for this field.

Returns:: The table name.
Throws:: NotFoundException - A serious problem

makeSQLString

@CheckReturnValue
 @Nonnull
public java.lang.String makeSQLString(@Nonnull
                                                                  DataSource ds,
                                                                  @Nonnull
                                                                  java.lang.Object value)
                                                           throws java.lang.Exception

Varchar(255)

Parameters:: ds - The datasource to use; value - The value to parse.
Returns:: The SQL version of the value
Throws:: java.lang.Exception - A serious problem.

makeSQLKeyString

@CheckReturnValue
 @Nullable
public java.lang.String makeSQLKeyString(@Nonnull
                                                                      DataSource ds,
                                                                      @Nullable
                                                                      java.lang.Object inValue)
                                                               throws java.lang.Exception

Convert the value to the SQL key format.

Parameters:: ds - The datasource to use; inValue - The value to parse
Returns:: The SQL key format
Throws:: java.lang.Exception - A serious problem

preparedSQLKeyString

@CheckReturnValue
 @Nullable
public java.lang.Object preparedSQLKeyString(@Nonnull
                                                                          DataSource ds,
                                                                          @Nullable
                                                                          java.lang.Object inValue)
                                                                   throws java.lang.Exception

Convert the value to the SQL key format.

Parameters:: ds - The datasource to use; inValue - The value to parse
Returns:: The SQL key format
Throws:: java.lang.Exception - A serious problem

makeFormattedString

@CheckReturnValue
 @Nonnull
public java.lang.String makeFormattedString(@Nonnull
                                                                        DataSource ds,
                                                                        @Nullable
                                                                        java.lang.Object inValue,
                                                                        @Nullable
                                                                        java.lang.String specificFormat,
                                                                        @Nullable
                                                                        FldParams params)

Make a formatted version of the value

Parameters:: params - The field parameters to used ( TIMEZONE for one); ds - The datasource to use; inValue - The value to parse; specificFormat - The format to use.
Returns:: The formatted value

getRecycleCount
```
@CheckReturnValue
public long getRecycleCount()
```
The count of recycled values

Returns:

The count of values that were recycled.

recycle

@CheckReturnValue
 @Nonnull
public LayerField recycle(@Nonnull
                                                      LayerField lf)

Recycle the layer field.

Parameters:: lf - the field layer
Returns:: The recycled field layer.

makeString

@CheckReturnValue
 @Nonnull
public java.lang.String makeString(@Nonnull
                                                               DataSource ds,
                                                               @Nullable
                                                               java.lang.Object inValue)

Make a string version of the passed value

Parameters:: ds - The datasource to use.; inValue - The value to parse.
Returns:: The string

parse

@CheckReturnValue
 @Nullable
public java.lang.Object parse(@Nonnull
                                                           DataSource ds,
                                                           @Nullable
                                                           java.lang.Object inData)
                                                    throws java.lang.Exception

Parse the object to be the object type of this field.

Parameters:: ds - The data source to use; inData - The data to parse.
Returns:: the parsed object
Throws:: java.lang.Exception - A serious problem

sTypeName
```
@CheckReturnValue
 @Nonnull
public static java.lang.String sTypeName(int type)
```
The human name for this field type

Parameters:

type - The field type

Returns:

The field type name

getBaseDBClass

@CheckReturnValue
 @Nullable
public DBClass getBaseDBClass()

The base class for this field

Returns:: The base class

getBaseDBClassAbstract

@CheckReturnValue
 @Nullable
public DBClassAbstract getBaseDBClassAbstract()

The base class for this field

Returns:: The base class

getBaseClassGid

@CheckReturnValue
 @Nullable
public GlobalKey getBaseClassGid()

The base class global id

Returns:: the base class

getLayerField

@Nullable
public final LayerField getLayerField(@Nullable
                                                LayerField[] array)

INTERNAL ONLY: search and return the field layer data.

Parameters:: array - The sorted array of layer data.
Returns:: The layer data, NULL if not found.

extCheckModifyAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckModifyAccess(@Nonnull
                                                                      DBField field)
                                                               throws DBAccessException

Can this field be modified ?

Overrides:: extCheckModifyAccess in class DBObject
Parameters:: field - The field to check.
Throws:: DBAccessException - The access exception if you may not modify the field.

extGetDerivedValue

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

Returns the derived value of this field.

Derived values are never stored in the database.

Overrides:: extGetDerivedValue in class DBObject
Parameters:: params - The field parameters.; field - The field to get
Returns:: The derived value.
Throws:: java.lang.Exception - A serious problem

extPostSaveRecord
```
@OverridingMethodsMustInvokeSuper
protected void extPostSaveRecord(@Nonnegative
                                                                   long transNr)
```
mark the index as dirty if this is a searchable field

Overrides:

extPostSaveRecord in class DBObject

Parameters:

transNr - The current transaction number.

compare

@CheckReturnValue
public int compare(@Nonnull
                                     java.lang.Object inValue,
                                     @Nonnull
                                     java.lang.Object inCmpValue)

compare one object to another

Specified by:: compare in interface java.util.Comparator
Parameters:: inValue - first value; inCmpValue - second value
Returns:: 0 if equal

getName
```
@CheckReturnValue
 @Nonnull
public java.lang.String getName()
```
A short method for getting the field name.

Returns:

the name.

getDescription

@CheckReturnValue
 @Nonnull
public java.lang.String getDescription()

The description of the field

Returns:: The description

getType

@CheckReturnValue
public final int getType()

The field type

Returns:: The type.

isSearchable
```
@CheckReturnValue
public final boolean isSearchable()
```
If marked as searchable or a key field or linked to another class.

Returns:

true if this field is searchable.

isIndexable
```
@CheckReturnValue
public final boolean isIndexable()
```
Is the field indexable ?

Returns:

TRUE if indexable ?

isRuntimeEval
```
@CheckReturnValue
public final boolean isRuntimeEval()
```
A field is runtime evaluated if it has a formula or if it is flagged as derived. If it is flagged as derived it is expected that the programmer will supply a method for returning the field value.

Returns:

TRUE if a derived field or formula field.

isIncremental
```
@CheckReturnValue
public boolean isIncremental()
```
Is this field marked as incremental ?

Returns:

TRUE if the field is incremental.

isKey
```
@CheckReturnValue
public final boolean isKey()
```
Is this the key field.

Returns:

TRUE if the field is a key.

isUnique
```
@CheckReturnValue
public boolean isUnique()
```
Is the field marked as unique ?

Returns:

TRUE if unique.

isObscure
```
@CheckReturnValue
public final boolean isObscure()
```
Is this field marked as obscure.

Returns:

true if obscure.

isEncrypted
```
@CheckReturnValue
public final boolean isEncrypted()
```
Is this field marked as encrypted.

Returns:

true if encrypted.

isMandatory
```
@CheckReturnValue
public final boolean isMandatory()
```
Is this field marked as mandatory.

Returns:

true if mandatory.

isArray
```
@CheckReturnValue
public final boolean isArray()
```
Is this field marked as an Array.

Returns:

true if an Array.

isLazyLoad
```
@CheckReturnValue
public final boolean isLazyLoad()
```
Is this field marked as lazy load ? .

Returns:

true if lazy load.

getAutoFillValue

@CheckReturnValue
 @Nonnull
public java.lang.String getAutoFillValue()

The auto fill value.

Returns:: the value

getAutoFillPredefinedValue

@CheckReturnValue
 @Nonnull
public java.lang.String getAutoFillPredefinedValue()

Predefined auto fill values.

Returns:: The predefine value.

getUpdateOnChangeField

@CheckReturnValue
 @Nullable
public DBField getUpdateOnChangeField()

The update on change field.

Returns:: The field

getUpdateOnChangeValue

@CheckReturnValue
 @Nonnull
public java.lang.String getUpdateOnChangeValue()

The on change value

Returns:: The value

getUpdateOnChangePath

@CheckReturnValue
 @Nullable
public Path getUpdateOnChangePath()
                                                        throws InvalidPathException

The on change path

Returns:: The path
Throws:: InvalidPathException - The path is not valid

getUpdateOnChangeFormula

@CheckReturnValue
 @Nullable
public DBFormula getUpdateOnChangeFormula()
                                                                throws java.lang.Exception

The on change formula.

Returns:: The formula.
Throws:: java.lang.Exception - A serious problem

getLinkedDBClassRootId
```
@CheckReturnValue
 @Nullable
public GlobalKeyId getLinkedDBClassRootId()
```
The class that this field is linked to.

Returns:

The class that this field is linked to.

getLinkedDBClass
```
@CheckReturnValue
 @Nullable
public DBClass getLinkedDBClass()
```
The class that this field is linked to.

Returns:

The class that this field is linked to.

findLinkedDBClass

@CheckReturnValue
 @Nonnull
public DBClass findLinkedDBClass()
                                                      throws NotFoundException

The class that this field is linked to.

Returns:: The class that this field is linked to.
Throws:: NotFoundException - no such class

getLinkedDBClassConcrete
```
@CheckReturnValue
 @Nullable
public DBClassConcrete getLinkedDBClassConcrete()
```
The class that this field is linked to.

Returns:

The class that this field is linked to.

getLinkedDBClassAbstract
```
@CheckReturnValue
 @Nullable
public DBClassAbstract getLinkedDBClassAbstract()
```
The class that this field is linked to.

Returns:

The class that this field is linked to.

isRecordingRecentLinks
```
@CheckReturnValue
public final boolean isRecordingRecentLinks()
```
Should we record the recent links ?

Returns:

TRUE if we are recording.

isLinked
```
@CheckReturnValue
public final boolean isLinked()
```
Is this field linked ?

Make this very fast

Returns:

true if linked

getFormula

@CheckReturnValue
 @Nullable
public final DBFormula getFormula()
                                                        throws java.lang.Exception

Get the formula for this field.

Returns:: The formula
Throws:: java.lang.Exception - A serious problem

hasAutoEnterFormula
```
@CheckReturnValue
public boolean hasAutoEnterFormula()
                                              throws java.lang.Exception
```
Does this field have an auto enter formula ?

Returns:

TRUE if we have an auto enter formula.

Throws:

java.lang.Exception - A serious problem

getAutoEnterFormula

@CheckReturnValue
 @Nullable
public DBFormula getAutoEnterFormula()
                                                           throws java.lang.Exception

The auto enter formula for this field

Returns:: The formula
Throws:: java.lang.Exception - A serious problem.

hasValidationFormula
```
@CheckReturnValue
public boolean hasValidationFormula()
                                               throws java.lang.Exception
```
Does this field have an validation formula ?

Returns:

TRUE if has a validation formula

Throws:

java.lang.Exception - A serious problem

getValidationFormula

@CheckReturnValue
 @Nullable
public DBFormula getValidationFormula()
                                                            throws java.lang.Exception

Get the validation formula

Returns:: The formula.
Throws:: java.lang.Exception - A serious problem

toString
```
@CheckReturnValue
 @Nonnull
public java.lang.String toString()
```
The display name of this field

Overrides:

toString in class DBObject

Returns:

The display name.

eventFieldUpdated

@OverridingMethodsMustInvokeSuper
protected void eventFieldUpdated(@Nonnull
                                                                   DBField field,
                                                                   @Nullable
                                                                   java.lang.Object previous,
                                                                   @Nullable
                                                                   GlobalKey previousKey,
                                                                   @Nullable
                                                                   FldParams params)
                                                            throws java.lang.Exception

update dependent fields. 1) Check if anything has changed that requires the index to be mark as dirty

Overrides:: eventFieldUpdated in class DBObject
Parameters:: field - The field updated.; previous - The previous value for this field.; previousKey - The previous key; params - The parameters used
Throws:: java.lang.Exception - a serious problem

makeDisplayName

@CheckReturnValue
 @Nonnull
public static java.lang.String makeDisplayName(@Nonnull
                                                                           java.lang.String fieldName)

converts a single mixed case word into multiple words based on the change of case.

Parameters:: fieldName - The mixed case name to convert
Returns:: The multi word name.

clearCache
```
@OverridingMethodsMustInvokeSuper
protected void clearCache(@Nullable
                                                            GlobalKey changedKey)
```
Clear out all cached data. THREAD SAFE:

This threading model relies on the clearing of the cached items within
a synchronization block. The load of the cache item doesn't need to
be synchronized as it would just cause the multiple loading of the same element,
NO ERROR.

An article on javaworld about double lock checks has been taken into account
but there final argument for why this wouldn't work was due to a bug in the
Symantec compiler that is no longer used.

Overrides:

clearCache in class DBObject

Parameters:

changedKey - The key that has changed.

extPreSaveRecord
```
@OverridingMethodsMustInvokeSuper
protected void extPreSaveRecord()
                                                           throws java.lang.Exception
```
touch the interface if we are adding or deleting fields

Overrides:

extPreSaveRecord in class DBObject

Throws:

java.lang.Exception - a serious problem

extPreDeleteRecord
```
@OverridingMethodsMustInvokeSuper
protected void extPreDeleteRecord()
                                                             throws java.lang.Exception
```
touch the interface if we are adding or deleting fields

Overrides:

extPreDeleteRecord in class DBObject

Throws:

java.lang.Exception - a serious problem

makeRowId

@CheckReturnValue
public final long makeRowId()

Get & Cache the row id

Returns:: The row id

makeFactory

@CheckReturnValue
 @Nonnull
public FieldValueFactory makeFactory()

make factory for this field.

Returns:: the factory

sortLayerArray

public static void sortLayerArray(@Nonnull
                                  LayerField[] array)

Sort the layer data.

Parameters:: array - The array to be sorted.

Class DBField

Nested Class Summary

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

Field Summary

Fields inherited from class com.aspc.DBObj.DBObject

Constructor Summary

Method Summary

Methods inherited from class com.aspc.DBObj.DBObject

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Comparator

Field Detail

DBCLASS_NAME

DBCLASS_GID

PROPERTY_DISABLE_LAZY_LOAD

DISABLE_LAZY_LOAD

TYPE_INTEGER

TYPE_DOUBLE

TYPE_BOOLEAN

TYPE_DATE

TYPE_TIMESTAMP

TYPE_STRING

TYPE_TEXT

TYPE_LONG

TYPE_MULTILINGUAL

TYPE_CUSTOM

cacheRowId

Constructor Detail

DBField