com.aspc.task

Class DBClassSyncMap

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.task.DBClassSyncMap

All Implemented Interfaces:

DependanceListener, SecondaryCacheGroup

public class DBClassSyncMap
extends DBObject
implements DependanceListener

Should we record the per system transactions id. This is for synchronization of external systems.

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

Since:

4 December 2003

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 Should we record the per system transactions id.
static java.lang.String	DBCLASS_NAME Should we record the per system transactions id.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	clearCache() clear the cache whenever the sync conditions are changed
static DBClassSyncMap	create(MutableDataSource mds) Make a new instance of this class.
void	eventDependantAdded(GlobalKey addedKey, GlobalKey sourceFieldKey) A record that points to this record was added.
void	eventDependantRemoved(GlobalKey removedKey, GlobalKey sourceFieldKey) A record that points to this record was removed.
DBClassAbstract	findClassId(java.lang.String... args) The class that needs to be sync'd for this system.
static DBClassSyncMap	findKey(DataSource ds, int key) Find the target for this class by the primary key
DBTask	findSystem(java.lang.String... args) The system to record the transaction id for.
DBClassAbstract	getClassId(java.lang.String... args)
DBClassSyncCondition[]	getClassSyncConditions() Retrieve a list of the sync map records.
int	getID(java.lang.String... args)
DBTask	getSystem(java.lang.String... args)
boolean	isConditionSatisfied(DBObject obj) To check weather the condition satisfied for the task on given object
static DBQuery<DBClassSyncMap>	makeQuery(DataSource ds) Make a new QUERY for this class.
DBClassSyncMap	setClassId(com.aspc.dal.dbobj.DBClassAbstract value, java.lang.String... args)
DBClassSyncMap	setID(int value, java.lang.String... args)
DBClassSyncMap	setSystem(com.aspc.dal.task.DBTask 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

Should we record the per system transactions id. This is for synchronization of external systems.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Should we record the per system transactions id. This is for synchronization of external systems.

Constructor Detail

DBClassSyncMap

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

getID

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

setID

@Nonnull
public DBClassSyncMap setID(int value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getClassId

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

findClassId

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

The class that needs to be sync'd for this system.

--> DBClassAbstract (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

DBClassAbstract

Throws:

NotFoundException - DBClassAbstract was not found

setClassId

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

Throws:

java.lang.Exception

getSystem

@CheckReturnValue
 @Nullable
public DBTask getSystem(java.lang.String... args)

findSystem

@CheckReturnValue
 @Nonnull
public final DBTask findSystem(java.lang.String... args)
                                                    throws NotFoundException

The system to record the transaction id for.

--> DBTask (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

Tasks

Throws:

NotFoundException - DBTask was not found

setSystem

@Nonnull
public DBClassSyncMap setSystem(com.aspc.dal.task.DBTask value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

create

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

eventDependantAdded

public void eventDependantAdded(GlobalKey addedKey,
                                GlobalKey sourceFieldKey)

A record that points to this record was added. The object is available via findKey.

Specified by:

eventDependantAdded in interface DependanceListener

Parameters:

addedKey - The record's key that was added.

sourceFieldKey - Via which field is this object linked ?

eventDependantRemoved

public void eventDependantRemoved(GlobalKey removedKey,
                                  GlobalKey sourceFieldKey)

A record that points to this record was removed. Only the global key is avaliable now.

Specified by:

eventDependantRemoved in interface DependanceListener

Parameters:

removedKey - The record key that was removed.

sourceFieldKey - Via which field was this object linked ?

getClassSyncConditions

public DBClassSyncCondition[] getClassSyncConditions()
                                              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

clearCache

public void clearCache()

clear the cache whenever the sync conditions are changed

isConditionSatisfied

public boolean isConditionSatisfied(DBObject obj)
                             throws java.lang.Exception

To check weather the condition satisfied for the task on given object

Parameters:

obj - Object for which the condition need to be checked.

Returns:

true if condition is satisfied

Throws:

java.lang.Exception - Serious problem