com.aspc.DBObj

Class ReadOnlyDataSource

java.lang.Object

com.aspc.DBObj.ReadOnlyDataSource

All Implemented Interfaces:

DataSource

Direct Known Subclasses:

CacheLoadDataSource

public class ReadOnlyDataSource
extends java.lang.Object
implements DataSource

THREAD MODE: MULTI-THREADED

Since:

8 March, 2003

Author:

Nigel Leck

Field Summary

Fields

Modifier and Type	Field and Description
protected DataSource	rootDS the calling/root datasource

Constructor Summary

Constructors

Constructor and Description
ReadOnlyDataSource(DataSource ds) Creates a read only data source from another data source
ReadOnlyDataSource(Login login) A valid login is required to create a ReadOnlyDataSource All database requests will be limited by the ACLs associated with Login's access group.
ReadOnlyDataSource(Session session) Create a read only data source for a session

Method Summary

Modifier and Type	Method and Description
void	clear() Don't null anything out as this is a multi threaded class.
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) Creates a new DBObject of a particular type
void	dispose() dispose of this ReadOnlyDataSource clear to tables and make sure we can't use this MutableDataSource after calling this method
DBClass	findDBClass(GlobalId classId) Find a DBClass by it's global id.
DBClass	findDBClass(java.lang.String className) Finds the DBClass by name
DBClassAbstract	findDBClassAbstract(GlobalId classId) Find a DBClass by it's global id.
DBClassAbstract	findDBClassAbstract(java.lang.String className) Finds the DBClass by name
DBObject	findKey(GlobalId valueId, GlobalId classId) Find a DBObject via it's value global ID and class global ID
DBObject	findKey(GlobalId id, java.lang.String defName) Finds a new DBObject by its value id and the class name
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
DBObject	findRow(long rowId, DBClassConcrete def, Hint hint) Finds a DBObject by it's rowId
java.lang.Object	getAttribute(java.lang.String name) Gets a general purpose attribute
java.lang.Object	getCacheObject(java.lang.String key) Get an object out of cache WARNING: This is a MULTI-THREAD datasource and is pooled for performance reasons
DataSource	getCurrentDataSource() get the current datasource, if from VurtualDB then the thread local version
VirtualDB	getDataBase() Returns the VirtualDB for this MutableDataSource.
DataSource	getDataBaseReadOnly() Returns the VirtualDB for this MutableDataSource.
Globals	getGlobalObject() Get the globals object
DBResult	getInwardLinkage(DBClass sourceClass, DBField sourceField, DBObject target, HintField hint) If this is an incoming link and the base object is new then don't check the database for records as there will not/should not be any records.
Login	getLogin() Returns the Login for this MutableDataSource.
DBQueryHandler	getQueryHandler(DBClass searchClass) Makes a Query handler for simple virtual db.
Login	getRealLogin() Returns the "real" Login for this read only data source.
Session	getSession() Get the current session
java.util.TimeZone	getTimeZone() Returns the login which created this MutableDataSource's current timeZone.
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	isDisposed() is this datasource disposed of ?
boolean	isExcludeFromGroup(ContactGroup group, Person person) is the contact excluded from the group.
DALQuery	makeQuery(java.lang.String className)
long	nextNumber(java.lang.String key) Returns the next number for the passed key.
long	nextNumber(java.lang.String key, int cacheSize) Returns the next number for the passed key.
void	resetReadChecks() resets the time stamp used for read access checking.
void	setCacheObject(java.lang.String key, java.lang.Object obj) a cache of the objects
ReadOnlyDataSource	setTimeZone(java.util.TimeZone tz) Sets the time zone for this datasource
java.lang.String	toString() Display the details of this datasource

Methods inherited from class java.lang.Object

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

Field Detail

rootDS

protected DataSource rootDS

the calling/root datasource

Constructor Detail

ReadOnlyDataSource

public ReadOnlyDataSource(@Nonnull
                          Login login)

A valid login is required to create a ReadOnlyDataSource All database requests will be limited by the ACLs associated with Login's access group.

Parameters:

login - The user's login.

ReadOnlyDataSource

public ReadOnlyDataSource(@Nonnull
                          Session session)

Create a read only data source for a session

Parameters:

session - The session to use

ReadOnlyDataSource

public ReadOnlyDataSource(@Nonnull
                          DataSource ds)

Creates a read only data source from another data source

Parameters:

ds - The data source to use

Method Detail

hasChild

@CheckReturnValue
public boolean hasChild(DBClass mapClass,
                                          DBField parentField,
                                          DBObject parentObject,
                                          DBField childField,
                                          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 - a serious problem

isDisposed

@CheckReturnValue
public boolean isDisposed()

is this datasource disposed of ?

Returns:

true if disposed.

dispose

public void dispose()

dispose of this ReadOnlyDataSource clear to tables and make sure we can't use this MutableDataSource after calling this method

getSession

@CheckReturnValue
 @Nullable
public Session getSession()

Get the current session

Specified by:

getSession in interface DataSource

Returns:

the session

isExcludeFromGroup

@CheckReturnValue
public boolean isExcludeFromGroup(ContactGroup group,
                                                    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.

getCurrentDataSource

@CheckReturnValue
 @Nonnull
public DataSource getCurrentDataSource()

get the current datasource, if from VurtualDB then the thread local version

Specified by:

getCurrentDataSource in interface DataSource

Returns:

the current data source

clear

public void clear()

Don't null anything out as this is a multi threaded class.

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

nextNumber

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

Returns the next number for the passed key.

A default cache size of ten will be used.

Specified by:

nextNumber in interface DataSource

Parameters:

key - The next number key

Returns:

The next number.

nextNumber

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

Returns the next number for the passed key.

When the MutableDataSource is in "no save" mode we can make pseudo unique numbers by reserving 0xf0000000 for memory generated next numbers.

Specified by:

nextNumber in interface DataSource

Parameters:

key - The next number key

cacheSize - The number of additional numbers to book.

Returns:

The next number

getInwardLinkage

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

If this is an incoming link and the base object is new then don't check the database for records as there will not/should not be any records. If there is then they are records in error or the base record will have a duplicate key error when you try to save it.

Specified by:

getInwardLinkage in interface DataSource

Parameters:

sourceClass - The source class

hint - the other objects that will be searched

sourceField - The field that points to the target's class

target - The actual DBObject that the source field pionts to.

Returns:

The record set.

Throws:

java.lang.Exception - A serious problem

getDataBase

@CheckReturnValue
 @Nonnull
public VirtualDB getDataBase()

Returns the VirtualDB for this MutableDataSource.

Specified by:

getDataBase in interface DataSource

Returns:

The VirtualDB.

getDataBaseReadOnly

@CheckReturnValue
 @Nonnull
public DataSource getDataBaseReadOnly()

Returns the VirtualDB for this MutableDataSource.

Specified by:

getDataBaseReadOnly in interface DataSource

Returns:

The VirtualDB.

getLogin

@CheckReturnValue
 @Nonnull
public Login getLogin()

Returns the Login for this MutableDataSource.

Specified by:

getLogin in interface DataSource

Returns:

The login.

getRealLogin

@CheckReturnValue
 @Nonnull
public Login getRealLogin()

Returns the "real" Login for this read only data source.

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()

Returns the login which created this MutableDataSource's current timeZone.

Specified by:

getTimeZone in interface DataSource

Returns:

The TimeZone

setTimeZone

@Nonnull
public final ReadOnlyDataSource setTimeZone(@Nonnull
                                                     java.util.TimeZone tz)

Sets the time zone for this datasource

Parameters:

tz - The timezone

Returns:

this

findDBClass

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

Finds the DBClass by name

Specified by:

findDBClass in interface DataSource

Parameters:

className - The class name to find.

Returns:

The DBClass

Throws:

NotFoundException - The class name doesn't exist

findDBClass

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

Find a DBClass by it's global id.

Specified by:

findDBClass in interface DataSource

Parameters:

classId - The class's global id.

Returns:

The DBClass

Throws:

NotFoundException - The class was not found.

findDBClassAbstract

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

Finds the DBClass by name

Specified by:

findDBClassAbstract in interface DataSource

Parameters:

className - The class name to find.

Returns:

The DBClass

Throws:

NotFoundException - The class name doesn't exist

findDBClassAbstract

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

Find a DBClass by it's global id.

Specified by:

findDBClassAbstract in interface DataSource

Parameters:

classId - The class's global id.

Returns:

The DBClass

Throws:

NotFoundException - The class was not found.

findKey

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

Find a DBObject via it's value global ID and class global ID

Specified by:

findKey in interface DataSource

Parameters:

valueId - The value id

classId - The class id

Returns:

the DBObject

Throws:

NotFoundException - The DBObject wasn't found

findKey

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

Finds a new DBObject by its value id and the class name

Specified by:

findKey in interface DataSource

Parameters:

id - The value id

defName - The class name

Returns:

The DBObject

Throws:

NotFoundException - The DBObject wasn't found

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 global key

Returns:

The DBObject

Throws:

NotFoundException - The DBObject wasn't found

findKey

@CheckReturnValue
 @Nonnull
public DBObject findKey(@Nonnull
                                                    java.lang.String value,
                                                    @Nonnull
                                                    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 to search

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

findRow

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

Finds a DBObject by it's rowId

Specified by:

findRow in interface DataSource

Parameters:

hint - The hint of other rows to be fetched

rowId - The row id

def - The DBClass

Returns:

The DBObject

Throws:

NotFoundException - The row wasn't found

toString

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

Display the details of this datasource

Overrides:

toString in class java.lang.Object

Returns:

the string.

create

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

Creates a new DBObject of a particular type

Specified by:

create in interface DataSource

Parameters:

className - The class Name

Returns:

The created DBObject

Throws:

java.lang.Exception - A serious problem occurred

create

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

Creates a new DBObject of a particular type

Specified by:

create in interface DataSource

Parameters:

dbClass - The class

Returns:

The created DBObject

Throws:

java.lang.Exception - A serious problem occurred

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 id

Returns:

The created DBObject

Throws:

java.lang.Exception - A serious problem occurred

resetReadChecks

public void resetReadChecks()

resets the time stamp used for read access checking.

getQueryHandler

@CheckReturnValue
 @Nonnull
public DBQueryHandler getQueryHandler(@Nonnull
                                                                  DBClass searchClass)

Makes a Query handler for simple virtual db. depending of Data Source type the optimal method of performing the database queries differs.

Specified by:

getQueryHandler in interface DataSource

Parameters:

searchClass - The class that is being searched

Returns:

the query handler.

setCacheObject

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

a cache of the objects

Specified by:

setCacheObject in interface DataSource

Parameters:

key - A key

obj - The value

getCacheObject

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

Get an object out of cache WARNING: This is a MULTI-THREAD datasource and is pooled for performance reasons

Specified by:

getCacheObject in interface DataSource

Parameters:

key - The key

Returns:

The cache 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 of the attribute

Returns:

the value

makeQuery

@CheckReturnValue
 @Nonnull
public DALQuery makeQuery(java.lang.String className)