com.aspc.DBObj

Class DBClass

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.DBClassAbstract

com.aspc.DBObj.DBClassConcrete

com.aspc.DBObj.DBClass

All Implemented Interfaces:

DependanceListener, ReloadEventListener, Watcher, SecondaryCacheGroup

Direct Known Subclasses:

DBRawClass

public class DBClass
extends DBClassConcrete

DBObjects are an instance of DBClass. The definition of "DBClass" is itself a DBObject. When a record is retrieved from the database it will be initiated as a java object as specified in the java_class_name field. If this is blank the standard DBObject class will be used. The java_class_name must be a java class witch extends DBObject.
Generic DBObject.

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

Since:

June 30, 2000, 7:46 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
static GlobalId	DBCLASS_GID DBClass
static java.lang.String	DBCLASS_NAME DBClass
protected DBClassSyncMap[][]	holderDBClassSyncMap Cache of the sync map
protected DBStoredResult[][]	holderDBStoredResult the cache of stored results

Fields inherited from class com.aspc.DBObj.DBClassConcrete

cacheRowId

Fields inherited from class com.aspc.DBObj.DBClassAbstract

holderClassList, holderFieldList, holderFieldListSorted, holderFieldMap, holderJavaClass

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DBClass(DataSource dataSource) INTERNAL ONLY Exposed for DBRawClass
	DBClass(DBClass dbClass, DataSource dataSource) A DBClass is just a DBObject of type DBClass

Method Summary

Modifier and Type	Method and Description
void	checkFullList(long rowUID) internal check of the cache of the full list of row ids for a class.
void	clearCache()
void	clearCache(GlobalKey key) clear the cache.
void	clearRootHolder() INTERNAL: Clear the root holder
DBObject	createDBObject(DataSource userDS) creates a new java object of the specified type.
boolean	disableFieldRecycler(java.lang.String... args)
java.lang.String	displayName() The human display name of this object.
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) update dependent fields.
protected boolean	extCanDeleteDependantObject(DBObject o) Checks that we can delete the dependent object.
protected void	extFixUp() Delete the record if no associated company.
protected GlobalKey	extGetDerivedGlobalKey(DBField field, FldParams params) Calculate the derived global key for this field.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Returns the derived value of this field.
protected void	extPostDeleteRecord(long transNr) 1) Try to clean up a bit the un needed class index records.
protected void	extPostSaveRecord(long transNr) Mark the index as dirty
void	extPreValidate() When a new DBClass is created a default access restriction is created preventing PUBLIC access to any record of this type.
protected ValidationError	extValidateField(DBField field, ValidationList list) Validates each field in this record.
protected void	extValidateRecord(ValidationList list) Performs additional validations on this record.
static DBClass	findClassForTable(java.lang.String tableName) short hand method to find the class for the table name.
ExternalDataSource	findExternalDataSource(java.lang.String... args) external data source.
ExternalMode	findExternalMode(java.lang.String... args) external mode.
DBClassAbstract	findTemplate(java.lang.String... args) The template for this class.
java.lang.reflect.Method	getArchiveDataLoaderMethod() INTERNAL: The archive data loader method
java.util.HashMap	getClassMap() get the class map
java.lang.reflect.Method	getDataLoaderMethod() INTERNAL: The data loader method
DBField[]	getDBFieldOnChangeList(DBField field) The on change list
java.lang.String	getDuplicateWarningFields(java.lang.String... args)
int	getEstimatedMemorySize(java.lang.String... args)
ExternalDataSource	getExternalDataSource(java.lang.String... args)
java.lang.String	getExternalManagerClass(java.lang.String... args)
ExternalMode	getExternalMode(java.lang.String... args)
java.lang.String	getExternalTable(java.lang.String... args)
java.lang.reflect.Constructor	getJavaClassConstructor() The constructor for this class.
DBField[]	getKeywordFields() The list of key word fields.
java.util.Date	getLastObjModifiedTime() Returns the last time an object of this class was modified
DBField[]	getLinkedFields() The list of linked fields.
int	getLoadSequence(java.lang.String... args)
java.lang.String	getRecentLinksPrimer(java.lang.String... args)
DBClass	getRootDBClass() The root class.
GlobalKey	getRootGlobalKey() The root class's global key.
RootClassHolder	getRootHolder() INTERNAL: The root holder for this class.
GlobalKeyId	getRootId() The root class's global Id.
DBClass[]	getSubClasses() Retrieve a list of classes that are direct sub classes of this class GLOBAL - to get the dbClass child list we need to pass in the current virtualDB
DBClass[]	getSubClassesAll() Retrieve a list of all descendent sub classes
java.lang.String	getTableExt() Returns the table name extension based on the current database and the root class id based on the class id of this class for e.g.
DBClassAbstract	getTemplate(java.lang.String... args)
DBClassSyncMap[]	getTransactionSystemMap() Retrieve a list of the sync map records.
boolean	hasArrayField() does this class a array field.
boolean	isAbstract() Is this DBClass marked as abstract
boolean	isAbstractFg(java.lang.String... args)
boolean	isDropCacheWhenRemotelyChanged(java.lang.String... args)
boolean	isGenerateGWT(java.lang.String... args) Deprecated.
boolean	isIgnoreJournalData(java.lang.String... args)
boolean	isIndexJournalData(java.lang.String... args)
boolean	isLayerExcluded(int dbId) Is the specified layer excluded for this class
boolean	isNoChangesInLayer(java.lang.String... args)
boolean	isRecordNoIntialData(java.lang.String... args)
boolean	isRecordNoJournalData(java.lang.String... args)
boolean	isRecordNoJournalRecord(java.lang.String... args)
DBStoredResult[]	listDBStoredResult() Retrieve a list of the sync map records.
java.lang.String	makeClassSQLClause(java.lang.String alias) make the SQL clause for the sub classes
java.lang.String	makeClassSQLClauseLeftJoin() make the SQL clause for the sub classes
RootClassHolder	makeRootHolder() INTERNAL: make a root holder
static GlobalKeyId	makeRootId(GlobalId classId) The root class id
DBClass	setAbstractFg(boolean value, java.lang.String... args)
DBClass	setDisableFieldRecycler(boolean value, java.lang.String... args)
DBClass	setDropCacheWhenRemotelyChanged(boolean value, java.lang.String... args)
DBClass	setDuplicateWarningFields(java.lang.String value, java.lang.String... args)
DBClass	setEstimatedMemorySize(int value, java.lang.String... args)
DBClass	setExternalDataSource(com.aspc.dal.dbobj.internal.dal.obj.ExternalDataSource value, java.lang.String... args)
DBClass	setExternalManagerClass(java.lang.String value, java.lang.String... args)
DBClass	setExternalMode(com.aspc.dal.dbobj.internal.dal.obj.ExternalMode value, java.lang.String... args)
DBClass	setExternalTable(java.lang.String value, java.lang.String... args)
DBClass	setGenerateGWT(boolean value, java.lang.String... args) Deprecated.
DBClass	setIgnoreJournalData(boolean value, java.lang.String... args)
DBClass	setIndexJournalData(boolean value, java.lang.String... args)
void	setLastObjModifiedTime(java.util.Date modifiedTime) record the last time this class has been modified since the server started.
DBClass	setLoadSequence(int value, java.lang.String... args)
DBClass	setRecentLinksPrimer(java.lang.String value, java.lang.String... args)
DBClass	setRecordNoIntialData(boolean value, java.lang.String... args)
DBClass	setRecordNoJournalData(boolean value, java.lang.String... args)
DBClass	setRecordNoJournalRecord(boolean value, java.lang.String... args)
DBClass	setTemplate(com.aspc.dal.dbobj.DBClassAbstract value, java.lang.String... args)
java.lang.String	toString() The full name of this DB class

Methods inherited from class com.aspc.DBObj.DBClassConcrete

checkDependances, findEmbeddedLinkage, findParentGid, findRootClass, getACLList, getDBEventListAll, getDBField, getDBField, getDBFieldList, getDBFieldListAll, getDBFieldListAllSorted, getDBModuleList, getDBModuleListAll, getDefaultRestFields, getEmbeddedLinkage, getEventList, getExcludedLayersList, getExcludedLayersListAll, getInwardLinks, getJavaClass, getJavaClassName, getKeyField, getParentDBClassConcrete, getParentGid, getParentGlobalKey, getRootClass, getRootClassConcrete, getSearchPlanMethod, isBase, isInModule, isInstanceOf, isInstanceOf, isStaticList, makeRowId, setDefaultRestFields, setEmbeddedLinkage, setParentGid, setStaticList

Methods inherited from class com.aspc.DBObj.DBClassAbstract

eventDependantAdded, eventDependantRemoved, eventReload, fetchInterfaceFields, fetchTemplateFields, findDBField, findKey, getClassId, getClassList, getDeprecatedTx, getDescription, getDisplayName, getFullName, getName, getNameForDisplay, getNotes, hasDBField, hasDBField, hasInterfaces, isDeprecated, isFinalFg, makeQuery, setClassId, setDeprecated, setDeprecatedTx, setDescription, setDisplayName, setFinalFg, setHasInterfaces, setJavaClassName, setName, setNotes

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, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, 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, 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

DBClass

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

DBClass

holderDBClassSyncMap

protected DBClassSyncMap[][] holderDBClassSyncMap

Cache of the sync map

holderDBStoredResult

protected DBStoredResult[][] holderDBStoredResult

the cache of stored results

Constructor Detail

DBClass

public DBClass(@Nonnull
               DBClass dbClass,
               @Nonnull
               DataSource dataSource)
        throws java.lang.Exception

A DBClass is just a DBObject of type DBClass

Parameters:

dbClass - The raw class

dataSource - The datasource for this object

Throws:

java.lang.Exception - A serious problem occurred

DBClass

protected DBClass(@Nonnull
                  DataSource dataSource)
           throws java.lang.Exception

INTERNAL ONLY Exposed for DBRawClass

Parameters:

dataSource - The data source for this object

Throws:

java.lang.Exception - A serious problem

Method Detail

isAbstractFg

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

setAbstractFg

@Nonnull
public DBClass setAbstractFg(boolean 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 DBClass setDisableFieldRecycler(boolean value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

isDropCacheWhenRemotelyChanged

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

setDropCacheWhenRemotelyChanged

@Nonnull
public DBClass setDropCacheWhenRemotelyChanged(boolean value,
                                                        java.lang.String... args)
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

getDuplicateWarningFields

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

setDuplicateWarningFields

@Nonnull
public DBClass setDuplicateWarningFields(java.lang.String value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getEstimatedMemorySize

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

setEstimatedMemorySize

@Nonnull
public DBClass setEstimatedMemorySize(int value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getExternalDataSource

@CheckReturnValue
 @Nullable
public ExternalDataSource getExternalDataSource(java.lang.String... args)

findExternalDataSource

@CheckReturnValue
 @Nonnull
public final ExternalDataSource findExternalDataSource(java.lang.String... args)
                                                                            throws NotFoundException

external data source.

--> ExternalDataSource (String, Searchable)

Parameters:

args - the optional arguments

Returns:

ExternalDataSource

Throws:

NotFoundException - ExternalDataSource was not found

setExternalDataSource

@Nonnull
public DBClass setExternalDataSource(com.aspc.dal.dbobj.internal.dal.obj.ExternalDataSource value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getExternalManagerClass

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

setExternalManagerClass

@Nonnull
public DBClass setExternalManagerClass(java.lang.String value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getExternalMode

@CheckReturnValue
 @Nullable
public ExternalMode getExternalMode(java.lang.String... args)

findExternalMode

@CheckReturnValue
 @Nonnull
public final ExternalMode findExternalMode(java.lang.String... args)
                                                                throws NotFoundException

external mode.

--> ExternalMode (String, Searchable)

Parameters:

args - the optional arguments

Returns:

ExternalMode

Throws:

NotFoundException - ExternalMode was not found

setExternalMode

@Nonnull
public DBClass setExternalMode(com.aspc.dal.dbobj.internal.dal.obj.ExternalMode value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getExternalTable

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

setExternalTable

@Nonnull
public DBClass setExternalTable(java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

isGenerateGWT

@Deprecated
 @CheckReturnValue
public boolean isGenerateGWT(java.lang.String... args)

Deprecated.

setGenerateGWT

@Deprecated
 @Nonnull
public DBClass setGenerateGWT(boolean value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

isIgnoreJournalData

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

setIgnoreJournalData

@Nonnull
public DBClass setIgnoreJournalData(boolean value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

isIndexJournalData

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

setIndexJournalData

@Nonnull
public DBClass setIndexJournalData(boolean value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getLoadSequence

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

setLoadSequence

@Nonnull
public DBClass setLoadSequence(int value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

isNoChangesInLayer

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

getRecentLinksPrimer

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

setRecentLinksPrimer

@Nonnull
public DBClass setRecentLinksPrimer(java.lang.String value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

isRecordNoIntialData

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

setRecordNoIntialData

@Nonnull
public DBClass setRecordNoIntialData(boolean value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

isRecordNoJournalData

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

setRecordNoJournalData

@Nonnull
public DBClass setRecordNoJournalData(boolean value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

isRecordNoJournalRecord

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

setRecordNoJournalRecord

@Nonnull
public DBClass setRecordNoJournalRecord(boolean value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getTemplate

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

findTemplate

@CheckReturnValue
 @Nonnull
public final DBClassAbstract findTemplate(java.lang.String... args)
                                                               throws NotFoundException

The template for this class.

--> DBClassAbstract (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

DBClassAbstract

Throws:

NotFoundException - DBClassAbstract was not found

setTemplate

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

Throws:

java.lang.Exception

getDataLoaderMethod

@CheckReturnValue
 @Nonnull
public java.lang.reflect.Method getDataLoaderMethod()
                                                                         throws java.lang.Exception

INTERNAL: The data loader method

Returns:

The method.

Throws:

java.lang.Exception - A serious problem

getArchiveDataLoaderMethod

@CheckReturnValue
 @Nonnull
public java.lang.reflect.Method getArchiveDataLoaderMethod()
                                                                                throws java.lang.Exception

INTERNAL: The archive data loader method

Returns:

The method.

Throws:

java.lang.Exception - A serious problem

hasArrayField

@CheckReturnValue
public boolean hasArrayField()
                                        throws java.lang.Exception

does this class a array field.

Returns:

true if we have an array field

Throws:

java.lang.Exception - a serious problem.

extPreValidate

public final void extPreValidate()
                          throws java.lang.Exception

When a new DBClass is created a default access restriction is created preventing PUBLIC access to any record of this type.

Overrides:

extPreValidate in class DBClassAbstract

Throws:

java.lang.Exception - A serious problem

extFixUp

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

Delete the record if no associated company.

Overrides:

extFixUp in class DBClassAbstract

Throws:

java.lang.Exception - A serious problem

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 DBClassConcrete

Parameters:

params - The field arguments.

field - The field to get

Returns:

The derived value.

Throws:

java.lang.Exception - A serious problem

extValidateRecord

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

Performs additional validations on this record. Only ever called from MutableDataSource.

Overrides:

extValidateRecord in class DBClassAbstract

Parameters:

list - The validation list.

Throws:

java.lang.Exception - A serious problem

makeClassSQLClause

@CheckReturnValue
 @Nonnull
public java.lang.String makeClassSQLClause(@Nullable
                                                                       java.lang.String alias)

make the SQL clause for the sub classes

Parameters:

alias - the table alias

Returns:

the partial where clause

makeClassSQLClauseLeftJoin

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

make the SQL clause for the sub classes

Returns:

the partial where clause

checkFullList

public void checkFullList(long rowUID)

internal check of the cache of the full list of row ids for a class.

Parameters:

rowUID - The row that must be in the full list of row ids.

getRootHolder

@CheckReturnValue
 @Nullable
public RootClassHolder getRootHolder()

INTERNAL: The root holder for this class.

Returns:

The holder

clearRootHolder

public void clearRootHolder()

INTERNAL: Clear the root holder

makeRootHolder

@CheckReturnValue
 @Nonnull
public RootClassHolder makeRootHolder()
                                                           throws java.lang.InterruptedException

INTERNAL: make a root holder

Returns:

The root holder

Throws:

java.lang.InterruptedException - was interrupted.

createDBObject

@CheckReturnValue
 @Nonnull
public DBObject createDBObject(@Nonnull
                                                           DataSource userDS)
                                                    throws java.lang.Exception

creates a new java object of the specified type.

Parameters:

userDS - The datasource to create the object for.

Returns:

The newly created DBObject

Throws:

java.lang.Exception - A serious problem.

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.

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

extPostSaveRecord

@OverridingMethodsMustInvokeSuper
protected void extPostSaveRecord(@Nonnegative
                                                                   long transNr)

Mark the index as dirty

Overrides:

extPostSaveRecord in class DBObject

Parameters:

transNr - The current transaction number.

getLinkedFields

@CheckReturnValue
 @Nonnull
public final DBField[] getLinkedFields()

The list of linked fields.

Returns:

The field list

getKeywordFields

@CheckReturnValue
 @Nonnull
public final DBField[] getKeywordFields()

The list of key word fields.

Returns:

The field list

getJavaClassConstructor

@CheckReturnValue
 @Nonnull
public final java.lang.reflect.Constructor getJavaClassConstructor()
                                                                                        throws java.lang.Exception

The constructor for this class.

Returns:

The constructor.

Throws:

java.lang.Exception - A serious problem

getTableExt

@CheckReturnValue
 @Nonnull
public final java.lang.String getTableExt()

Returns the table name extension based on the current database and the root class id based on the class id of this class for e.g. _7f000004_00000002

Returns:

The raw table name extension

findClassForTable

@CheckReturnValue
 @Nonnull
public static DBClass findClassForTable(java.lang.String tableName)
                                                             throws NotFoundException

short hand method to find the class for the table name.

Parameters:

tableName - the table name

Returns:

the DBClass

Throws:

NotFoundException - if no class found or invalid table name.

getDBFieldOnChangeList

@CheckReturnValue
 @Nonnull
public final DBField[] getDBFieldOnChangeList(@Nonnull
                                                                          DBField field)

The on change list

Parameters:

field - The field that is changing

Returns:

The list

toString

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

The full name of this DB class

Overrides:

toString in class DBClassConcrete

Returns:

The full name

getSubClasses

@CheckReturnValue
 @Nonnull
public DBClass[] getSubClasses()
                                                    throws java.lang.Exception

Retrieve a list of classes that are direct sub classes of this class GLOBAL - to get the dbClass child list we need to pass in the current virtualDB

Returns:

The list of sub classes

Throws:

java.lang.Exception - A serious problem

getTransactionSystemMap

@CheckReturnValue
 @Nonnull
public DBClassSyncMap[] getTransactionSystemMap()
                                                                     throws java.lang.Exception

Retrieve a list of the sync map records.

Returns:

The list of sub classes

Throws:

java.lang.Exception - A serious problem

listDBStoredResult

@CheckReturnValue
 @Nonnull
public DBStoredResult[] listDBStoredResult()
                                                                throws java.lang.Exception

Retrieve a list of the sync map records.

Returns:

The list of sub classes

Throws:

java.lang.Exception - A serious problem

getSubClassesAll

@CheckReturnValue
 @Nonnull
public DBClass[] getSubClassesAll()
                                                       throws java.lang.Exception

Retrieve a list of all descendent sub classes

Returns:

All sub classes

Throws:

java.lang.Exception - A serious problem

isAbstract

@CheckReturnValue
public final boolean isAbstract()

Is this DBClass marked as abstract

Overrides:

isAbstract in class DBClassConcrete

Returns:

true if abstract

getRootGlobalKey

@CheckReturnValue
 @Nonnull
public GlobalKey getRootGlobalKey()

The root class's global key.

Returns:

The global key.

getRootDBClass

@CheckReturnValue
 @Nonnull
public final DBClass getRootDBClass()

The root class.

Returns:

The root DBClass.

getRootId

@CheckReturnValue
 @Nonnull
public final GlobalKeyId getRootId()

The root class's global Id.

Returns:

The global id.

makeRootId

@CheckReturnValue
 @Nullable
public static GlobalKeyId makeRootId(@Nullable
                                                                  GlobalId classId)

The root class id

Parameters:

classId - The class id to check.

Returns:

The root id

displayName

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

The human display name of this object.

Overrides:

displayName in class DBObject

Returns:

the display name

isLayerExcluded

@CheckReturnValue
public final boolean isLayerExcluded(int dbId)

Is the specified layer excluded for this class

Parameters:

dbId - The layer id

Returns:

true if abstract

getLastObjModifiedTime

@CheckReturnValue
 @Nonnull
public java.util.Date getLastObjModifiedTime()

Returns the last time an object of this class was modified

Returns:

greater time of last object modified or when class was loaded

setLastObjModifiedTime

public void setLastObjModifiedTime(@Nonnull
                                   java.util.Date modifiedTime)

record the last time this class has been modified since the server started. It is used for caching on the client browsers.

Parameters:

modifiedTime - The time.

extGetDerivedGlobalKey

@CheckReturnValue
 @Nullable
protected GlobalKey extGetDerivedGlobalKey(@Nonnull
                                                                        DBField field,
                                                                        @Nullable
                                                                        FldParams params)
                                                                 throws java.lang.Exception

Calculate the derived global key for this field.

Overrides:

extGetDerivedGlobalKey in class DBObject

Parameters:

field - The field to get

params - The parameters for this field eg. language= or default=

Returns:

The calculated global key

Throws:

java.lang.Exception - A serious problem

extPostDeleteRecord

@OverridingMethodsMustInvokeSuper
protected void extPostDeleteRecord(@Nonnegative
                                                                     long transNr)

1) Try to clean up a bit the un needed class index records.

Overrides:

extPostDeleteRecord in class DBObject

Parameters:

transNr - The transaction number

extValidateField

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

Validates each field in this record.

Overrides:

extValidateField in class DBClassConcrete

Parameters:

list - The current validation list

field - The field to validate

Returns:

error or warning

Throws:

java.lang.Exception - A serious problem

extCanDeleteDependantObject

@CheckReturnValue
protected final boolean extCanDeleteDependantObject(@Nonnull
                                                                      DBObject o)

Checks that we can delete the dependent object.

Overrides:

extCanDeleteDependantObject in class DBObject

Parameters:

o - The object to check

Returns:

true if OK to delete.

clearCache

public void clearCache()

clearCache

public void clearCache(@Nullable
                       GlobalKey key)

clear the cache.

Overrides:

clearCache in class DBClassConcrete

Parameters:

key - The key

getClassMap

@CheckReturnValue
 @Nonnull
public java.util.HashMap getClassMap()

get the class map

Returns:

the class map