com.aspc.DBObj.Archive

Class TransHeader

java.lang.Object

com.aspc.DBObj.Archive.TransHeader

public final class TransHeader
extends java.lang.Object

Transaction header.
THREAD MODE: MULTI-THREADED

Since:

May 1, 2001, 13:30 PM

Author:

Nigel Leck

Constructor Summary

Constructors

Constructor and Description
TransHeader(VirtualDB layer, long transId, java.util.Date transDate, java.lang.String personGlobalID, java.lang.String reason, java.lang.Long transGroupId, boolean inSlave)

Method Summary

Modifier and Type	Method and Description
void	adjustReason(java.lang.String reason)
static boolean	assertTransIdValid(long transId) check if the transaction is valid
void	checkInMemory() Checks that all the records modified in this transaction are if in cache at least up to this transaction number.
boolean	dataKnownToExistAt(DBData data) is it know that this record existed at the time of this transaction.
static void	disableTranIdAsserts() Disable the assert checks for transaction ids.
TransRecord[]	fetchRecordList() fetch the record list from cache.
ArchiveLayerData	findFilteredLayerData(long rowId, DBClass realClass, java.util.Date asOfDate, Hint hint, TransHeader[] exclude, boolean doNotUseCurrentData) filter the result by classType and asOfDate
DBObject	findKey(GlobalKey gKey, ArchiveDataSource ads) Finds a new DBObject by its primary key INTERNAL ONLY
TransGroup	findTransGroup() return the transaction group.
java.lang.String	getActions()
ArchiveLayerData	getCachedLayerData(long rowUID)
PossibleRowsHolder[]	getClauseCache(DBClass dbClass, DBPathClause clause) Check the cache for this clause.
VirtualDB	getDatabase()
java.lang.String	getKey()
Person	getPerson()
java.lang.String	getpersonGlobalID() The personGlobalID for this transaction.
java.lang.String	getReason() The reason for this transaction.
TransRecord[]	getRecordList()
TransRecord	getRow(long row_uid)
long	getTranGroupId() The transaction group
static java.util.Date	getTranscationDate(DBObject obj, DBField fld, java.lang.Object value, java.util.Date fromDate, java.util.Date toDate) Returns the transaction date of the object when field is updated to value between fromDate and toDate If field is updated to value more than once between fromDate and toDate, the latest transaction date will be returned.
java.util.Date	getTransDate()
long	getTransId() returns the transaction id for this transaction header.
static TransHeader	latestTransaction(DBObject obj)
static TransHeader	latestTransaction(DBObject obj, VirtualDB vDB) Gets latest Transaction for this object in specified datasource
static TransHeader	latestTransactionInLayers(DBObject obj) Gets Latest Transaction from family of layers
static TransHeader[]	listTransaction(DBClass cls, long rowUID, java.util.Date fromDate, java.util.Date toDate) List of all the transactions for this Object between fromDate and toDate
static TransHeader[]	listTransaction(DBClass dbClass, long rowUid, long mustFindTransId)
static TransHeader[]	listTransaction(DBObject obj) List of all the transactions for this Object
static TransHeader[]	listTransaction(DBObject obj, java.util.Date fromDate, java.util.Date toDate) List of all the transactions for this Object between fromDate and toDate
static TransHeader[]	listTransaction(Path path, long rowUID, java.util.Date fromDate, java.util.Date toDate, boolean listAll) List of all the transactions for this Object between fromDate and toDate
static TransHeader[]	listTransaction(VirtualDB layer, java.util.Date fromDate, java.util.Date toDate) List of all the transactions for this Object between fromDate and toDate
static TransHeader	maxTransaction(VirtualDB layer, DBClass dbClass, long rowUid)
void	placeCachedLayerData(long rowUID, ArchiveLayerData ld) place into cache
DBObject	restore()
long	reverse(Login login)
long	reverse(Login login, boolean replayMode, boolean eraseMode)
void	reverse(MutableDataSource mds, boolean replayMode)
static java.lang.Iterable<TransHeader>	search(VirtualDB layer, java.util.Date fromDate)
static void	sortHeaders(TransHeader[] list)
void	stats(CollectorDBClass collector)
java.lang.String	toString() to string
static void	writeThreadEraseLog(java.lang.String msg) write to the current log

Methods inherited from class java.lang.Object

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

Constructor Detail

TransHeader

public TransHeader(@Nonnull
                   VirtualDB layer,
                   long transId,
                   @Nonnull
                   java.util.Date transDate,
                   java.lang.String personGlobalID,
                   java.lang.String reason,
                   java.lang.Long transGroupId,
                   boolean inSlave)

Parameters:

layer - the layer

transId - the transaction

transDate - the date

personGlobalID - the person

reason - the reason

transGroupId - the group

inSlave - is a slave

Method Detail

getCachedLayerData

@CheckReturnValue
 @Nullable
public ArchiveLayerData getCachedLayerData(long rowUID)

Parameters:

rowUID - the row

Returns:

the cached archive layer data

placeCachedLayerData

public void placeCachedLayerData(long rowUID,
                                 @Nonnull
                                 ArchiveLayerData ld)

place into cache

Parameters:

rowUID - the row

ld - the layer data

search

@CheckReturnValue
 @Nonnull
public static java.lang.Iterable<TransHeader> search(@Nonnull
                                                                                 VirtualDB layer,
                                                                                 @Nonnull
                                                                                 java.util.Date fromDate)

findFilteredLayerData

@CheckReturnValue
 @Nonnull
public ArchiveLayerData findFilteredLayerData(long rowId,
                                                                          DBClass realClass,
                                                                          java.util.Date asOfDate,
                                                                          Hint hint,
                                                                          TransHeader[] exclude,
                                                                          boolean doNotUseCurrentData)
                                                                   throws java.lang.Exception

filter the result by classType and asOfDate

Parameters:

rowId - The row ID

realClass - The real class.

asOfDate - The archive date

hint - the hint

exclude - the list of transactions to exclude

doNotUseCurrentData - will the archive use the current data ?

Returns:

The layer data

Throws:

java.lang.Exception - A serious problem

getTranGroupId

@CheckReturnValue
public long getTranGroupId()

The transaction group

Returns:

0 if null

stats

public void stats(CollectorDBClass collector)

Parameters:

collector - the collector

dataKnownToExistAt

@CheckReturnValue
public boolean dataKnownToExistAt(@Nonnull
                                                    DBData data)
                                             throws java.sql.SQLException

is it know that this record existed at the time of this transaction.

Parameters:

data - the data to check

Returns:

true if know to exist

Throws:

java.sql.SQLException - a serious problem

checkInMemory

public void checkInMemory()
                   throws java.lang.Exception

Checks that all the records modified in this transaction are if in cache at least up to this transaction number.

Throws:

java.lang.Exception - A serious problem

getClauseCache

@CheckReturnValue
 @Nonnull
public PossibleRowsHolder[] getClauseCache(@Nonnull
                                                                       DBClass dbClass,
                                                                       @Nullable
                                                                       DBPathClause clause)

Check the cache for this clause.

Parameters:

clause - the clause

dbClass - the class

Returns:

The row list from cache

findKey

@CheckReturnValue
 @Nonnull
public DBObject findKey(@Nonnull
                                                    GlobalKey gKey,
                                                    @Nonnull
                                                    ArchiveDataSource ads)
                                             throws NotFoundException

Finds a new DBObject by its primary key INTERNAL ONLY

Parameters:

ads - The archive data source to used.

gKey - The key to find

Returns:

The found object

Throws:

NotFoundException - The key was not found

getReason

@CheckReturnValue
 @Nonnull
public java.lang.String getReason()

The reason for this transaction.

Returns:

The reason.

getpersonGlobalID

@CheckReturnValue
 @Nonnull
public java.lang.String getpersonGlobalID()

The personGlobalID for this transaction.

Returns:

The personGlobalID.

findTransGroup

@CheckReturnValue
 @Nonnull
public TransGroup findTransGroup()
                                                      throws NotFoundException

return the transaction group.

Returns:

The transaction group.

Throws:

NotFoundException - The transaction group was not found.

getActions

@CheckReturnValue
 @Nonnull
public java.lang.String getActions()
                                                        throws java.lang.Exception

Returns:

the action

Throws:

java.lang.Exception - a serious problem

reverse

public long reverse(Login login)
             throws java.lang.Exception

Parameters:

login - the login

Returns:

reverse transaction id

Throws:

java.lang.Exception - a serious problem

reverse

public long reverse(Login login,
                    boolean replayMode,
                    boolean eraseMode)
             throws java.lang.Exception

Parameters:

login - the login

replayMode - Reverse only if safe to do so.

eraseMode - we are going to erase the transaction

Returns:

reverse transaction id

Throws:

java.lang.Exception - a serious problem

writeThreadEraseLog

public static void writeThreadEraseLog(java.lang.String msg)

write to the current log

Parameters:

msg - message to log

reverse

public void reverse(MutableDataSource mds,
                    boolean replayMode)
             throws java.lang.Exception

Parameters:

mds - the mutable data source

replayMode - Reverse only if safe to do so.

Throws:

java.lang.Exception - a serious problem

restore

@CheckReturnValue
 @Nullable
public DBObject restore()

Returns:

the restore

fetchRecordList

@CheckReturnValue
 @Nullable
public TransRecord[] fetchRecordList()

fetch the record list from cache.

Returns:

the record list

getRecordList

@CheckReturnValue
 @Nonnull
public TransRecord[] getRecordList()
                                                        throws java.lang.Exception

Returns:

the list of transaction record

Throws:

java.lang.Exception - a serious problem

listTransaction

@CheckReturnValue
 @Nonnull
public static TransHeader[] listTransaction(@Nullable
                                                                        DBObject obj)
                                                                 throws java.lang.Exception

List of all the transactions for this Object

Parameters:

obj - the object

Returns:

the list of transactions

Throws:

java.lang.Exception - a serious problem

maxTransaction

@CheckReturnValue
 @Nonnull
public static TransHeader maxTransaction(@Nonnull
                                                                     VirtualDB layer,
                                                                     @Nonnull
                                                                     DBClass dbClass,
                                                                     long rowUid)
                                                              throws java.lang.Exception

Parameters:

dbClass - the class

rowUid - the row

layer - the layer

Returns:

the list of transaction headers

Throws:

java.lang.Exception - a serious problem

listTransaction

@CheckReturnValue
 @Nonnull
public static TransHeader[] listTransaction(DBClass dbClass,
                                                                        long rowUid,
                                                                        long mustFindTransId)
                                                                 throws java.lang.Exception

Parameters:

dbClass - the class

rowUid - the row

mustFindTransId - the transaction we must find

Returns:

the list of transaction headers

Throws:

java.lang.Exception - a serious problem

sortHeaders

public static void sortHeaders(@Nonnull
                               TransHeader[] list)

Parameters:

list - the list

listTransaction

@CheckReturnValue
 @Nonnull
public static TransHeader[] listTransaction(@Nullable
                                                                        DBObject obj,
                                                                        @Nullable
                                                                        java.util.Date fromDate,
                                                                        @Nullable
                                                                        java.util.Date toDate)
                                                                 throws java.lang.Exception

List of all the transactions for this Object between fromDate and toDate

Parameters:

obj - The DBObject to list the records for.

fromDate - From what timestamp ( maybe null)

toDate - To what timestamp ( maybe null)

Returns:

The list of transactions

Throws:

java.lang.Exception - A serious problem

listTransaction

@CheckReturnValue
 @Nonnull
public static TransHeader[] listTransaction(@Nonnull
                                                                        DBClass cls,
                                                                        long rowUID,
                                                                        @Nullable
                                                                        java.util.Date fromDate,
                                                                        @Nullable
                                                                        java.util.Date toDate)
                                                                 throws java.lang.Exception

List of all the transactions for this Object between fromDate and toDate

Parameters:

cls - the class

rowUID - the row

fromDate - From what timestamp ( maybe null)

toDate - To what timestamp ( maybe null)

Returns:

The list of transactions

Throws:

java.lang.Exception - A serious problem

listTransaction

@CheckReturnValue
 @Nonnull
public static TransHeader[] listTransaction(VirtualDB layer,
                                                                        java.util.Date fromDate,
                                                                        java.util.Date toDate)
                                                                 throws java.lang.Exception

List of all the transactions for this Object between fromDate and toDate

Parameters:

layer - the layer to search

fromDate - From what timestamp ( maybe null)

toDate - To what timestamp ( maybe null)

Returns:

The list of transactions

Throws:

java.lang.Exception - A serious problem

listTransaction

@CheckReturnValue
 @Nonnull
public static TransHeader[] listTransaction(Path path,
                                                                        long rowUID,
                                                                        java.util.Date fromDate,
                                                                        java.util.Date toDate,
                                                                        boolean listAll)
                                                                 throws java.lang.Exception

List of all the transactions for this Object between fromDate and toDate

Parameters:

path - the path

rowUID - the row

fromDate - From what timestamp ( maybe null)

toDate - To what timestamp ( maybe null)

listAll - To list all the transactions from this path if the inward link field is Derived or Formula

Returns:

The list of transactions

Throws:

java.lang.Exception - A serious problem

latestTransactionInLayers

@CheckReturnValue
 @Nullable
public static TransHeader latestTransactionInLayers(@Nullable
                                                                                 DBObject obj)
                                                                          throws java.lang.Exception

Gets Latest Transaction from family of layers

Parameters:

obj - the object

Returns:

the transaction header

Throws:

java.lang.Exception - Exception A serious problem

latestTransaction

@CheckReturnValue
 @Nullable
public static TransHeader latestTransaction(@Nonnull
                                                                         DBObject obj)
                                                                  throws java.lang.Exception

Parameters:

obj - the object

Returns:

the header

Throws:

java.lang.Exception - a serious problem

latestTransaction

@CheckReturnValue
 @Nullable
public static TransHeader latestTransaction(@Nullable
                                                                         DBObject obj,
                                                                         @Nonnull
                                                                         VirtualDB vDB)
                                                                  throws java.lang.Exception

Gets latest Transaction for this object in specified datasource

Parameters:

obj - the object

vDB - the layer

Returns:

Latest TransHeader from the virtual db (can return null transaction header, if not found)

Throws:

java.lang.Exception - if the Transaction Id is not found

getTranscationDate

@CheckReturnValue
 @Nullable
public static java.util.Date getTranscationDate(DBObject obj,
                                                                             DBField fld,
                                                                             java.lang.Object value,
                                                                             java.util.Date fromDate,
                                                                             java.util.Date toDate)
                                                                      throws java.lang.Exception

Returns the transaction date of the object when field is updated to value between fromDate and toDate If field is updated to value more than once between fromDate and toDate, the latest transaction date will be returned.

Parameters:

obj - the object

fld - the field

value - the value

fromDate - form date

toDate - to date

Returns:

the date

Throws:

java.lang.Exception - a serious problem

getDatabase

@CheckReturnValue
 @Nonnull
public VirtualDB getDatabase()

Returns:

the layer

getRow

@CheckReturnValue
 @Nullable
public TransRecord getRow(long row_uid)

Parameters:

row_uid - the row

Returns:

the transaction record

getTransId

@CheckReturnValue
public long getTransId()

returns the transaction id for this transaction header.

Returns:

The transaction id

getTransDate

@CheckReturnValue
 @Nonnull
public java.util.Date getTransDate()

Returns:

the date

getPerson

@CheckReturnValue
 @Nullable
public Person getPerson()

Returns:

the person

adjustReason

public void adjustReason(@Nonnull
                         java.lang.String reason)
                  throws java.lang.Exception

Throws:

java.lang.Exception

disableTranIdAsserts

public static void disableTranIdAsserts()

Disable the assert checks for transaction ids.

assertTransIdValid

@CheckReturnValue
public static boolean assertTransIdValid(long transId)

check if the transaction is valid

Parameters:

transId - the transaction id

Returns:

true if valid.

toString

@CheckReturnValue
 @Nonnull
public java.lang.String toString()

to string

Overrides:

toString in class java.lang.Object

Returns:

the string

getKey

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

Returns:

the key