com.aspc.DBObj.Archive

Class ArchiveData

java.lang.Object

com.aspc.DBObj.Archive.ArchiveData

All Implemented Interfaces:

DBDataInterface

public class ArchiveData
extends java.lang.Object
implements DBDataInterface

Archive data.
THREAD MODE: MULTI-THREADED

Since:

May 1, 2001, 13:30 PM

Author:

Nigel Leck

Constructor Summary

Constructors

Constructor and Description
ArchiveData(DBData data, ArchiveDataSource ads) The archive data

Method Summary

Modifier and Type	Method and Description
void	addDependanceListener(DependanceListener dl) Add a dependence listener No changes can ever be made to an archive data source so we will never notify dependences added or removed.
int	getBaseLayerId() The base layer for this record.
GlobalKey	getGlobalKey(Hint hint) The globalKey for this DBData.
GlobalKey	getGlobalKey(VirtualDB vDB, DBField field, Hint hint) Retrieve the global key for this field.
LayerData	getLayerData(VirtualDB layer, Hint hint) Return the layer data for this record We'll just return the normal DBData if 1) The matching transaction header can't be found.
long	getLinkedRowId(VirtualDB vDB, DBField field, Hint hint) Get the linked row id if known.
java.lang.Object	getRawValue(VirtualDB vDB, DBField field, Hint hint) Retrieves the raw data for the specified field the supplied virtual db indicates how the object views the data for this field We will scroll down the virtual db tree until we find a value for the field.
DBClass	getRealDBClass(VirtualDB vDB, Hint hint) Return the REAL DBClass if known
GlobalKeyId	getRootDBClassId() The root class
long	getRowId() The row id for this database object.
long	getTransId(VirtualDB vDB, Hint hint) The current transaction id for this database object.
boolean	hasRawFieldInLayer(VirtualDB vDB, DBField field, Hint hint) Does raw data for a field exist in this layer ? This ignores the final flag as it is used for deleting data.
boolean	hasRawRowInLayer(VirtualDB vDB, Hint hint) Does raw data for a field exist in this layer ? This ignores the final flag as it is used for deleting data.
boolean	isDeleted(VirtualDB vDB, Hint hint) Is the database object deleted.
boolean	isFinal(VirtualDB vDB, Hint hint) Is this layers data marked as final ? No changes may be recorded for a record that is final from below.
void	register(DBObject theObject) registers any objects that contain this data object this allows us to notify these objects of any changes made to the data READ ONLY So we don't care.
void	reloadLayer(VirtualDB vDB) Reloads this layer's data from the raw database.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArchiveData

public ArchiveData(DBData data,
                   ArchiveDataSource ads)

The archive data

Parameters:

data - the current data

ads - the data source.

Method Detail

addDependanceListener

public void addDependanceListener(DependanceListener dl)

Add a dependence listener No changes can ever be made to an archive data source so we will never notify dependences added or removed.

Specified by:

addDependanceListener in interface DBDataInterface

Parameters:

dl - The listener

getBaseLayerId

public int getBaseLayerId()

The base layer for this record.

Specified by:

getBaseLayerId in interface DBDataInterface

Returns:

The virtualDB id

getRootDBClassId

public GlobalKeyId getRootDBClassId()

The root class

Specified by:

getRootDBClassId in interface DBDataInterface

Returns:

the class id

getGlobalKey

public GlobalKey getGlobalKey(Hint hint)

The globalKey for this DBData. PERFORMANCE: Cache the globalKey for future use. By design the key may not
be changed once the record has been created. Don't cache the global key if it doesn't have a row Id yet. As this may change and wont know.

Specified by:

getGlobalKey in interface DBDataInterface

Parameters:

hint - If we need to hit the database, then also get these rows

Returns:

The global key

getGlobalKey

public GlobalKey getGlobalKey(VirtualDB vDB,
                              DBField field,
                              Hint hint)

Retrieve the global key for this field. We'll scroll down the virtual db tree until we find a value for this field.

Specified by:

getGlobalKey in interface DBDataInterface

Parameters:

vDB - Which layer.

field - The field to get

hint - Which other rows will we be asking for.

Returns:

The global key for this field in this layer.

getLayerData

@CheckReturnValue
public LayerData getLayerData(VirtualDB layer,
                                                Hint hint)

Return the layer data for this record

We'll just return the normal DBData if
1) The matching transaction header can't be found.
2) The transaction date is less than required as of date.

Specified by:

getLayerData in interface DBDataInterface

Parameters:

layer - the data layer

hint - What other records will you be asking

Returns:

The layer data for this record.

getLinkedRowId

@CheckReturnValue
public long getLinkedRowId(VirtualDB vDB,
                                             DBField field,
                                             Hint hint)

Get the linked row id if known.

Specified by:

getLinkedRowId in interface DBDataInterface

Parameters:

vDB - Which layer.

field - The field to get

hint - Which other rows will we be asking for.

Returns:

The global key for this field in this layer.

getRawValue

@CheckReturnValue
public java.lang.Object getRawValue(@Nonnull
                                                      VirtualDB vDB,
                                                      @Nonnull
                                                      DBField field,
                                                      @Nullable
                                                      Hint hint)

Retrieves the raw data for the specified field the supplied virtual db indicates how the object views the data for this field We will scroll down the virtual db tree until we find a value for the field.

Specified by:

getRawValue in interface DBDataInterface

Parameters:

vDB - Which layer.

field - The field to get

hint - Which other rows will we be asking for.

Returns:

The value of the field in this layer.

getRealDBClass

@CheckReturnValue
public DBClass getRealDBClass(VirtualDB vDB,
                                                Hint hint)

Return the REAL DBClass if known

Specified by:

getRealDBClass in interface DBDataInterface

Parameters:

vDB - the layer

hint - the hint of other records to load.

Returns:

The DBClass

getRowId

@CheckReturnValue
public long getRowId()

The row id for this database object.

Specified by:

getRowId in interface DBDataInterface

Returns:

The row id

getTransId

@CheckReturnValue
public long getTransId(@Nonnull
                                         VirtualDB vDB,
                                         @Nullable
                                         Hint hint)

The current transaction id for this database object.

Specified by:

getTransId in interface DBDataInterface

Parameters:

vDB - Which layer

hint - What other rows.

Returns:

The current transaction id for this database object/layer

hasRawFieldInLayer

public boolean hasRawFieldInLayer(VirtualDB vDB,
                                  DBField field,
                                  Hint hint)

Does raw data for a field exist in this layer ? This ignores the final flag as it is used for deleting data.

Specified by:

hasRawFieldInLayer in interface DBDataInterface

Parameters:

vDB - From which layer.

field - The field

hint - Which other rows.

Returns:

True if has a raw field record

hasRawRowInLayer

public boolean hasRawRowInLayer(VirtualDB vDB,
                                Hint hint)

Does raw data for a field exist in this layer ? This ignores the final flag as it is used for deleting data.

Specified by:

hasRawRowInLayer in interface DBDataInterface

Parameters:

vDB - From which layer

hint - Which other rows.

Returns:

True if it has a raw record row the in database.

isDeleted

public boolean isDeleted(VirtualDB vDB,
                         Hint hint)

Is the database object deleted. An object may be active in a layer below but deleted in a layer above.

Specified by:

isDeleted in interface DBDataInterface

Parameters:

vDB - In which layer ?

hint - What other rows will you be asking about

Returns:

Is the record deleted in this layer

isFinal

public boolean isFinal(VirtualDB vDB,
                       Hint hint)

Is this layers data marked as final ? No changes may be recorded for a record that is final from below.

Specified by:

isFinal in interface DBDataInterface

Parameters:

vDB - From which layer.

hint - What other rows.

Returns:

Is it final in this layer? ( can I make changes)

register

public void register(DBObject theObject)

registers any objects that contain this data object this allows us to notify these objects of any changes made to the data READ ONLY So we don't care.

Specified by:

register in interface DBDataInterface

Parameters:

theObject - to notify

reloadLayer

public void reloadLayer(VirtualDB vDB)
                 throws java.lang.Exception

Reloads this layer's data from the raw database. READ ONLY So we don't care.

Specified by:

reloadLayer in interface DBDataInterface

Parameters:

vDB - For which layer

Throws:

java.lang.Exception - A serious problem.