com.aspc.DBObj.Internal.Helper

Class DBObjectHelper

java.lang.Object

com.aspc.DBObj.Internal.Helper.DBObjectHelper

All Implemented Interfaces:

java.lang.Cloneable

public final class DBObjectHelper
extends java.lang.Object
implements java.lang.Cloneable

Helper class for DBObject.
THREAD MODE: MULTI-THREADED

Since:

9 October 2002

Author:

Nigel Leck

Field Summary

Fields

Modifier and Type	Field and Description
GlobalKey	cacheGlobalKey Cache the Global key which is used through out the System ( Only used in mutable mode)
boolean	deleted deleted object
java.util.HashMap<java.lang.String,java.lang.String>	denormalizedData
boolean	disableOnChange disable the on change so that we can clone the object.
boolean	forceReindex force re-index
java.lang.Long	newRowKey cache of the newly created row key
boolean	reindexOnly re-index only
boolean	savingNewRecord saving new record.
boolean	undeleted undeleted object
java.util.concurrent.ConcurrentHashMap<java.lang.Long,ModData>	updatedData Holds all data for fields that have been changed up the user.

Constructor Summary

Constructors

Constructor and Description
DBObjectHelper(DBObject base)

Method Summary

Modifier and Type	Method and Description
void	addCascadeDelete(DBObject obj)
void	addDenormalizedResult(java.lang.String code, java.lang.String data)
static java.lang.Object	calculateValue(DBObject obj, DBField field, java.lang.Object defaultValue) same as getValue but throws Exceptions
java.lang.Object	clone()
void	doUndelete()
static void	fireOnChange(DBObject obj, DBField field, FldParams params)
void	forcelockedTransaction(long validatedTransId)
DBObject	getDeletedBy()
long	getLockedTransaction()
Login	getLogin()
ModData	getModData(DBField field)
static boolean	hasChanged(DBObject obj) Has this object changed since last save Are all fields are blank or the auto entered values ?
static boolean	hasChangedByUser(DBObject obj) Has the user changed this object since last save Are all fields are blank or the auto entered values ?
static java.util.ArrayList	iAddEventListener(DBObject obj, java.util.ArrayList orgListeners, Watcher watcher) Handle the event listener.
long	lastTouched()
static java.lang.Object	makeCurrentValue(DataSource ds, DBField field, java.lang.Object userValue, java.lang.Object previousValueActual, GlobalKey currentKey, java.lang.String language, FldParams inParams)
static java.lang.Long	makeKey(DBField field)
static GlobalKey	makeLinkedKey(DataSource ds, DBField field, boolean isLinked, java.lang.Object orgValue, FldParams inParams)
DBObjectHelper	makeSavePoint(java.lang.String id)
static void	raiseDependantAddedEvent(DataSource ds, GlobalKey sourceKey, GlobalKey targetKey, GlobalKey sourceFieldKey) Within the MutableData Source notify when objects are added and removed.
static void	raiseDependantAddedEvent(GlobalKey sourceKey, DBObject target, GlobalKey sourceFieldKey) Within the MutableData Source notify when objects are added and removed.
static void	raiseDependantRemovedEvent(DataSource ds, GlobalKey sourceKey, GlobalKey targetKey, GlobalKey sourceFieldKey) Within the MutableData Source notify when objects are added and removed.
static void	raiseDependantRemovedEvent(GlobalKey sourceKey, DBObject target, GlobalKey sourceFieldKey) Within the MutableData Source notify when objects are added and removed.
static void	raiseEvents(MutableDataSource ds, DBObject base) Raise Events that matches the current state of the object
static void	removeEventListener(java.util.ArrayList listeners, Watcher watcher)
DBObjectHelper	rollbackTo(java.lang.String id) Rollback to save point.
void	setClearedBy(DBObject obj, DBField field)
void	setDeletedBy(DBObject obj)
void	setlockedTransaction(long validatedTransId)
void	touch(long time)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

updatedData

public java.util.concurrent.ConcurrentHashMap<java.lang.Long,ModData> updatedData

Holds all data for fields that have been changed up the user. updatedData is created when the first field is changed and is cleared after the extPostSave method is called on a successful save. When a user requests a field value or linkage the updatesData map is checked first. If the field's global key has an entry then this value is used.

denormalizedData

public java.util.HashMap<java.lang.String,java.lang.String> denormalizedData

cacheGlobalKey

public GlobalKey cacheGlobalKey

Cache the Global key which is used through out the System ( Only used in mutable mode)

disableOnChange

public boolean disableOnChange

disable the on change so that we can clone the object.

forceReindex

public boolean forceReindex

force re-index

reindexOnly

public boolean reindexOnly

re-index only

deleted

public boolean deleted

deleted object

undeleted

public boolean undeleted

undeleted object

newRowKey

public java.lang.Long newRowKey

cache of the newly created row key

savingNewRecord

public boolean savingNewRecord

saving new record.

Constructor Detail

DBObjectHelper

public DBObjectHelper(@Nonnull
                      DBObject base)

Parameters:

base - the base object

Method Detail

iAddEventListener

public static java.util.ArrayList iAddEventListener(DBObject obj,
                                                    java.util.ArrayList orgListeners,
                                                    Watcher watcher)

Handle the event listener. Check for duplicated registered objects

Parameters:

obj -

orgListeners -

watcher -

Returns:

the value

addDenormalizedResult

public void addDenormalizedResult(java.lang.String code,
                                  java.lang.String data)

makeSavePoint

@Nonnull
 @CheckReturnValue
public DBObjectHelper makeSavePoint(@Nonnull
                                                                java.lang.String id)

Parameters:

id -

Returns:

the value

rollbackTo

@Nullable
 @CheckReturnValue
public DBObjectHelper rollbackTo(@Nullable
                                                              java.lang.String id)
                                                       throws NoSavePointException

Rollback to save point.

Parameters:

id - the save point id

Returns:

the value

Throws:

NoSavePointException - no save point found

clone

@CheckReturnValue
 @Nonnull
public java.lang.Object clone()
                                                   throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Returns:

the value

Throws:

java.lang.CloneNotSupportedException

removeEventListener

public static void removeEventListener(@Nullable
                                       java.util.ArrayList listeners,
                                       @Nullable
                                       Watcher watcher)

Parameters:

listeners -

watcher -

raiseDependantAddedEvent

public static void raiseDependantAddedEvent(@Nonnull
                                            GlobalKey sourceKey,
                                            @Nullable
                                            DBObject target,
                                            @Nonnull
                                            GlobalKey sourceFieldKey)

Within the MutableData Source notify when objects are added and removed. The "real" notification will happen when the object is saved.

Parameters:

sourceKey -

target -

sourceFieldKey -

raiseDependantRemovedEvent

public static void raiseDependantRemovedEvent(@Nonnull
                                              GlobalKey sourceKey,
                                              @Nullable
                                              DBObject target,
                                              @Nonnull
                                              GlobalKey sourceFieldKey)

Within the MutableData Source notify when objects are added and removed. The "real" notification will happen when the object is saved.

Parameters:

sourceKey -

target -

sourceFieldKey -

raiseDependantAddedEvent

public static void raiseDependantAddedEvent(@Nonnull
                                            DataSource ds,
                                            @Nonnull
                                            GlobalKey sourceKey,
                                            @Nullable
                                            GlobalKey targetKey,
                                            @Nonnull
                                            GlobalKey sourceFieldKey)

Within the MutableData Source notify when objects are added and removed. The "real" notification will happen when the object is saved.

Parameters:

ds - the data source

sourceKey -

targetKey -

sourceFieldKey -

raiseDependantRemovedEvent

public static void raiseDependantRemovedEvent(@Nonnull
                                              DataSource ds,
                                              @Nonnull
                                              GlobalKey sourceKey,
                                              @Nullable
                                              GlobalKey targetKey,
                                              @Nonnull
                                              GlobalKey sourceFieldKey)

Within the MutableData Source notify when objects are added and removed. The "real" notification will happen when the object is saved.

Parameters:

ds - the data source

sourceKey -

targetKey -

sourceFieldKey -

calculateValue

@Nullable
 @CheckReturnValue
public static java.lang.Object calculateValue(@Nonnull
                                                                           DBObject obj,
                                                                           @Nonnull
                                                                           DBField field,
                                                                           @Nullable
                                                                           java.lang.Object defaultValue)
                                                                    throws java.lang.Exception

same as getValue but throws Exceptions

Parameters:

obj -

field - The field

defaultValue -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

raiseEvents

public static void raiseEvents(@Nonnull
                               MutableDataSource ds,
                               @Nonnull
                               DBObject base)
                        throws java.lang.Exception

Raise Events that matches the current state of the object

Parameters:

ds - the data source

base - the base object

Throws:

java.lang.Exception - a serious problem

forcelockedTransaction

public void forcelockedTransaction(@Nonnegative
                                   long validatedTransId)

Parameters:

validatedTransId -

setlockedTransaction

public void setlockedTransaction(@Nonnegative
                                 long validatedTransId)

Parameters:

validatedTransId -

getLockedTransaction

@Nonnegative
 @CheckReturnValue
public long getLockedTransaction()

Returns:

the value

fireOnChange

public static void fireOnChange(@Nonnull
                                DBObject obj,
                                @Nonnull
                                DBField field,
                                @Nullable
                                FldParams params)
                         throws java.lang.Exception

Parameters:

obj -

field - The field

params - the field parameters

Throws:

java.lang.Exception - a serious problem

hasChanged

@CheckReturnValue
public static boolean hasChanged(@Nonnull
                                                   DBObject obj)

Has this object changed since last save

Are all fields are blank or the auto entered values ?

Parameters:

obj -

Returns:

True if changed

hasChangedByUser

@CheckReturnValue
public static boolean hasChangedByUser(@Nonnull
                                                         DBObject obj)

Has the user changed this object since last save

Are all fields are blank or the auto entered values ?

Parameters:

obj -

Returns:

True if changed

makeCurrentValue

@CheckReturnValue
 @Nullable
public static java.lang.Object makeCurrentValue(@Nonnull
                                                                             DataSource ds,
                                                                             @Nonnull
                                                                             DBField field,
                                                                             @Nullable
                                                                             java.lang.Object userValue,
                                                                             @Nullable
                                                                             java.lang.Object previousValueActual,
                                                                             @Nullable
                                                                             GlobalKey currentKey,
                                                                             @Nullable
                                                                             java.lang.String language,
                                                                             @Nullable
                                                                             FldParams inParams)

Parameters:

ds - the data source

field - The field

userValue -

previousValueActual - actual value

currentKey -

language - the language

inParams - the parameters to use

Returns:

the value

makeLinkedKey

@Nullable
 @CheckReturnValue
public static GlobalKey makeLinkedKey(DataSource ds,
                                                                   DBField field,
                                                                   boolean isLinked,
                                                                   java.lang.Object orgValue,
                                                                   FldParams inParams)
                                                            throws java.lang.Exception

Parameters:

ds - the data source

field - The field

isLinked -

orgValue -

inParams -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

getDeletedBy

@CheckReturnValue
 @Nullable
public DBObject getDeletedBy()

Returns:

the value

setDeletedBy

public void setDeletedBy(@Nullable
                         DBObject obj)

Parameters:

obj -

doUndelete

public void doUndelete()
                throws java.lang.Exception

Throws:

java.lang.Exception - a serious problem

setClearedBy

public void setClearedBy(@Nonnull
                         DBObject obj,
                         @Nonnull
                         DBField field)

Parameters:

obj -

field - The field

addCascadeDelete

public void addCascadeDelete(@Nonnull
                             DBObject obj)

Parameters:

obj -

getLogin

@CheckReturnValue
 @Nonnull
public Login getLogin()

Returns:

the value

lastTouched

@CheckReturnValue
public long lastTouched()

Returns:

the value

touch

public void touch(long time)

Parameters:

time -

makeKey

@CheckReturnValue
 @Nonnull
public static java.lang.Long makeKey(@Nonnull
                                                                 DBField field)

getModData

@CheckReturnValue
 @Nullable
public ModData getModData(@Nonnull
                                                       DBField field)