com.aspc.DBObj.Misc

Class DBFieldSubType

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.Misc.DBFieldSubType

All Implemented Interfaces:

SecondaryCacheGroup

public class DBFieldSubType
extends DBObject

The sub type.

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

Since:

29 May 2002

Author:

Jason McGrath

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 sub type
static java.lang.String	DBCLASS_NAME The sub type
static java.lang.String	LIST_COLOR Color
static java.lang.String	LIST_COORDINATE Coordinate
static java.lang.String	LIST_CSS Cascading Style Sheet
static java.lang.String	LIST_CURRENCY Currency
static java.lang.String	LIST_EMAIL Email
static java.lang.String	LIST_HOSTNAME Hostname
static java.lang.String	LIST_HTML HTML
static java.lang.String	LIST_ICAL_RRULE iCal RRule
static java.lang.String	LIST_JAVASCRIPT JavaScript
static java.lang.String	LIST_JSON JSON
static java.lang.String	LIST_JSX JSX
static java.lang.String	LIST_ML_HTML HTML
static java.lang.String	LIST_MONTH Month
static java.lang.String	LIST_PHONE Phone
static java.lang.String	LIST_PROPERTIES Properties
static java.lang.String	LIST_REGEX Regex
static java.lang.String	LIST_SQL SQL
static java.lang.String	LIST_URL URL
static java.lang.String	LIST_WEB_ADDRESS Web address
static java.lang.String	LIST_WEEK Week
static java.lang.String	LIST_XML XML
static java.lang.String	LIST_XPATH XPath

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static DBFieldSubType	create(MutableDataSource mds) Make a new instance of this class.
static DBFieldSubType	findKey(DataSource ds, java.lang.String key) Find the target for this class by the primary key
FieldTypes	findPrimaryType(java.lang.String... args) The primary field type.
java.lang.String	getCode(java.lang.String... args)
java.lang.String	getDescription(java.lang.String... args)
java.lang.String	getLabel(java.lang.String... args)
FieldTypes	getPrimaryType(java.lang.String... args)
static DBQuery<DBFieldSubType>	makeQuery(DataSource ds) Make a new QUERY for this class.
DBFieldSubType	setCode(java.lang.String value, java.lang.String... args)
DBFieldSubType	setDescription(java.lang.String value, java.lang.String... args)
DBFieldSubType	setLabel(java.lang.String value, java.lang.String... args)
DBFieldSubType	setPrimaryType(com.aspc.dal.dbobj.misc.FieldTypes value, java.lang.String... args)

Methods inherited from class com.aspc.DBObj.DBObject

addReloadEventListener, archiveCheck, autoEnterCreate, calculateValue, calculateValue, calculateValue, callingRestoreByJournal, changeThreadMode, checkCreateAccess, checkDelete, checkDeleteAccess, checkModifyAccess, checkModifyAccess, checkReadAccess, clearCache, copy, copyFields, copyIncludeField, copyInwardLinks, delete, denormalizedResult, displayLogName, displayName, displayValue, doSearch, dump, equals, eventDataLoaded, eventFieldUpdated, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetDerivedGlobalKey, extGetDerivedValue, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidate, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, extValidateField, extValidateRecord, fetchLinkHolder, findGlobalKey, findGlobalKey, findGlobalKey, findGlobalKey, findLinkedObject, findLinkedObject, findLinkedObject, findRawData, fireEventDataLoaded, fixUp, forceLockedTransaction, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getChangedFieldInfo, getChangedFields, getDate, getDate, getDate, getDate, getDate, getDefaultValue, getDisableOnChangeEvent, getDouble, getDouble, getDouble, getDouble, getDouble, getFieldDouble, getFieldInt, getFieldLong, getFieldString, getFormattedString, getFormattedString, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getInt, getInt, getInt, getInt, getInt, getInt, getInwardLinkage, getKeyString, getKeyValue, getLinkedObject, getLinkedObject, getLinkedObject, getLinkedObjectByKey, getLinkedRowId, getLinkedRowId, getLinkedRowIdByData, getLinkHolder, getLockedTransaction, getLong, getLong, getLong, getLong, getLong, getLong, getMutableArrayValue, getMutableArrayValue, getOriginalKey, getOriginalValue, getOriginalValue, getProcessedValue, getPureValue, getRawData, getRawValue, getRawValue, getRowId, getRowKey, getSecondaryCacheGroupKey, getSrcLayerID, getString, getString, getString, getString, getString, getString, getValue, getValue, getValue, getValue, hasAutoChanged, hasAutoChanged, hasChanged, hasChangedByUser, hasChangedByUserField, hasChangedByUserField, hasFieldChanged, hasFieldChanged, hashCode, hasStoredResult, iCheckDeleteAccess, iCheckModifyAccess, iCheckReadAccess, iGetDenormalizedMap, iGetRawValue, iPlaceDenormalizedResult, iPostSaveOrDeleteRecord, iPreSaveOrDeleteRecord, iPreValidate, iRaiseEvents, iSaveOrDeleteRecord, isBrokenLink, isBrokenLink, isChanged, isDataCacheKnownToBeDirty, isDeleted, isEmpty, iSetValue, isForceReindex, isKeyWordField, isMandatory, isNew, isNull, isNull, isOnChange, isReindex, iValidateRecord, lastTouched, makeArchiveDataLoader, makeClone, makeDataLoader, makeDenormalizedDoc, makeLinkedArray, makeModifyAccessException, makeSearchPlan, makeWriteProvider, manualDenormalizeOnSave, markSavePoint, optLockedTransaction, registerWatchedObject, reindex, releaseDenormalized, removeReloadEventListener, restoreByJournal, rollbackTo, setBoolean, setBoolean, setBoolean, setBoolean, setDisableOnChangeEvent, setDouble, setDouble, setInt, setInt, setLong, setLong, setRawData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, touch, undelete, validateField, validateRecord, validateSubType

Methods inherited from class java.lang.Object

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

Field Detail

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

The sub type

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

The sub type

LIST_COLOR

public static final java.lang.String LIST_COLOR

Color

See Also:

Constant Field Values

LIST_COORDINATE

public static final java.lang.String LIST_COORDINATE

Coordinate

See Also:

Constant Field Values

LIST_CSS

public static final java.lang.String LIST_CSS

Cascading Style Sheet

See Also:

Constant Field Values

LIST_CURRENCY

public static final java.lang.String LIST_CURRENCY

Currency

See Also:

Constant Field Values

LIST_EMAIL

public static final java.lang.String LIST_EMAIL

Email

See Also:

Constant Field Values

LIST_HOSTNAME

public static final java.lang.String LIST_HOSTNAME

Hostname

See Also:

Constant Field Values

LIST_HTML

public static final java.lang.String LIST_HTML

HTML

See Also:

Constant Field Values

LIST_ICAL_RRULE

public static final java.lang.String LIST_ICAL_RRULE

iCal RRule

See Also:

Constant Field Values

LIST_JAVASCRIPT

public static final java.lang.String LIST_JAVASCRIPT

JavaScript

See Also:

Constant Field Values

LIST_JSON

public static final java.lang.String LIST_JSON

JSON

See Also:

Constant Field Values

LIST_JSX

public static final java.lang.String LIST_JSX

JSX

See Also:

Constant Field Values

LIST_ML_HTML

public static final java.lang.String LIST_ML_HTML

HTML

See Also:

Constant Field Values

LIST_MONTH

public static final java.lang.String LIST_MONTH

Month

See Also:

Constant Field Values

LIST_PHONE

public static final java.lang.String LIST_PHONE

Phone

See Also:

Constant Field Values

LIST_PROPERTIES

public static final java.lang.String LIST_PROPERTIES

Properties

See Also:

Constant Field Values

LIST_REGEX

public static final java.lang.String LIST_REGEX

Regex

See Also:

Constant Field Values

LIST_SQL

public static final java.lang.String LIST_SQL

SQL

See Also:

Constant Field Values

LIST_URL

public static final java.lang.String LIST_URL

URL

See Also:

Constant Field Values

LIST_WEB_ADDRESS

public static final java.lang.String LIST_WEB_ADDRESS

Web address

See Also:

Constant Field Values

LIST_WEEK

public static final java.lang.String LIST_WEEK

Week

See Also:

Constant Field Values

LIST_XML

public static final java.lang.String LIST_XML

XML

See Also:

Constant Field Values

LIST_XPATH

public static final java.lang.String LIST_XPATH

XPath

See Also:

Constant Field Values

Constructor Detail

DBFieldSubType

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

getCode

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

setCode

@Nonnull
public DBFieldSubType setCode(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getDescription

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

setDescription

@Nonnull
public DBFieldSubType setDescription(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)

setLabel

@Nonnull
public DBFieldSubType setLabel(java.lang.String value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getPrimaryType

@CheckReturnValue
 @Nullable
public FieldTypes getPrimaryType(java.lang.String... args)

findPrimaryType

@CheckReturnValue
 @Nonnull
public final FieldTypes findPrimaryType(java.lang.String... args)
                                                             throws NotFoundException

The primary field type.

--> FieldTypes (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

FieldTypes

Throws:

NotFoundException - FieldTypes was not found

setPrimaryType

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

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static DBFieldSubType 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<DBFieldSubType> 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 DBFieldSubType findKey(@Nonnull
                                                                 DataSource ds,
                                                                 @Nonnull
                                                                 java.lang.String 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