com.aspc.DBObj

Class DBClassConcrete

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.DBClassAbstract

com.aspc.DBObj.DBClassConcrete

All Implemented Interfaces:

DependanceListener, ReloadEventListener, Watcher, SecondaryCacheGroup

Direct Known Subclasses:

DBClass, DBTemplate

public abstract class DBClassConcrete
extends DBClassAbstract

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
protected long	cacheRowId cache of the row id for performance reasons.
static GlobalId	DBCLASS_GID DBClassConcrete
static java.lang.String	DBCLASS_NAME DBClassConcrete

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	DBClassConcrete(DataSource dataSource) INTERNAL ONLY Exposed for DBRawClass
	DBClassConcrete(DBClass dbClass, DataSource dataSource) A DBClass is just a DBObject of type DBClass

Method Summary

Modifier and Type	Method and Description
void	checkDependances(java.lang.Object o) Checks that the DBObject is of the correct java class for this DBClass and inherited DBClasses.
void	clearCache(GlobalKey key) clear the cache.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Returns the derived value of this field.
protected ValidationError	extValidateField(DBField field, ValidationList list) Validates each field in this record.
DBField	findEmbeddedLinkage(java.lang.String... args) A special field that will embedded this class within another.
DBClassAbstract	findParentGid(java.lang.String... args) Parent gid.
DBClassAbstract	findRootClass(java.lang.String... args) The root class for this class.
AccessControl[]	getACLList(AccessGroup group) Only take notice of ACLs that have been saved.
DBEvent[]	getDBEventListAll() The list of fields in this class
DBField	getDBField(GlobalKey gKey) returns the DBField for this global key
DBField	getDBField(java.lang.String name) Get the DBField
DBField[]	getDBFieldList() The list of fields in class
DBField[]	getDBFieldListAll() The list of fields in this class
DBField[]	getDBFieldListAllSorted() A sorted list of fields in this class.
DBModule[]	getDBModuleList() Get list of modules
DBModule[]	getDBModuleListAll() Get list of modules including parent modules
java.lang.String	getDefaultRestFields(java.lang.String... args)
DBField	getEmbeddedLinkage(java.lang.String... args)
DBEvent[]	getEventList() get the event list
int[]	getExcludedLayersList() return a list of layers ids that have been set as excluded for this class
int[]	getExcludedLayersListAll() The list of layers that this class is excluded from
DBField[]	getInwardLinks() The fields that point to this class
java.lang.Class	getJavaClass() Returns the java class within the available source based on the class name
java.lang.String	getJavaClassName() The java class name eg.
DBField	getKeyField() Return the key column
DBClassConcrete	getParentDBClassConcrete() A short hand method of getting the extended class
DBClassAbstract	getParentGid(java.lang.String... args)
GlobalKey	getParentGlobalKey() The global key of the parent class.
DBClassAbstract	getRootClass(java.lang.String... args)
DBClassConcrete	getRootClassConcrete() the root concrete class
java.lang.reflect.Method	getSearchPlanMethod() INTERNAL: The search plan method
boolean	isAbstract() Is this DBClass marked as abstract
boolean	isBase() is the base class.
boolean	isInModule(java.lang.String inModule) Is this class in the passed module.
boolean	isInstanceOf(DBClassAbstract otherClassAbstract) Is this class the same as or inherited from another DBClass.
boolean	isInstanceOf(java.lang.String className) Is this class the same as or inherited from another DBClass.
boolean	isStaticList(java.lang.String... args)
long	makeRowId() an internal method for making the cache row id
DBClassConcrete	setDefaultRestFields(java.lang.String value, java.lang.String... args)
DBClassConcrete	setEmbeddedLinkage(com.aspc.dal.dbobj.DBField value, java.lang.String... args)
DBClassConcrete	setParentGid(com.aspc.dal.dbobj.DBClassAbstract value, java.lang.String... args)
DBClassConcrete	setStaticList(boolean value, java.lang.String... args)
java.lang.String	toString() The full name of this DB class

Methods inherited from class com.aspc.DBObj.DBClassAbstract

eventDependantAdded, eventDependantRemoved, eventReload, extFixUp, extPreValidate, extValidateRecord, 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, 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, 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

DBClassConcrete

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

DBClassConcrete

cacheRowId

protected long cacheRowId

cache of the row id for performance reasons.

Constructor Detail

DBClassConcrete

public DBClassConcrete(@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 data source for this object

Throws:

java.lang.Exception - A serious problem occurred

DBClassConcrete

protected DBClassConcrete(@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

getDefaultRestFields

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

setDefaultRestFields

@Nonnull
public DBClassConcrete setDefaultRestFields(@MatchesPattern(value="([0-9a-z,\\*A-Z\\[\\]]+[:0-9a-z,_/\\*A-Z\\[\\]]*)*")
                                                     java.lang.String value,
                                                     java.lang.String... args)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

getEmbeddedLinkage

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

findEmbeddedLinkage

@CheckReturnValue
 @Nonnull
public final DBField findEmbeddedLinkage(java.lang.String... args)
                                                              throws NotFoundException

A special field that will embedded this class within another.

--> DBField (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

DBField

Throws:

NotFoundException - DBField was not found

setEmbeddedLinkage

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

Throws:

java.lang.Exception

isStaticList

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

setStaticList

@Nonnull
public DBClassConcrete setStaticList(boolean value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getParentGid

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

findParentGid

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

Parent gid.

--> DBClassAbstract (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

DBClassAbstract

Throws:

NotFoundException - DBClassAbstract was not found

setParentGid

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

Throws:

java.lang.Exception

getRootClass

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

findRootClass

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

The root class for this class. If this class is a root class then this class will be returned otherwise the system will traverse up the tree until a class is found that does not have a parent.

--> DBClassAbstract (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

DBClassAbstract

Throws:

NotFoundException - DBClassAbstract was not found

getInwardLinks

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

The fields that point to this class

Returns:

The field list

getSearchPlanMethod

@CheckReturnValue
 @Nonnull
public java.lang.reflect.Method getSearchPlanMethod()
                                                                         throws java.lang.ClassNotFoundException

INTERNAL: The search plan method

Returns:

The method.

Throws:

java.lang.ClassNotFoundException - A serious problem

getParentGlobalKey

@CheckReturnValue
 @Nullable
public final GlobalKey getParentGlobalKey()

The global key of the parent class.

Returns:

The parent's global key and NULL if no parent class.

getRootClassConcrete

@CheckReturnValue
 @Nonnull
public DBClassConcrete getRootClassConcrete()

the root concrete class

Returns:

the root concrete class

isAbstract

@CheckReturnValue
public boolean isAbstract()

Is this DBClass marked as abstract

Returns:

true if abstract

getACLList

@CheckReturnValue
 @Nonnull
public final AccessControl[] getACLList(@Nonnull
                                                                    AccessGroup group)

Only take notice of ACLs that have been saved. For two reasons performance and we have a journal of any changed ACL

Parameters:

group - The access group

Returns:

The access control list

getExcludedLayersListAll

@CheckReturnValue
 @Nonnull
public final int[] getExcludedLayersListAll()

The list of layers that this class is excluded from

Returns:

The list.

toString

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

The full name of this DB class

Overrides:

toString in class DBObject

Returns:

The full name

getExcludedLayersList

@CheckReturnValue
 @Nonnull
public final int[] getExcludedLayersList()

return a list of layers ids that have been set as excluded for this class

Returns:

List of layer ids

extValidateField

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

Description copied from class: DBClassAbstract

Validates each field in this record.

Overrides:

extValidateField in class DBClassAbstract

Parameters:

field - The field to validate

list - The current validation list

Returns:

error or warning

Throws:

java.lang.Exception - A serious problem

makeRowId

@CheckReturnValue
public final long makeRowId()

an internal method for making the cache row id

Returns:

The row id.

getJavaClass

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

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

Specified by:

getJavaClass in class DBClassAbstract

Returns:

The java class for this class type

Throws:

java.lang.Exception - A serious problem

getDBField

@CheckReturnValue
 @Nullable
public final DBField getDBField(@Nonnull
                                                             GlobalKey gKey)

returns the DBField for this global key

Specified by:

getDBField in class DBClassAbstract

Parameters:

gKey - The key to find.

Returns:

The field.

getParentDBClassConcrete

@CheckReturnValue
 @Nullable
public final DBClassConcrete getParentDBClassConcrete()

A short hand method of getting the extended class

Returns:

The extended class

getDBFieldListAll

@CheckReturnValue
 @Nonnull
public DBField[] getDBFieldListAll()

The list of fields in this class

Specified by:

getDBFieldListAll in class DBClassAbstract

Returns:

The field list

getDBFieldListAllSorted

@CheckReturnValue
 @Nonnull
public DBField[] getDBFieldListAllSorted()

A sorted list of fields in this class. Key fields first and then ordered by name.

Returns:

The sorted field list

getJavaClassName

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

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

Specified by:

getJavaClassName in class DBClassAbstract

Returns:

The full qualified class name

getDBField

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

Get the DBField

Specified by:

getDBField in class DBClassAbstract

Parameters:

name - The name of the field

Returns:

The field

getKeyField

@CheckReturnValue
 @Nullable
public final DBField getKeyField()

Return the key column

Returns:

The key field

isBase

@CheckReturnValue
public boolean isBase()

is the base class.

Returns:

true if the base class.

clearCache

public void clearCache(@Nullable
                       GlobalKey key)

clear the cache.

Overrides:

clearCache in class DBClassAbstract

Parameters:

key - The key

extGetDerivedValue

@CheckReturnValue
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 DBClassAbstract

Parameters:

params - The field arguments.

field - The field to get

Returns:

The derived value.

Throws:

java.lang.Exception - A serious problem

isInstanceOf

@CheckReturnValue
public final boolean isInstanceOf(@Nonnull
                                                    java.lang.String className)

Is this class the same as or inherited from another DBClass.

Parameters:

className - The other class to test,

Returns:

True if this is an instance of the class name

getDBModuleListAll

@CheckReturnValue
 @Nonnull
public DBModule[] getDBModuleListAll()

Get list of modules including parent modules

Returns:

list of modules.

getDBModuleList

@CheckReturnValue
 @Nonnull
public DBModule[] getDBModuleList()

Get list of modules

Returns:

list of modules.

checkDependances

@CheckReturnValue
public void checkDependances(java.lang.Object o)
                                        throws java.lang.Exception

Checks that the DBObject is of the correct java class for this DBClass and inherited DBClasses.

Parameters:

o - The object to check

Throws:

java.lang.Exception - Not of correct class.

getDBEventListAll

@CheckReturnValue
 @Nonnull
public DBEvent[] getDBEventListAll()

The list of fields in this class

Returns:

The field list

getEventList

@CheckReturnValue
 @Nonnull
public final DBEvent[] getEventList()

get the event list

Returns:

the list of events

isInModule

@CheckReturnValue
public final boolean isInModule(@Nonnull
                                                  java.lang.String inModule)

Is this class in the passed module.

Parameters:

inModule - The module.

Returns:

True if this class is in the module.

isInstanceOf

@CheckReturnValue
public final boolean isInstanceOf(@Nullable
                                                    DBClassAbstract otherClassAbstract)

Is this class the same as or inherited from another DBClass.

Parameters:

otherClassAbstract - The other class to test,

Returns:

true if inherence of the class

getDBFieldList

@CheckReturnValue
 @Nonnull
public DBField[] getDBFieldList()

The list of fields in class

Specified by:

getDBFieldList in class DBClassAbstract

Returns:

List of fields