com.aspc.DBObj

Class DBInterface

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.DBClassAbstract

com.aspc.DBObj.DBInterface

All Implemented Interfaces:

DependanceListener, ReloadEventListener, Watcher, SecondaryCacheGroup

public class DBInterface
extends DBClassAbstract

a class interface.

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

Since:

November 1, 2005

Author:

Nigel

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 a class interface
static java.lang.String	DBCLASS_NAME a class interface

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

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

Method Summary

Modifier and Type	Method and Description
protected ValidationError	extValidateField(DBField field, ValidationList list) Validates each field in this record.
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 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.
boolean	isInstanceOf(DBInterface otherInterface) is the interface an instance of another interface

Methods inherited from class com.aspc.DBObj.DBClassAbstract

clearCache, eventDependantAdded, eventDependantRemoved, eventReload, extFixUp, extGetDerivedValue, 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, 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

a class interface

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

a class interface

Constructor Detail

DBInterface

public DBInterface(@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

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

getJavaClass

@CheckReturnValue
 @Nullable
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(@Nullable
                                                             java.lang.String name)

Get the DBField

Specified by:

getDBField in class DBClassAbstract

Parameters:

name - The name of the field

Returns:

The field

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.

isInstanceOf

@CheckReturnValue
public final boolean isInstanceOf(DBInterface otherInterface)

is the interface an instance of another interface

Parameters:

otherInterface - The other interface

Returns:

true if an instance.

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 DBClassAbstract

Parameters:

list - The current validation list

field - The field to validate

Returns:

error or warning

Throws:

java.lang.Exception - A serious problem

getDBFieldList

@CheckReturnValue
 @Nonnull
public DBField[] getDBFieldList()

The list of fields in class

Specified by:

getDBFieldList in class DBClassAbstract

Returns:

List of fields

getDBFieldListAll

@CheckReturnValue
 @Nonnull
public DBField[] getDBFieldListAll()

The list of fields in class

Specified by:

getDBFieldListAll in class DBClassAbstract

Returns:

List of fields