com.aspc.DBObj.Archive

Class ArchiveDataSource

java.lang.Object

com.aspc.DBObj.Archive.ArchiveDataSource

All Implemented Interfaces:

DataSource

public final class ArchiveDataSource
extends java.lang.Object
implements DataSource

ArchiveDataSource returns data as it was in history.
THREAD MODE: SINGLE-THREADED

Since:

February 14, 2001, 4:36 PM

Author:

JNigel Leck

Constructor Summary

Constructors

Constructor and Description
ArchiveDataSource(DataSource ds, java.util.Date asOfDate) create a archive data source
ArchiveDataSource(DataSource ds, java.util.Date asOfDate, boolean forceUseOfJournalData, boolean doNotUseCurrentData, TransHeader beforeTransaction) create a archive data source
ArchiveDataSource(Login login, java.util.Date asOfDate) create a archive data source
ArchiveDataSource(Login login, java.util.Date asOfDate, boolean forceUseOfJournalData, boolean doNotUseCurrentData, TransHeader beforeTransaction) create a archive data source
ArchiveDataSource(Session session, java.util.Date asOfDate) create a archive data source
ArchiveDataSource(Session session, java.util.Date asOfDate, boolean forceUseOfJournalData, boolean doNotUseCurrentData, TransHeader beforeTransaction) create a archive data source

Method Summary

Modifier and Type	Method and Description
DBObject	archivedVersion(DBData data, DBClass def, Hint hint)
DBObject	create(DBClass dbClass) Creates a new DBObject of a particular type
DBObject	create(GlobalId classGid) Creates a new DBObject of a particular type
DBObject	create(java.lang.String className) Create a new Object of type passed.
void	exclude(TransHeader th) exclude this transaction
TransHeader[]	excludedTransactions() the excluded transactions
DBClass	findDBClass(GlobalId classId) Find the object definition
DBClass	findDBClass(java.lang.String className) Finds the Definition of a Object NOT Archive date sensitive.
DBClassAbstract	findDBClassAbstract(GlobalId classId) Find the object definition
DBClassAbstract	findDBClassAbstract(java.lang.String className) Finds the Definition of a Object NOT Archive date sensitive.
DBObject	findKey(GlobalId valueId, GlobalId classId) Find an object by it's key
DBObject	findKey(GlobalId id, java.lang.String className) Finds a new DBObject by its primary integer key
DBObject	findKey(GlobalKey gKey) Finds a new DBObject by its primary key
DBObject	findKey(java.lang.String value, java.lang.String defName) Finds a unique DBObject based on supplied key value
TransHeader	findMaxTransHeader(VirtualDB layer) find the maximum transaction for this archive date.
DBObject	findRow(long rowId, DBClassConcrete def, Hint hint) Finds a DBObject by it's rowId with a hint of what's next
GlobalKey	findRowGlobalKey(long rowId, DBClass rawClass, Hint hint)
java.util.Date	getAsOfDate() What is the as of date for this Archive data source.
java.lang.Object	getAttribute(java.lang.String name) Gets a general purpose attribute
java.lang.Object	getCacheObject(java.lang.String key) Get an object from the data source's cache
DataSource	getCurrentDataSource() get the current data source, if from VurtualDB then the thread local version
VirtualDB	getDataBase() Get the base virtual DB
DataSource	getDataBaseReadOnly() Returns itself.
Globals	getGlobalObject() Get the globals object.
DBResult	getInwardLinkage(DBClass sourceClass, DBField sourceField, DBObject target, HintField hint) Get the cached DBResult set for the linkage passed
Login	getLogin() Get the current login
DBQueryHandler	getQueryHandler(DBClass searchClass) makes a Query handler for simple virtual db.
Login	getRealLogin() Get the current login
Session	getSession() Get the current session
java.util.TimeZone	getTimeZone() Get the timeZone used for date/time processing
Person	getUser() Returns the User for this MutableDataSource.
boolean	hasChild(DBClass mapClass, DBField parentField, DBObject parentObject, DBField childField, DBObject childObject) does this map table contain a mapping for the parent to child.
boolean	hasExcludedGroups() are any contacts excluded ?
boolean	isDoNotUseCurrentData() do not use the current data.
boolean	isExcludeFromGroup(ContactGroup group, Person person) is the contact excluded from the group.
boolean	isForceUseOfJournalData() Should we force the use of journal data even if the "ignore journal data" is checked for a class.
DALQuery	makeQuery(java.lang.String className)
long	nextNumber(java.lang.String key) The next number for this data source
long	nextNumber(java.lang.String key, int cacheSize) The next number for this data source Read Only return -1
void	setAttribute(java.lang.String name, java.lang.Object value) Sets general purpose attributes
void	setCacheObject(java.lang.String key, java.lang.Object obj) Set the data source's cache
void	setTimeZone(java.util.TimeZone tz)
java.lang.String	toString() to String

Methods inherited from class java.lang.Object

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

Constructor Detail

ArchiveDataSource

public ArchiveDataSource(@Nonnull
                         Login login,
                         @Nonnull
                         java.util.Date asOfDate)

create a archive data source

Parameters:

login - the login

asOfDate - the date to use

ArchiveDataSource

public ArchiveDataSource(@Nonnull
                         Session session,
                         @Nonnull
                         java.util.Date asOfDate)

create a archive data source

Parameters:

session - the session

asOfDate - the date to use

ArchiveDataSource

public ArchiveDataSource(@Nonnull
                         DataSource ds,
                         @Nonnull
                         java.util.Date asOfDate)

create a archive data source

Parameters:

ds - the data source

asOfDate - the date to use

ArchiveDataSource

public ArchiveDataSource(@Nonnull
                         Login login,
                         @Nonnull
                         java.util.Date asOfDate,
                         boolean forceUseOfJournalData,
                         boolean doNotUseCurrentData,
                         @Nullable
                         TransHeader beforeTransaction)

create a archive data source

Parameters:

login - the login

asOfDate - the date to use

forceUseOfJournalData - force the use of journal data even if the "ignore journal data" is checked for a class.

doNotUseCurrentData - do not use the current version of the data.

beforeTransaction - before this transaction

ArchiveDataSource

public ArchiveDataSource(@Nonnull
                         Session session,
                         @Nonnull
                         java.util.Date asOfDate,
                         boolean forceUseOfJournalData,
                         boolean doNotUseCurrentData,
                         @Nullable
                         TransHeader beforeTransaction)

create a archive data source

Parameters:

session - the session

asOfDate - the date to use

forceUseOfJournalData - force the use of journal data even if the "ignore journal data" is checked for a class.

doNotUseCurrentData - do not use the current version of the data.

beforeTransaction - before this transaction

ArchiveDataSource

public ArchiveDataSource(@Nonnull
                         DataSource ds,
                         @Nonnull
                         java.util.Date asOfDate,
                         boolean forceUseOfJournalData,
                         boolean doNotUseCurrentData,
                         @Nullable
                         TransHeader beforeTransaction)

create a archive data source

Parameters:

ds - the data source

asOfDate - the date to use

forceUseOfJournalData - force the use of journal data even if the "ignore journal data" is checked for a class.

doNotUseCurrentData - do not use the current version of the data.

beforeTransaction - before this transaction

Method Detail

toString

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

to String

Overrides:

toString in class java.lang.Object

Returns:

the description

excludedTransactions

@CheckReturnValue
 @Nonnull
public TransHeader[] excludedTransactions()

the excluded transactions

Returns:

the list

exclude

public void exclude(@Nonnull
                    TransHeader th)

exclude this transaction

Parameters:

th - the transaction.

isForceUseOfJournalData

@CheckReturnValue
public boolean isForceUseOfJournalData()

Should we force the use of journal data even if the "ignore journal data" is checked for a class.

Returns:

true if we should always use the journal data.

isDoNotUseCurrentData

@CheckReturnValue
public boolean isDoNotUseCurrentData()

do not use the current data. This maybe used if the current data is corrupt.

Returns:

true if we should not use.

isExcludeFromGroup

@CheckReturnValue
public boolean isExcludeFromGroup(@Nonnull
                                                    ContactGroup group,
                                                    @Nonnull
                                                    Person person)

is the contact excluded from the group.

Specified by:

isExcludeFromGroup in interface DataSource

Parameters:

person - the person to check.

group - the group to check if the contact is excluded.

Returns:

true if excluded.

hasExcludedGroups

@CheckReturnValue
public boolean hasExcludedGroups()

are any contacts excluded ?

Specified by:

hasExcludedGroups in interface DataSource

Returns:

true if any contacts are excluded.

hasChild

@CheckReturnValue
public boolean hasChild(@Nonnull
                                          DBClass mapClass,
                                          @Nonnull
                                          DBField parentField,
                                          @Nonnull
                                          DBObject parentObject,
                                          @Nonnull
                                          DBField childField,
                                          @Nonnull
                                          DBObject childObject)
                                   throws java.lang.Exception

does this map table contain a mapping for the parent to child.

Specified by:

hasChild in interface DataSource

Parameters:

mapClass - The map class

parentField - the parent link

parentObject - the parent object

childField - the child link

childObject - the child object

Returns:

TRUE if a mapping found

Throws:

java.lang.Exception - Exception A serious problem

getCurrentDataSource

@CheckReturnValue
 @Nonnull
public DataSource getCurrentDataSource()

get the current data source, if from VurtualDB then the thread local version

Specified by:

getCurrentDataSource in interface DataSource

Returns:

the current data source

getSession

@CheckReturnValue
 @Nullable
public Session getSession()

Get the current session

Specified by:

getSession in interface DataSource

Returns:

the session

nextNumber

@CheckReturnValue
public long nextNumber(@Nonnull
                                         java.lang.String key,
                                         int cacheSize)

The next number for this data source Read Only return -1

Specified by:

nextNumber in interface DataSource

Parameters:

key - The item

cacheSize - The number of numbers to reserve

Returns:

The next number

getLogin

@CheckReturnValue
 @Nonnull
public Login getLogin()

Get the current login

Specified by:

getLogin in interface DataSource

Returns:

The login

getRealLogin

@Nonnull
public Login getRealLogin()

Get the current login

Specified by:

getRealLogin in interface DataSource

Returns:

The login

getUser

@CheckReturnValue
 @Nullable
public Person getUser()

Returns the User for this MutableDataSource.

Specified by:

getUser in interface DataSource

Returns:

The user.

getTimeZone

@CheckReturnValue
 @Nonnull
public java.util.TimeZone getTimeZone()

Get the timeZone used for date/time processing

Specified by:

getTimeZone in interface DataSource

Returns:

The timeZone

setTimeZone

public void setTimeZone(@Nonnull
                        java.util.TimeZone tz)

Parameters:

tz - the time zone

getInwardLinkage

@CheckReturnValue
 @Nonnull
public DBResult getInwardLinkage(@Nonnull
                                                             DBClass sourceClass,
                                                             @Nonnull
                                                             DBField sourceField,
                                                             @Nullable
                                                             DBObject target,
                                                             @Nullable
                                                             HintField hint)
                                                      throws java.lang.Exception

Get the cached DBResult set for the linkage passed

Specified by:

getInwardLinkage in interface DataSource

Parameters:

sourceClass - the source class

sourceField - The source field

hint - the hint

target - The object that the field points to

Returns:

The found record set

Throws:

java.lang.Exception - a serious problem.

findKey

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

Finds a new DBObject by its primary key

Specified by:

findKey in interface DataSource

Parameters:

gKey - The key to find

Returns:

The found object

Throws:

NotFoundException - The key was not found

findMaxTransHeader

@CheckReturnValue
 @Nonnull
public TransHeader findMaxTransHeader(@Nonnull
                                                                  VirtualDB layer)
                                                           throws java.lang.Exception

find the maximum transaction for this archive date.

Parameters:

layer - the layer

Returns:

the transaction header

Throws:

java.lang.Exception - a serious problem

getAsOfDate

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

What is the as of date for this Archive data source.

Returns:

the date

findRow

@CheckReturnValue
 @Nonnull
public DBObject findRow(long rowId,
                                                    @Nonnull
                                                    DBClassConcrete def,
                                                    @Nullable
                                                    Hint hint)
                                             throws NotFoundException

Finds a DBObject by it's rowId with a hint of what's next

Specified by:

findRow in interface DataSource

Parameters:

def - the class to find

hint - a hint for the other rows to load.

rowId - The row id to found

Returns:

The found object

Throws:

NotFoundException - The row not found

findRowGlobalKey

@CheckReturnValue
 @Nonnull
public GlobalKey findRowGlobalKey(long rowId,
                                                              @Nonnull
                                                              DBClass rawClass,
                                                              @Nullable
                                                              Hint hint)
                                                       throws NotFoundException

Parameters:

rowId - the row

rawClass - the class

hint - the hint

Returns:

the global key

Throws:

NotFoundException - not found

archivedVersion

@CheckReturnValue
 @Nonnull
public DBObject archivedVersion(DBData data,
                                                            DBClass def,
                                                            Hint hint)
                                                     throws NotFoundException

Parameters:

def - the class

hint - the hint

data - the data

Returns:

the DBObject

Throws:

NotFoundException - not found

findKey

@CheckReturnValue
 @Nonnull
public DBObject findKey(GlobalId id,
                                                    java.lang.String className)
                                             throws NotFoundException

Finds a new DBObject by its primary integer key

Specified by:

findKey in interface DataSource

Parameters:

className - the class name

id - The value id

Returns:

The found object

Throws:

NotFoundException - The key was not found

create

@CheckReturnValue
 @Nonnull
public DBObject create(@Nonnull
                                                   DBClass dbClass)
                                            throws java.lang.Exception

Creates a new DBObject of a particular type

Specified by:

create in interface DataSource

Parameters:

dbClass - The class to create

Returns:

The created object

Throws:

java.lang.Exception - A serious problem

create

@CheckReturnValue
 @Nonnull
public DBObject create(java.lang.String className)
                                            throws java.lang.Exception

Create a new Object of type passed.

Specified by:

create in interface DataSource

Parameters:

className - The name of the class to create

Returns:

The new object

Throws:

java.lang.Exception - A serious problem

findDBClass

@CheckReturnValue
 @Nonnull
public DBClass findDBClass(GlobalId classId)
                                                throws NotFoundException

Find the object definition

Specified by:

findDBClass in interface DataSource

Parameters:

classId - The class to be found

Returns:

The class

Throws:

NotFoundException - Could not find the class

findDBClass

@CheckReturnValue
 @Nonnull
public DBClass findDBClass(java.lang.String className)
                                                throws NotFoundException

Finds the Definition of a Object

NOT Archive date sensitive.

Specified by:

findDBClass in interface DataSource

Parameters:

className - The name of the class

Returns:

The DBClass

Throws:

NotFoundException - The class was not found.

findDBClassAbstract

@CheckReturnValue
 @Nonnull
public DBClassAbstract findDBClassAbstract(GlobalId classId)
                                                                throws NotFoundException

Find the object definition

Specified by:

findDBClassAbstract in interface DataSource

Parameters:

classId - The class to be found

Returns:

The class

Throws:

NotFoundException - Could not find the class

findDBClassAbstract

@CheckReturnValue
 @Nonnull
public DBClassAbstract findDBClassAbstract(java.lang.String className)
                                                                throws NotFoundException

Finds the Definition of a Object

NOT Archive date sensitive.

Specified by:

findDBClassAbstract in interface DataSource

Parameters:

className - The name of the class

Returns:

The DBClass

Throws:

NotFoundException - The class was not found.

getGlobalObject

@CheckReturnValue
 @Nonnull
public Globals getGlobalObject()
                                                    throws java.lang.Exception

Get the globals object.

Specified by:

getGlobalObject in interface DataSource

Returns:

The global object

Throws:

java.lang.Exception - A serious problem

findKey

@CheckReturnValue
 @Nonnull
public DBObject findKey(GlobalId valueId,
                                                    GlobalId classId)
                                             throws NotFoundException

Find an object by it's key

Specified by:

findKey in interface DataSource

Parameters:

valueId - The value of the key

classId - The class id of the key

Returns:

The found dbObject

Throws:

NotFoundException - The key was not found

findKey

@CheckReturnValue
 @Nonnull
public DBObject findKey(java.lang.String value,
                                                    java.lang.String defName)
                                             throws NotFoundException,
                                                    TooManyRowsException,
                                                    java.lang.Exception

Finds a unique DBObject based on supplied key value

Specified by:

findKey in interface DataSource

Parameters:

value - the value

defName - The class name

Returns:

The found object

Throws:

java.lang.Exception - a serious problem

NotFoundException - The key was not found

TooManyRowsException - The key was not found

create

@CheckReturnValue
 @Nonnull
public DBObject create(GlobalId classGid)
                                            throws java.lang.Exception

Creates a new DBObject of a particular type

Specified by:

create in interface DataSource

Parameters:

classGid - The class to be created

Returns:

The created object

Throws:

java.lang.Exception - A serious problem

nextNumber

@CheckReturnValue
public long nextNumber(@Nonnull
                                         java.lang.String key)

The next number for this data source

Specified by:

nextNumber in interface DataSource

Parameters:

key - The item key

Returns:

The next number

getDataBase

@CheckReturnValue
 @Nonnull
public VirtualDB getDataBase()

Get the base virtual DB

Specified by:

getDataBase in interface DataSource

Returns:

The base virtual DB

getDataBaseReadOnly

@CheckReturnValue
 @Nonnull
public DataSource getDataBaseReadOnly()

Returns itself.

Specified by:

getDataBaseReadOnly in interface DataSource

Returns:

ArchiveDataSource.

getQueryHandler

@CheckReturnValue
 @Nonnull
public DBQueryHandler getQueryHandler(DBClass searchClass)

makes a Query handler for simple virtual db.

Specified by:

getQueryHandler in interface DataSource

Parameters:

searchClass - the class to search

Returns:

the query handler.

setCacheObject

public void setCacheObject(@Nonnull
                           java.lang.String key,
                           @Nullable
                           java.lang.Object obj)

Description copied from interface: DataSource

Set the data source's cache

Specified by:

setCacheObject in interface DataSource

Parameters:

key - the key

obj - the object

getCacheObject

@CheckReturnValue
 @Nullable
public java.lang.Object getCacheObject(@Nonnull
                                                                    java.lang.String key)

Description copied from interface: DataSource

Get an object from the data source's cache

Specified by:

getCacheObject in interface DataSource

Parameters:

key - the key

Returns:

the object

setAttribute

public void setAttribute(@Nonnull
                         java.lang.String name,
                         @Nonnull
                         java.lang.Object value)

Sets general purpose attributes

Parameters:

name - the name

value - the value

getAttribute

@CheckReturnValue
 @Nullable
public java.lang.Object getAttribute(@Nonnull
                                                                  java.lang.String name)

Gets a general purpose attribute

Specified by:

getAttribute in interface DataSource

Parameters:

name - the name

Returns:

the attribute

makeQuery

public DALQuery makeQuery(java.lang.String className)