com.aspc.DBObj.Internal

Interface DBDataInterface

All Known Implementing Classes:

ArchiveData, DBData

public interface DBDataInterface

DBDataInterface is the raw data interface with the physical database.
THREAD MODE: MULTI-THREADED

Since:

March 19, 2002

Author:

Nigel Leck

Method Summary

Modifier and Type	Method and Description
void	addDependanceListener(DependanceListener dl) Add a dependence listener
int	getBaseLayerId() The base layer for this record.
GlobalKey	getGlobalKey(Hint hint) The globalKey for this DBData.
GlobalKey	getGlobalKey(VirtualDB layer, DBField field, Hint hint) Retrieve the global key for this field.
LayerData	getLayerData(VirtualDB layer, Hint hint) Return the layer data for this record
long	getLinkedRowId(VirtualDB layer, DBField field, Hint hint)
java.lang.Object	getRawValue(VirtualDB layer, 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 layer, Hint hint) Return the REAL DBClass if known.
GlobalKeyId	getRootDBClassId() Return the best guess at what the REAL DBClass is.
long	getRowId() The row id for this database object.
long	getTransId(VirtualDB layer, Hint hint) The current transaction id for this database object.
boolean	hasRawFieldInLayer(VirtualDB layer, 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 layer, Hint hint) Does raw data for a record exist in this layer ? This ignores the final flag as it is used for deleting data.
boolean	isDeleted(VirtualDB layer, Hint hint) Is the database object deleted.
boolean	isFinal(VirtualDB layer, Hint hint) Is this layer's 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
void	reloadLayer(VirtualDB layer) Reloads this layer's data from the raw database.

Method Detail

getRootDBClassId

@CheckReturnValue
 @Nonnull
GlobalKeyId getRootDBClassId()

Return the best guess at what the REAL DBClass is.

Returns:

The DBClass

getRealDBClass

@CheckReturnValue
 @Nonnull
DBClass getRealDBClass(@Nonnull
                                                   VirtualDB layer,
                                                   @Nullable
                                                   Hint hint)

Return the REAL DBClass if known.

Parameters:

layer - the layer

hint -

Returns:

The DBClass

getGlobalKey

@CheckReturnValue
 @Nonnull
GlobalKey getGlobalKey(@Nullable
                                                   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.

Parameters:

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

Returns:

The global key

getRawValue

@CheckReturnValue
 @Nullable
java.lang.Object getRawValue(@Nonnull
                                                          VirtualDB layer,
                                                          @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.

Parameters:

layer - 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.

getGlobalKey

@CheckReturnValue
 @Nullable
GlobalKey getGlobalKey(@Nonnull
                                                    VirtualDB layer,
                                                    @Nonnull
                                                    DBField field,
                                                    @Nullable
                                                    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.

Parameters:

layer - 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.

reloadLayer

void reloadLayer(@Nonnull
                 VirtualDB layer)
          throws java.lang.Exception

Reloads this layer's data from the raw database.

Parameters:

layer - For which layer

Throws:

java.lang.Exception - A serious problem.

getRowId

@CheckReturnValue
long getRowId()

The row id for this database object.

Returns:

The row id

getTransId

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

The current transaction id for this database object.

Parameters:

layer - Which layer

hint - What other rows.

Returns:

The current transaction id for this database object/layer

isDeleted

@CheckReturnValue
boolean isDeleted(@Nonnull
                                    VirtualDB layer,
                                    @Nullable
                                    Hint hint)

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

Parameters:

layer - In which layer ?

hint - What other rows will you be asking about

Returns:

Is the record deleted in this layer

register

void register(@Nonnull
              DBObject theObject)

registers any objects that contain this data object this allows us to notify these objects of any changes made to the data

Parameters:

theObject - to notify

getLayerData

@CheckReturnValue
 @Nonnull
LayerData getLayerData(@Nonnull
                                                   VirtualDB layer,
                                                   @Nullable
                                                   Hint hint)

Return the layer data for this record

Parameters:

layer - From which layer

hint - What other records will you be asking

Returns:

The layer data for this record.

getLinkedRowId

@CheckReturnValue
long getLinkedRowId(@Nonnull
                                      VirtualDB layer,
                                      @Nonnull
                                      DBField field,
                                      @Nullable
                                      Hint hint)

Parameters:

layer - the layer

field - The field

hint -

Returns:

the value

addDependanceListener

void addDependanceListener(@Nonnull
                           DependanceListener dl)

Add a dependence listener

Parameters:

dl - The listener

getBaseLayerId

@CheckReturnValue
int getBaseLayerId()

The base layer for this record.

Returns:

The virtualDB id

hasRawFieldInLayer

@CheckReturnValue
boolean hasRawFieldInLayer(@Nonnull
                                             VirtualDB layer,
                                             @Nonnull
                                             DBField field,
                                             @Nullable
                                             Hint hint)

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

Parameters:

layer - From which layer.

field - The field

hint - Which other rows.

Returns:

True if has a raw field record

hasRawRowInLayer

@CheckReturnValue
boolean hasRawRowInLayer(@Nonnull
                                           VirtualDB layer,
                                           @Nullable
                                           Hint hint)

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

Parameters:

layer - From which layer

hint - Which other rows.

Returns:

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

isFinal

@CheckReturnValue
boolean isFinal(@Nonnull
                                  VirtualDB layer,
                                  @Nullable
                                  Hint hint)

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

Parameters:

layer - From which layer.

hint - What other rows.

Returns:

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