com.aspc.DBObj

Class DBClassAbstract

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.DBClassAbstract

All Implemented Interfaces:

DependanceListener, ReloadEventListener, Watcher, SecondaryCacheGroup

Direct Known Subclasses:

DBClassConcrete, DBInterface

public abstract class DBClassAbstract
extends DBObject
implements ReloadEventListener, DependanceListener

Generic DBObject.

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

Since:

November 1, 2005

Author:

luke

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 DBClassAbstract
static java.lang.String	DBCLASS_NAME DBClassAbstract
protected DBClass[][]	holderClassList The secondary cache of implemented classes.
protected DBField[][]	holderFieldList Internal cache holder which is exposed for DBRawClass.
protected DBField[][]	holderFieldListSorted Internal cache holder which is exposed for DBRawClass.
protected java.util.HashMap[]	holderFieldMap A secondary cache of all the fields.
protected java.lang.Class[]	holderJavaClass A secondary cache of all the java class.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	clearCache(GlobalKey key) clear the cache.
void	eventDependantAdded(GlobalKey addedKey, GlobalKey sourceFieldKey) Used to clear the cache of fields for this class
void	eventDependantRemoved(GlobalKey removedKey, GlobalKey sourceFieldKey) A field/class was deleted
void	eventReload(DBObject obj) A watched field has been changed
protected void	extFixUp() correct the has interface
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Returns the derived value of this field.
protected void	extPreValidate() update the hasWorkflow fields.
protected ValidationError	extValidateField(DBField field, ValidationList list) Validates each field in this record.
protected void	extValidateRecord(ValidationList list) Performs additional validations on this record.
protected void	fetchInterfaceFields(java.util.HashMap map) Add the interface fields
protected void	fetchTemplateFields(java.util.HashMap map) Add the template fields
DBField	findDBField(java.lang.String name) find the DBField
static DBClassAbstract	findKey(DataSource ds, int key) Find the target for this class by the primary key
GlobalKeyId	getClassId() A short hand method to get this class id
DBClass[]	getClassList() A safe version of list class that copies the class list
abstract DBField	getDBField(GlobalKey gKey) returns the DBField for this global key
abstract DBField	getDBField(java.lang.String name) Get the DBField
abstract DBField[]	getDBFieldList() The list of fields in class
abstract DBField[]	getDBFieldListAll() The list of fields in class
java.lang.String	getDeprecatedTx(java.lang.String... args)
java.lang.String	getDescription(java.lang.String... args)
java.lang.String	getDisplayName(java.lang.String... args)
java.lang.String	getFullName(java.lang.String... args)
abstract java.lang.Class	getJavaClass() Returns the java class within the available source based on the class name
abstract java.lang.String	getJavaClassName() The java class name eg.
java.lang.String	getName() Get the name for this DB class.
java.lang.String	getNameForDisplay(java.lang.String... args)
java.lang.String	getNotes(java.lang.String... args)
boolean	hasDBField(GlobalKey fieldGid) Does this DBClass or any inherited classes have the field.
boolean	hasDBField(java.lang.String name) Does this DBClass or any inherited classes have the field.
boolean	hasInterfaces(java.lang.String... args)
boolean	isDeprecated(java.lang.String... args)
boolean	isFinalFg(java.lang.String... args)
static DBQuery<DBClassAbstract>	makeQuery(DataSource ds) Make a new QUERY for this class.
DBClassAbstract	setClassId(int value, java.lang.String... args)
DBClassAbstract	setDeprecated(boolean value, java.lang.String... args)
DBClassAbstract	setDeprecatedTx(java.lang.String value, java.lang.String... args)
DBClassAbstract	setDescription(java.lang.String value, java.lang.String... args)
DBClassAbstract	setDisplayName(java.lang.String value, java.lang.String... args)
DBClassAbstract	setFinalFg(boolean value, java.lang.String... args)
DBClassAbstract	setHasInterfaces(boolean value, java.lang.String... args)
DBClassAbstract	setJavaClassName(java.lang.String value, java.lang.String... args)
DBClassAbstract	setName(java.lang.String value, java.lang.String... args)
DBClassAbstract	setNotes(java.lang.String 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, 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, 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

Methods inherited from interface com.aspc.DBObj.Listeners.Watcher

registerWatchedObject

Field Detail

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

DBClassAbstract

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

DBClassAbstract

holderFieldList

protected DBField[][] holderFieldList

Internal cache holder which is exposed for DBRawClass.

holderFieldListSorted

protected DBField[][] holderFieldListSorted

Internal cache holder which is exposed for DBRawClass.

holderClassList

protected DBClass[][] holderClassList

The secondary cache of implemented classes.

holderFieldMap

protected java.util.HashMap[] holderFieldMap

A secondary cache of all the fields.

holderJavaClass

protected java.lang.Class[] holderJavaClass

A secondary cache of all the java class.

Constructor Detail

DBClassAbstract

public DBClassAbstract(@Nonnull
                       DBClass def,
                       @Nonnull
                       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

setClassId

@Nonnull
public DBClassAbstract setClassId(int 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 DBClassAbstract 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 DBClassAbstract setDeprecatedTx(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 DBClassAbstract setDescription(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 DBClassAbstract setDisplayName(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 DBClassAbstract setFinalFg(boolean value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getFullName

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

hasInterfaces

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

setHasInterfaces

@Nonnull
public DBClassAbstract setHasInterfaces(boolean value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

setJavaClassName

@Nonnull
public DBClassAbstract setJavaClassName(java.lang.String value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

setName

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

Throws:

java.lang.Exception

getNameForDisplay

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

getNotes

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

setNotes

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

Throws:

java.lang.Exception

makeQuery

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

getClassId

@CheckReturnValue
 @Nonnull
public final GlobalKeyId getClassId()

A short hand method to get this class id

Returns:

The class id.

getName

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

Get the name for this DB class.

Returns:

The name

getClassList

@CheckReturnValue
 @Nonnull
public final DBClass[] getClassList()

A safe version of list class that copies the class list

Returns:

The list of classes.

hasDBField

@CheckReturnValue
public final boolean hasDBField(@Nonnull
                                                  GlobalKey fieldGid)

Does this DBClass or any inherited classes have the field.

Parameters:

fieldGid - The field to check.

Returns:

True if field is present.

hasDBField

@CheckReturnValue
public final boolean hasDBField(@Nonnull
                                                  java.lang.String name)

Does this DBClass or any inherited classes have the field.

Parameters:

name - The field name

Returns:

True if field is present.

extGetDerivedValue

@CheckReturnValue
 @Nullable
protected 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

eventReload

public final void eventReload(@Nonnull
                              DBObject obj)

A watched field has been changed

Specified by:

eventReload in interface ReloadEventListener

Parameters:

obj - The field that was reload.

eventDependantAdded

public final void eventDependantAdded(@Nonnull
                                      GlobalKey addedKey,
                                      @Nonnull
                                      GlobalKey sourceFieldKey)

Used to clear the cache of fields for this class

Specified by:

eventDependantAdded in interface DependanceListener

Parameters:

addedKey - The dependent added

sourceFieldKey - The field that points to this object

eventDependantRemoved

public final void eventDependantRemoved(@Nonnull
                                        GlobalKey removedKey,
                                        @Nonnull
                                        GlobalKey sourceFieldKey)

A field/class was deleted

Specified by:

eventDependantRemoved in interface DependanceListener

Parameters:

removedKey - The field was removed.

sourceFieldKey - The linked field

getDBFieldList

@Nonnull
 @CheckReturnValue
public abstract DBField[] getDBFieldList()

The list of fields in class

Returns:

List of fields

getDBFieldListAll

@Nonnull
 @CheckReturnValue
public abstract DBField[] getDBFieldListAll()

The list of fields in class

Returns:

List of fields

getDBField

@CheckReturnValue
 @Nullable
public abstract DBField getDBField(@Nullable
                                                                java.lang.String name)

Get the DBField

Parameters:

name - The name of the field

Returns:

The field

findDBField

@CheckReturnValue
 @Nonnull
public final DBField findDBField(@Nonnull
                                                             java.lang.String name)

find the DBField

Parameters:

name - The name of the field

Returns:

The field

getDBField

@CheckReturnValue
 @Nullable
public abstract DBField getDBField(GlobalKey gKey)

returns the DBField for this global key

Parameters:

gKey - The key to find.

Returns:

The field.

getJavaClass

@CheckReturnValue
 @Nonnull
public abstract java.lang.Class getJavaClass()
                                                                  throws java.lang.Exception

Returns the java class within the available source based on the class name

Returns:

The java class for this class type

Throws:

java.lang.Exception - A serious problem

clearCache

public void clearCache(@Nullable
                       GlobalKey key)

clear the cache.

Overrides:

clearCache in class DBObject

Parameters:

key - The key

getJavaClassName

@CheckReturnValue
 @Nonnull
public abstract java.lang.String getJavaClassName()

The java class name eg. com.aspc.DBObj.Contact.Person

Returns:

The full qualified class name

extValidateRecord

@OverridingMethodsMustInvokeSuper
protected void extValidateRecord(@Nonnull
                                                                   ValidationList list)
                                                            throws java.lang.Exception

Description copied from class: DBObject

Performs additional validations on this record. OVERRIDE this method to add additional validations to a record.
The MutableDataSource is in READONLY mode at this stage.

Overrides:

extValidateRecord in class DBObject

Parameters:

list - The validation list.

Throws:

java.lang.Exception - A serious problem

extValidateField

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

Validates each field in this record.

Overrides:

extValidateField in class DBObject

Parameters:

list - The current validation list

field - The field to validate

Returns:

error or warning

Throws:

java.lang.Exception - A serious problem

extPreValidate

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

update the hasWorkflow fields.

Overrides:

extPreValidate in class DBObject

Throws:

java.lang.Exception - A Serious problem

extFixUp

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

correct the has interface

Overrides:

extFixUp in class DBObject

Throws:

java.lang.Exception - a serious problem.

fetchInterfaceFields

protected void fetchInterfaceFields(@Nonnull
                                    java.util.HashMap map)
                             throws java.lang.Exception

Add the interface fields

Parameters:

map - The map to add them to

Throws:

java.lang.Exception - A serious problem.

fetchTemplateFields

protected void fetchTemplateFields(@Nonnull
                                   java.util.HashMap map)
                            throws java.lang.Exception

Add the template fields

Parameters:

map - The map to add them to

Throws:

java.lang.Exception - A serious problem.