com.aspc.DBObj.Internal

Class ModData

java.lang.Object

com.aspc.DBObj.Internal.ModData

All Implemented Interfaces:

java.lang.Cloneable

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

ModData records the original, previous, default and current values/keys for fields that have been changed for a DBObject sourced from a MutableDataDource. The previous and original values/keys are used to determine the events that should fired off as an object is modified. Updating a person's name from jack to Jill twice should not call extFieldUpdated twice but should record the field is actually changed. THREAD MODE: SINGLE-THREADED mutable data source

Since:

7 July, 2002, 5:54 PM

Author:

Nigel Leck

Constructor Summary

Constructors

Constructor and Description
ModData(DBField field, java.lang.Object originalValue, GlobalKey originalKey) Creates a new modification data for a field.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Clone the mod data
GlobalKey	getCurrentKey() Gets the current global key for this LINKED field
java.lang.Object	getCurrentValue() The current value of the field.
GlobalKey	getDefaultKey() The default value's global key
java.lang.Object	getDefaultValue() What is the "default" value for this field ? A DBObject that is NEW and only contains default values is said to be EMPTY.
DBField	getField() The field that this modification data is for.
java.lang.Long	getKey() The global key of the field for which this modification data is for.
DBClass	getLookupClass() returns the Lookup Class.
DBField	getLookupFld() returns the Lookup Field.
java.lang.String	getLookupValue() returns the Lookup Value.
GlobalKey	getOriginalKey() The original global key for this field.
java.lang.Object	getOriginalValue() The original value for this field.
GlobalKey	getPreviousKey() returns the previous global key.
java.lang.Object	getPreviousValue() The previous value of these field.
boolean	isChangedByUser() Was this field changed by the user ?
void	setChangedByUser(boolean flag) mark as changed by the user.
void	setCurrentKey(GlobalKey gk) Sets the current global key for the field.
void	setCurrentValue(java.lang.Object value) Sets the current value of this field.
void	setDefaultKey(GlobalKey gk) Sets the default's value global key
void	setDefaultValue(java.lang.Object value) Sets the default value of the field.
void	setLookup(DBClass cls, DBField fld, java.lang.String val) Sets the previous global key
void	setPreviousKey(GlobalKey gk) Sets the previous global key
void	setPreviousValue(java.lang.Object value) Sets the previous value of the field.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModData

public ModData(@Nonnull
               DBField field,
               @Nullable
               java.lang.Object originalValue,
               @Nullable
               GlobalKey originalKey)

Creates a new modification data for a field.

Parameters:

field - The field that has been changed.

originalValue - The original value of the field which is non mutable.

originalKey - The original global key for a field which will be non mutable.

Method Detail

setChangedByUser

public void setChangedByUser(boolean flag)

mark as changed by the user.

Parameters:

flag - Was changed ?

isChangedByUser

@CheckReturnValue
public boolean isChangedByUser()

Was this field changed by the user ?

Returns:

true if changed.

getKey

@CheckReturnValue
 @Nonnull
public java.lang.Long getKey()

The global key of the field for which this modification data is for.

Returns:

The global key of the field.

getField

@CheckReturnValue
 @Nonnull
public DBField getField()

The field that this modification data is for.

Returns:

The field.

getCurrentValue

@CheckReturnValue
 @Nullable
public java.lang.Object getCurrentValue()

The current value of the field.

Returns:

The value

setCurrentValue

public void setCurrentValue(java.lang.Object value)

Sets the current value of this field.

Parameters:

value - The current value.

getCurrentKey

@CheckReturnValue
 @Nullable
public GlobalKey getCurrentKey()

Gets the current global key for this LINKED field

Returns:

The field's global key

setCurrentKey

public void setCurrentKey(GlobalKey gk)

Sets the current global key for the field.

Parameters:

gk - The current global key.

getDefaultValue

@CheckReturnValue
 @Nullable
public java.lang.Object getDefaultValue()

What is the "default" value for this field ? A DBObject that is NEW and only contains default values is said to be EMPTY. The status of being EMPTY is very important for screen elements like SDBPortals

Returns:

The default value

clone

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

Clone the mod data

Overrides:

clone in class java.lang.Object

Returns:

The cloned version

Throws:

java.lang.CloneNotSupportedException - should not happen

setDefaultValue

public void setDefaultValue(java.lang.Object value)

Sets the default value of the field. TODO: Should this be as part of the constructor ?

Parameters:

value - The default value.

getDefaultKey

@CheckReturnValue
 @Nullable
public GlobalKey getDefaultKey()

The default value's global key

Returns:

The global key for the default value.

setDefaultKey

public void setDefaultKey(GlobalKey gk)

Sets the default's value global key

Parameters:

gk - The default global key for this field.

getOriginalValue

@CheckReturnValue
 @Nullable
public java.lang.Object getOriginalValue()

The original value for this field.

Returns:

The original value

getOriginalKey

@CheckReturnValue
 @Nullable
public GlobalKey getOriginalKey()

The original global key for this field.

Returns:

The global key.

getPreviousValue

@CheckReturnValue
 @Nullable
public java.lang.Object getPreviousValue()

The previous value of these field.

Returns:

The previous value.

setPreviousValue

public void setPreviousValue(java.lang.Object value)

Sets the previous value of the field. Which maybe different to the original value of the field.

Parameters:

value - The previous value.

getPreviousKey

@CheckReturnValue
 @Nullable
public GlobalKey getPreviousKey()

returns the previous global key.

Returns:

the global key.

setPreviousKey

public void setPreviousKey(GlobalKey gk)

Sets the previous global key

Parameters:

gk - The previous global key.

getLookupClass

@CheckReturnValue
 @Nullable
public DBClass getLookupClass()

returns the Lookup Class.

Returns:

the field.

getLookupFld

@CheckReturnValue
 @Nullable
public DBField getLookupFld()

returns the Lookup Field.

Returns:

the field.

getLookupValue

@CheckReturnValue
 @Nullable
public java.lang.String getLookupValue()

returns the Lookup Value.

Returns:

the string value.

setLookup

public void setLookup(DBClass cls,
                      DBField fld,
                      java.lang.String val)

Sets the previous global key

Parameters:

cls - The class

fld - the field

val - the value