com.aspc.DBObj

Class ForkJoinDataSource

java.lang.Object

com.aspc.DBObj.ForkJoinDataSource

All Implemented Interfaces:

DataSource, MemoryHandler

public class ForkJoinDataSource
extends java.lang.Object
implements DataSource, MemoryHandler

Split tasks up into blocking and non-blocking and cache the requests of queries for return later.
THREAD MODE: MULTI-THREADED

Since:

8 March, 2012

Author:

Nigel Leck

Nested Class Summary

Nested classes/interfaces inherited from interface com.aspc.remote.memory.MemoryHandler

MemoryHandler.Cost

Constructor Summary

Constructors

Constructor and Description
ForkJoinDataSource(DataSource ds) Creates a read only data source from another data source

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.
void	dispose() dispose of this ReadOnlyDataSource clear to tables and make sure we can't use this MutableDataSource after calling this method
PossibleRowsHolder	fetchPossibleRows(SearchPlan plan, DBQueryHandler qh)
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
long	freeMemory(double percentage) Free memory at this level and below.
java.lang.Object	getAttribute(java.lang.String name) MAY NOT set/get an attribute, this method will always return null.
java.lang.Object	getCacheObject(java.lang.String key) MAY NOT set/get cache object, this method will always return null.
MemoryHandler.Cost	getCost() The cost level for this MemoryHandler.
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.
long	getEstimatedSize() The estimated size of data held by this memory handler
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
long	getLastAccessed() The last time this memory handle was accessed
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
DataSource	getWrappedDS()
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.
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
long	panicFreeMemory() Clear all memory.
long	queuedFreeMemory(double percentage) This method should implement the freeing of the method and maybe synchronized.
void	setCacheObject(java.lang.String key, java.lang.Object obj) MAY NOT set/get cache object, this method will always return null.
long	tidyUp() Tidy up the memory handler

Methods inherited from class java.lang.Object

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

Constructor Detail

ForkJoinDataSource

public ForkJoinDataSource(@Nonnull
                          DataSource ds)

Creates a read only data source from another data source

Parameters:

ds - The data source to use

Method Detail

getWrappedDS

@CheckReturnValue
 @Nonnull
public DataSource getWrappedDS()

dispose

public void dispose()

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

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

nextNumber

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

The next number for this data source

Specified by:

nextNumber in interface DataSource

Parameters:

key - The item

cacheSize - The number of numbers to reserve

Returns:

The next number

findDBClass

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

Finds the Definition of a Object.

Specified by:

findDBClass in interface DataSource

Parameters:

className - The name of the class

Returns:

The DBClass

Throws:

NotFoundException

findDBClassAbstract

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

Finds the Definition of a Object.

Specified by:

findDBClassAbstract in interface DataSource

Parameters:

className - The name of the class

Returns:

The DBClass

Throws:

NotFoundException

findDBClass

@CheckReturnValue
 @Nonnull
public DBClass findDBClass(@Nonnull
                                                       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

findDBClassAbstract

@CheckReturnValue
 @Nonnull
public DBClassAbstract findDBClassAbstract(@Nonnull
                                                                       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

getSession

@CheckReturnValue
 @Nullable
public Session getSession()

Get the current session

Specified by:

getSession in interface DataSource

Returns:

the session for this data source

create

@Nonnull
public DBObject create(@Nonnull
                                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

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

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

create

@CheckReturnValue
 @Nonnull
public DBObject create(@Nonnull
                                                   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

fetchPossibleRows

@CheckReturnValue
 @Nonnull
public PossibleRowsHolder fetchPossibleRows(@Nonnull
                                                                        SearchPlan plan,
                                                                        @Nonnull
                                                                        DBQueryHandler qh)
                                                                 throws java.lang.Exception

Throws:

java.lang.Exception

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

findKey

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

Finds a new DBObject by its primary integer key

Specified by:

findKey in interface DataSource

Parameters:

id - The value id

defName - The class name

Returns:

The found object

Throws:

NotFoundException

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

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 find

defName - The class name

Returns:

The found object

Throws:

NotFoundException

TooManyRowsException

java.lang.Exception - a serious problem

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:

rowId - The row id to found

def - The class to find

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

Returns:

The found object

Throws:

NotFoundException

getInwardLinkage

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

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

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

Specified by:

getDataBaseReadOnly in interface DataSource

Returns:

The base virtual DB

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

getLogin

@CheckReturnValue
 @Nonnull
public Login getLogin()

Get the current login

Specified by:

getLogin in interface DataSource

Returns:

The login

getRealLogin

@CheckReturnValue
 @Nonnull
public Login getRealLogin()

Get the current "real" login

Specified by:

getRealLogin in interface DataSource

Returns:

The login

getUser

@CheckReturnValue
 @Nullable
public Person getUser()

Get the current user

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

getCacheObject

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

MAY NOT set/get cache object, this method will always return null.

Specified by:

getCacheObject in interface DataSource

Parameters:

key - The cache key

Returns:

The cache object, null if not present

setCacheObject

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

MAY NOT set/get cache object, this method will always return null.

Specified by:

setCacheObject in interface DataSource

Parameters:

key - The cache key

obj - The object to cache

getAttribute

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

MAY NOT set/get an attribute, this method will always return null.

Specified by:

getAttribute in interface DataSource

Parameters:

name - The attribute's name

Returns:

The value.

getQueryHandler

@CheckReturnValue
 @Nonnull
public DBQueryHandler getQueryHandler(@Nonnull
                                                                  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.

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

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:

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

person - the person to check.

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.

makeQuery

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

getCost

@Nonnull
 @CheckReturnValue
public MemoryHandler.Cost getCost()

The cost level for this MemoryHandler.

Specified by:

getCost in interface MemoryHandler

Returns:

The cost

freeMemory

public long freeMemory(double percentage)

Free memory at this level and below.
To prevent a possible deadlock this method should not be synchronized. It should call MemoryManager.callFreeMemory which in turn calls queuedFreeMemory()

Specified by:

freeMemory in interface MemoryHandler

Parameters:

percentage - to be freed

Returns:

the approximate amount freed

tidyUp

public long tidyUp()

Tidy up the memory handler

Specified by:

tidyUp in interface MemoryHandler

Returns:

the total bytes cleared.

queuedFreeMemory

public long queuedFreeMemory(double percentage)

This method should implement the freeing of the method and maybe synchronized.

Specified by:

queuedFreeMemory in interface MemoryHandler

Parameters:

percentage - The percentage to be cleared.

Returns:

the estimated amount cleared.

panicFreeMemory

public long panicFreeMemory()

Clear all memory.

Specified by:

panicFreeMemory in interface MemoryHandler

Returns:

the estimated amount cleared.

getEstimatedSize

@CheckReturnValue
 @Nonnegative
public long getEstimatedSize()

The estimated size of data held by this memory handler

Specified by:

getEstimatedSize in interface MemoryHandler

Returns:

The estimated number of bytes held.

getLastAccessed

@CheckReturnValue
public long getLastAccessed()

The last time this memory handle was accessed

Specified by:

getLastAccessed in interface MemoryHandler

Returns:

The last time in seconds this memory handler was accessed.