com.aspc.DBObj

Interface DataSource

All Known Implementing Classes:

ArchiveDataSource, CacheLoadDataSource, ForkJoinDataSource, MutableDataSource, ReadOnlyDataSource, SanityCheckDataSource, SudoDataSource, VirtualDB

public interface DataSource

DBSource is the primary DB data controller which handles transactions and access control.

THREAD MODE: MULTI-THREADED

Since:

January 23, 2001, 2:20 PM

Author:

Nigel Leck

Method Summary

Modifier and Type	Method and Description
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.
DBClass	findDBClass(GlobalId classId) Find the object definition
DBClass	findDBClass(java.lang.String className) Finds the Definition of a Object.
DBClassAbstract	findDBClassAbstract(GlobalId classId) Find the object definition
DBClassAbstract	findDBClassAbstract(java.lang.String className) Finds the Definition of a Object.
DBObject	findKey(GlobalId valueId, GlobalId classId) Find an object by it's key
DBObject	findKey(GlobalId id, java.lang.String defName) 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
DBObject	findRow(long rowId, DBClassConcrete def, Hint hint) Finds a DBObject by it's rowId with a hint of what's next
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() Get the base virtual DB, if the data source is ReadOnlyDataSource.
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 "real" login
Session	getSession() Get the current session
java.util.TimeZone	getTimeZone() Get the timeZone used for date/time processing.
Person	getUser() Get the current user
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	isExcludeFromGroup(ContactGroup group, Person person) is the contact excluded from the group.
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
void	setCacheObject(java.lang.String key, java.lang.Object obj) Set the data source's cache

Method Detail

nextNumber

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

The next number for this data source

Parameters:

key - The item key

Returns:

The next number

nextNumber

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

The next number for this data source

Parameters:

key - The item

cacheSize - The number of numbers to reserve

Returns:

The next number

findDBClass

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

Finds the Definition of a Object.

Parameters:

className - The name of the class

Returns:

The DBClass

Throws:

NotFoundException - The class was not found.

findDBClassAbstract

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

Finds the Definition of a Object.

Parameters:

className - The name of the class

Returns:

The DBClass

Throws:

NotFoundException - The class was not found.

findDBClass

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

Find the object definition

Parameters:

classId - The class to be found

Returns:

The class

Throws:

NotFoundException - Could not find the class

findDBClassAbstract

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

Find the object definition

Parameters:

classId - The class to be found

Returns:

The class

Throws:

NotFoundException - Could not find the class

getSession

@CheckReturnValue
 @Nullable
Session getSession()

Get the current session

Returns:

the session for this data source

create

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

Create a new Object of type passed.

Parameters:

className - The name of the class to create

Returns:

The new object

Throws:

java.lang.Exception - A serious problem

getGlobalObject

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

Get the globals object

Returns:

The global object

Throws:

java.lang.Exception - A serious problem

create

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

Creates a new DBObject of a particular type

Parameters:

dbClass - The class to create

Returns:

The created object

Throws:

java.lang.Exception - A serious problem

create

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

Creates a new DBObject of a particular type

Parameters:

classGid - The class to be created

Returns:

The created object

Throws:

java.lang.Exception - A serious problem

findKey

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

Find an object by it's key

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
DBObject findKey(@Nonnull
                                             GlobalId id,
                                             @Nonnull
                                             java.lang.String defName)
                                      throws NotFoundException

Finds a new DBObject by its primary integer key

Parameters:

id - The value id

defName - The class name

Returns:

The found object

Throws:

NotFoundException - The key was not found

findKey

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

Finds a new DBObject by its primary key

Parameters:

gKey - The key to find

Returns:

The found object

Throws:

NotFoundException - The key was not found

findKey

@CheckReturnValue
 @Nonnull
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

Parameters:

value - the value to find

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

Parameters:

hint - A hint to the other rows that will be required.

rowId - The row id to found

def - The class to find

Returns:

The found object

Throws:

NotFoundException - The row not found

getInwardLinkage

@CheckReturnValue
 @Nonnull
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

Parameters:

sourceClass - The class to search on ( Nonnull)

sourceField - The source field ( Nonnull)

target - The object that the field points to (Nullable)

hint - the other objects that will be searched ( Nullable)

Returns:

The found record set

Throws:

java.lang.Exception - A serious problem

getDataBase

@CheckReturnValue
 @Nonnull
VirtualDB getDataBase()

Get the base virtual DB.

Returns:

The base virtual DB

getDataBaseReadOnly

@CheckReturnValue
 @Nonnull
DataSource getDataBaseReadOnly()

Get the base virtual DB, if the data source is ReadOnlyDataSource. Otherwise, return itself.

Returns:

The base virtual DB

getCurrentDataSource

@CheckReturnValue
 @Nonnull
DataSource getCurrentDataSource()

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

Returns:

the current data source

getLogin

@CheckReturnValue
 @Nonnull
Login getLogin()

Get the current login

Returns:

The login

getRealLogin

@CheckReturnValue
 @Nonnull
Login getRealLogin()

Get the current "real" login

Returns:

The login

getUser

@CheckReturnValue
 @Nullable
Person getUser()

Get the current user

Returns:

The user

getTimeZone

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

Get the timeZone used for date/time processing.

Returns:

The timeZone

getCacheObject

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

Get an object from the data source's cache

Parameters:

key - The cache key

Returns:

The cache object, null if not present

setCacheObject

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

Set the data source's cache

Parameters:

key - The cache key

obj - The object to cache

getAttribute

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

Gets a general purpose attribute. This method should only be implemented on single threaded data sources.

Parameters:

name - The attribute's name

Returns:

The value.

getQueryHandler

@CheckReturnValue
DBQueryHandler getQueryHandler(@Nonnull
                                                 DBClass searchClass)

makes a Query handler for simple virtual db.

Parameters:

searchClass - The class to search

Returns:

the query handler.

hasChild

@CheckReturnValue
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.

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

isExcludeFromGroup

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

is the contact excluded from the group.

Parameters:

person - the person to check.

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

Returns:

true if excluded.

hasExcludedGroups

@CheckReturnValue
boolean hasExcludedGroups()

are any contacts excluded ?

Returns:

true if any contacts are excluded.