com.aspc.DBObj

Class DBQuery<T extends DBObject>

java.lang.Object

com.aspc.DBObj.DBQuery<T>

Type Parameters:

T - the type of DBObject returned by this query

public final class DBQuery<T extends DBObject>
extends java.lang.Object

All database query are handled through this class. Data base also include newly created/modified/deleted DBObjects


THREAD MODE: SINGLE-THREADED query

Since:

August 19, 2000, 10:37 AM

Author:

Nigel Leck

Constructor Summary

Constructors

Constructor and Description
DBQuery(DBClassConcrete dbClassConcrete, DataSource ds) Creates new Query
DBQuery(GlobalId classId, DataSource ds) Creates new Query
DBQuery(java.lang.String className, DataSource ds) Creates new Query

Method Summary

Modifier and Type	Method and Description
DBClause	addClause(DBClause clause) Add a clause to this query
DBClause	addClause(DBField field, java.lang.String symbol) Add a clause to this query
DBClause	addClause(DBField field, java.lang.String symbol, java.lang.Object value) Add a clause to this query
DBClause	addClause(Path path, java.lang.String symbol) Add a clause to this query
DBClause	addClause(Path path, java.lang.String symbol, java.lang.Object value) Add a clause to this query
DBClause	addClause(java.lang.String clauses) Parse the passed clauses.
DBClause	addClause(java.lang.String fieldPath, java.lang.String symbol) Deprecated. use addNull() or addNotNull()
DBClause	addClause(java.lang.String fieldPath, java.lang.String symbol, boolean value) Deprecated. use addFalse( String field) or addTrue( String field)
DBClause	addClause(java.lang.String fieldPath, java.lang.String symbol, GlobalKey value) Add a clause to this query
DBClause	addClause(java.lang.String fieldPath, java.lang.String symbol, java.lang.Object value) Add a clause to this query
DBQuery<T>	addEquals(DBField field, java.lang.Object value) Add a clause to this query
DBQuery<T>	addEquals(java.lang.String fieldPath, java.lang.Object value) Add a clause to this query
DBQuery<T>	addFalse(DBField field) Add a clause to this query
DBQuery<T>	addFalse(java.lang.String fieldPath) Add a boolean field true clause
DBQuery<T>	addIS(DBField field, DBObject obj) Add a clause to this query
DBQuery<T>	addIS(DBField field, GlobalKey gk) Add a clause to this query
DBQuery<T>	addIS(java.lang.String fieldPath, DBObject obj) Add a clause to this query
DBQuery<T>	addIS(java.lang.String fieldPath, GlobalKey key) Add a clause to this query
DBQuery<T>	addLike(DBField field, java.lang.String value) Add a clause to this query
DBQuery<T>	addLike(java.lang.String fieldPath, java.lang.String value) Add a clause to this query
DBQuery<T>	addMatches(DBField field, java.lang.String value) Add a match clause to this query
DBQuery<T>	addMatches(java.lang.String fieldPath, java.lang.String value) Add a match clause to this query
DBQuery<T>	addNotEqual(DBField field, java.lang.Object value) Add a "NOT EQUAL" clause to this query
DBQuery<T>	addNotEqual(java.lang.String fieldPath, java.lang.Object value) Add a "NOT EQUAL" clause to this query
DBQuery<T>	addNotLike(java.lang.String fieldPath, java.lang.String value) Add a "NOT LIKE" clause to this query
DBQuery<T>	addNotNull(java.lang.String fieldPath) Add a NOT null clause to this query
DBQuery<T>	addNull(java.lang.String fieldPath) Add a NULL clause to this query
DBQuery<T>	addTrue(DBField field) Add a clause to this query
DBQuery<T>	addTrue(java.lang.String fieldPath) Add a boolean field true clause
java.lang.String	cacheKey()
void	call(DALQueryCallBack callBack) the called back
T	findOne() Performs a search as normal, but checks that only one row is found and returns the found object
DBCriteria	getCriteria() The list of clauses for this query
DBClass	getDBClass() Returns the base class for this query.
DBClassConcrete	getDBClassConcrete() Returns the base class for this query.
DataSource	getDS() Returns the data source for this query
long	getTimeout() get the maximum timeout
DBResultGroupBySet	groupBy(Path[] paths, java.lang.String havingClause) Group the results from the query by the specified field paths.
boolean	includeDirtyRows() Should we include the dirty rows ?
SearchPlan	makeSearchPlan() Make Search plan for the query
DBQuery	orderBy(java.lang.String fields)
DBResult<T>	search() Performs a database search and returns a record set.
DBQuery	setDisableDirtyRows(boolean yes) Should we include the dirty rows ?
DBQuery	setSearchPlan(SearchPlan plan) specify a search plan to be used.
DBQuery	setTmeout(long numberOfMilliseconds) set the maximum run time for this query
DBQuery	setUseCache(boolean yes) Allows the use of cache to be turned off
DBQuery	setUseIndexInQuery(boolean useIndex) Allows the use of indexes to be turned off
DBQuery	setUseLinkageCache(boolean yes) Allows the use of the inward linkage cache to be turned off
java.util.stream.Stream<T>	stream()
java.lang.String	toString() A description of this query
boolean	useCache() Should we use the internal cache for this query.
boolean	useIndexInQuery() Should we use indexes for this query ?
boolean	useLinkageCache() Can we use inward linkage cache ?
DBQuery<T>	where(java.lang.String whereClauses)

Methods inherited from class java.lang.Object

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

Constructor Detail

DBQuery

public DBQuery(@Nonnull
               DBClassConcrete dbClassConcrete,
               @Nonnull
               DataSource ds)

Creates new Query

Parameters:

dbClassConcrete - The base class

ds - The data source to use.

DBQuery

public DBQuery(@Nonnull
               java.lang.String className,
               @Nonnull
               DataSource ds)
        throws NotFoundException

Creates new Query

Parameters:

className - The base class

ds - The data source to use.

Throws:

NotFoundException - If the class name is not found.

DBQuery

public DBQuery(@Nonnull
               GlobalId classId,
               @Nonnull
               DataSource ds)
        throws java.lang.Exception

Creates new Query

Parameters:

classId - The base class id

ds - The data source to use

Throws:

java.lang.Exception - If the base class can't be found.

Method Detail

where

@Nonnull
public DBQuery<T> where(@Nonnull
                                 java.lang.String whereClauses)

Parameters:

whereClauses - the clauses.

cacheKey

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

toString

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

A description of this query

Overrides:

toString in class java.lang.Object

Returns:

The description

getDBClass

@CheckReturnValue
 @Nonnull
public DBClass getDBClass()

Returns the base class for this query.

Returns:

The base class

getDBClassConcrete

@CheckReturnValue
 @Nonnull
public DBClassConcrete getDBClassConcrete()

Returns the base class for this query.

Returns:

The base class

getCriteria

@CheckReturnValue
 @Nullable
public DBCriteria getCriteria()

The list of clauses for this query

Returns:

The list of clauses

addClause

@Nonnull
public DBClause addClause(@Nonnull
                                   java.lang.String clauses)
                            throws java.lang.Exception

Parse the passed clauses.

Parameters:

clauses - The text format of the clauses.

Returns:

The result criteria

Throws:

java.lang.Exception - a serious problem

addIS

@Nonnull
public DBQuery<T> addIS(@Nonnull
                                 java.lang.String fieldPath,
                                 @Nonnull
                                 DBObject obj)
                          throws InvalidClauseException

Add a clause to this query

Parameters:

fieldPath - The field path for this query

obj - the object

Returns:

this

Throws:

InvalidClauseException - The clause is not valid

addIS

@Nonnull
public DBQuery<T> addIS(@Nonnull
                                 DBField field,
                                 @Nonnull
                                 DBObject obj)
                          throws InvalidClauseException

Add a clause to this query

Parameters:

field - The field path for this query

obj - the object

Returns:

this

Throws:

InvalidClauseException - The clause is not valid

addIS

@Nonnull
public DBQuery<T> addIS(@Nonnull
                                 DBField field,
                                 @Nonnull
                                 GlobalKey gk)
                          throws InvalidClauseException

Add a clause to this query

Parameters:

field - The field path for this query

gk - the object

Returns:

this

Throws:

InvalidClauseException - The clause is not valid

addTrue

@Nonnull
public DBQuery<T> addTrue(@Nonnull
                                   java.lang.String fieldPath)
                            throws InvalidClauseException,
                                   InvalidPathException

Add a boolean field true clause

Parameters:

fieldPath - The field path for this query

Returns:

this

Throws:

InvalidClauseException - The clause is not valid

InvalidPathException - the path is not valid.

addTrue

@Nonnull
public DBQuery<T> addTrue(@Nonnull
                                   DBField field)
                            throws InvalidClauseException

Add a clause to this query

Parameters:

field - The field path for this query

Returns:

this

Throws:

InvalidClauseException - The clause is not valid

addFalse

@Nonnull
public DBQuery<T> addFalse(@Nonnull
                                    java.lang.String fieldPath)
                             throws InvalidClauseException,
                                    InvalidPathException

Add a boolean field true clause

Parameters:

fieldPath - The field path for this query

Returns:

this

Throws:

InvalidClauseException - The clause is not valid

InvalidPathException - the path is not valid.

addFalse

@Nonnull
public DBQuery<T> addFalse(@Nonnull
                                    DBField field)
                             throws InvalidClauseException

Add a clause to this query

Parameters:

field - The field path for this query

Returns:

this

Throws:

InvalidClauseException - The clause is not valid

addNull

@Nonnull
public DBQuery<T> addNull(@Nonnull
                                   java.lang.String fieldPath)
                            throws InvalidClauseException

Add a NULL clause to this query

Parameters:

fieldPath - The field path for this query

Returns:

this

Throws:

InvalidClauseException - The clause is not valid

addNotNull

@Nonnull
public DBQuery<T> addNotNull(@Nonnull
                                      java.lang.String fieldPath)
                               throws InvalidClauseException

Add a NOT null clause to this query

Parameters:

fieldPath - The field path for this query

Returns:

this

Throws:

InvalidClauseException - The clause is not valid

addNotEqual

@Nonnull
public DBQuery<T> addNotEqual(@Nonnull
                                       java.lang.String fieldPath,
                                       @Nonnull
                                       java.lang.Object value)
                                throws InvalidClauseException

Add a "NOT EQUAL" clause to this query

Parameters:

fieldPath - The field path for this query

value - the value to match

Returns:

this

Throws:

InvalidClauseException - The clause is not valid

addNotLike

@Nonnull
public DBQuery<T> addNotLike(@Nonnull
                                      java.lang.String fieldPath,
                                      @Nonnull
                                      java.lang.String value)
                               throws InvalidClauseException

Add a "NOT LIKE" clause to this query

Parameters:

fieldPath - The field path for this query

value - the value to match

Returns:

this

Throws:

InvalidClauseException - The clause is not valid

addNotEqual

@Nonnull
public DBQuery<T> addNotEqual(@Nonnull
                                       DBField field,
                                       @Nonnull
                                       java.lang.Object value)
                                throws InvalidClauseException

Add a "NOT EQUAL" clause to this query

Parameters:

field - The field path for this query

value - the value to match

Returns:

this

Throws:

InvalidClauseException - The clause is not valid

addEquals

@Nonnull
public DBQuery<T> addEquals(@Nonnull
                                     java.lang.String fieldPath,
                                     @Nonnull
                                     java.lang.Object value)
                              throws InvalidClauseException

Add a clause to this query

Parameters:

fieldPath - The field path for this query

value - the value to match

Returns:

this

Throws:

InvalidClauseException - The clause is not valid

addEquals

@Nonnull
public DBQuery<T> addEquals(@Nonnull
                                     DBField field,
                                     @Nonnull
                                     java.lang.Object value)
                              throws InvalidClauseException

Add a clause to this query

Parameters:

field - The field for this query

value - the value to match

Returns:

this

Throws:

InvalidClauseException - The clause is not valid

addLike

@Nonnull
public DBQuery<T> addLike(@Nonnull
                                   java.lang.String fieldPath,
                                   @Nonnull
                                   java.lang.String value)
                            throws InvalidClauseException

Add a clause to this query

Parameters:

fieldPath - The field path for this query

value - the value to match

Returns:

this

Throws:

InvalidClauseException - The clause is not valid

addLike

@Nonnull
public DBQuery<T> addLike(@Nonnull
                                   DBField field,
                                   @Nonnull
                                   java.lang.String value)
                            throws InvalidClauseException

Add a clause to this query

Parameters:

field - The field for this query

value - the value to match

Returns:

this

Throws:

InvalidClauseException - The clause is not valid

addMatches

@Nonnull
public DBQuery<T> addMatches(@Nonnull
                                      java.lang.String fieldPath,
                                      @Nonnull
                                      java.lang.String value)
                               throws InvalidClauseException

Add a match clause to this query

Parameters:

fieldPath - The field path for this query

value - the value to match

Returns:

this

Throws:

InvalidClauseException - The clause is not valid

addMatches

@Nonnull
public DBQuery<T> addMatches(@Nonnull
                                      DBField field,
                                      @Nonnull
                                      java.lang.String value)
                               throws InvalidClauseException

Add a match clause to this query

Parameters:

field - The field for this query

value - the value to match

Returns:

this

Throws:

InvalidClauseException - The clause is not valid

addIS

@Nonnull
public DBQuery<T> addIS(@Nonnull
                                 java.lang.String fieldPath,
                                 @Nonnull
                                 GlobalKey key)
                          throws InvalidClauseException

Add a clause to this query

Parameters:

fieldPath - The field path for this query

key - the global key

Returns:

this

Throws:

InvalidClauseException - The clause is not valid

addClause

@Nonnull
 @Deprecated
public DBClause addClause(@Nonnull
                                                java.lang.String fieldPath,
                                                @Nonnull
                                                java.lang.String symbol)
                                         throws InvalidClauseException

Deprecated. use addNull() or addNotNull()

Add a clause to this query

Parameters:

fieldPath - The field path for this query

symbol - The symbol for this clause

Returns:

The clause

Throws:

InvalidClauseException - The clause is not valid

groupBy

@CheckReturnValue
 @Nonnull
public DBResultGroupBySet groupBy(@Nullable
                                                              Path[] paths,
                                                              java.lang.String havingClause)
                                                       throws java.lang.Exception

Group the results from the query by the specified field paths. A DBResultGroupBySet will be generated which will contain a number of sub results sets which will contain a number of DBObjects Each DBObject in the sub result set will have the same value for each of the paths specified.

Parameters:

paths - The field paths that results are to be grouped by

havingClause - An additional filter based on aggregate functions

Returns:

The DBResultGroupBySet

Throws:

java.lang.Exception - a serious problem.

addClause

@Nonnull
public DBClause addClause(@Nonnull
                                   DBClause clause)
                            throws InvalidClauseException

Add a clause to this query

Parameters:

clause - The clause to add.

Returns:

The clause

Throws:

InvalidClauseException - The clause is not valid

addClause

@Nonnull
public DBClause addClause(@Nonnull
                                   DBField field,
                                   @Nonnull
                                   java.lang.String symbol)
                            throws InvalidClauseException

Add a clause to this query

Parameters:

field - The field for the query.

symbol - The symbol for the clause

Returns:

The clause

Throws:

InvalidClauseException - The clause is not valid

addClause

@Nonnull
public DBClause addClause(@Nonnull
                                   Path path,
                                   @Nonnull
                                   java.lang.String symbol)
                            throws InvalidClauseException

Add a clause to this query

Parameters:

path - The path for the clause

symbol - NULL or NOT NULL

Returns:

The clause

Throws:

InvalidClauseException - The clause is not valid

addClause

@Nonnull
public DBClause addClause(@Nonnull
                                   java.lang.String fieldPath,
                                   @Nonnull
                                   java.lang.String symbol,
                                   java.lang.Object value)
                            throws InvalidClauseException

Add a clause to this query

Parameters:

fieldPath - The path for the clause

symbol - The symbol for the clause

value - The value for the clause

Returns:

The clause

Throws:

InvalidClauseException - The clause is not valid

addClause

@Nonnull
public DBClause addClause(@Nonnull
                                   DBField field,
                                   @Nonnull
                                   java.lang.String symbol,
                                   java.lang.Object value)
                            throws InvalidClauseException

Add a clause to this query

Parameters:

field - The field for the clause

symbol - The symbol

value - The value

Returns:

The clause

Throws:

InvalidClauseException - The clause is not valid

addClause

@Nonnull
public DBClause addClause(@Nonnull
                                   Path path,
                                   @Nonnull
                                   java.lang.String symbol,
                                   @Nullable
                                   java.lang.Object value)
                            throws InvalidClauseException

Add a clause to this query

Parameters:

path - The path for this clause

symbol - The symbol for the clause

value - The value

Returns:

The clause

Throws:

InvalidClauseException - The clause is not valid

addClause

@Nonnull
public DBClause addClause(@Nonnull
                                   java.lang.String fieldPath,
                                   @Nonnull
                                   java.lang.String symbol,
                                   @Nonnull
                                   GlobalKey value)
                            throws InvalidClauseException

Add a clause to this query

Parameters:

fieldPath - The path for the clause

symbol - The symbol for the clause

value - The value for the clause

Returns:

The clause

Throws:

InvalidClauseException - The clause is not valid

addClause

@Nonnull
 @Deprecated
public DBClause addClause(@Nonnull
                                                java.lang.String fieldPath,
                                                @Nonnull
                                                java.lang.String symbol,
                                                boolean value)
                                         throws InvalidClauseException

Deprecated. use addFalse( String field) or addTrue( String field)

Add a clause to this query

Parameters:

fieldPath - The path for the new clause

symbol - The symbol for the clause

value - The value for the clause

Returns:

The clause

Throws:

InvalidClauseException - The clause is not valid

getDS

@Nonnull
 @CheckReturnValue
public DataSource getDS()

Returns the data source for this query

Returns:

The data source

findOne

@Nonnull
public T findOne()
                   throws NotFoundException,
                          TooManyRowsException,
                          java.lang.Exception

Performs a search as normal, but checks that only one row is found and returns the found object

Returns:

The found object

Throws:

NotFoundException - - The object could not be found that matches criteria

TooManyRowsException - - There were multiple objects found that matched the criteria

java.lang.Exception - A serious problem

stream

@Nonnull
 @CheckReturnValue
public java.util.stream.Stream<T> stream()
                                                              throws java.lang.Exception

Throws:

java.lang.Exception

search

@Nonnull
 @CheckReturnValue
public DBResult<T> search()
                                               throws java.lang.Exception

Performs a database search and returns a record set.

Returns:

The record set

Throws:

java.lang.Exception - A serious problem

setSearchPlan

@Nonnull
public DBQuery setSearchPlan(@Nullable
                                      SearchPlan plan)

specify a search plan to be used.

Parameters:

plan - The plan to use

Returns:

this

setUseIndexInQuery

@Nonnull
public DBQuery setUseIndexInQuery(boolean useIndex)

Allows the use of indexes to be turned off

Parameters:

useIndex - Use the indexes or not

Returns:

this

useIndexInQuery

@CheckReturnValue
public boolean useIndexInQuery()

Should we use indexes for this query ?

Returns:

TRUE if we should use the indexes.

setUseCache

public DBQuery setUseCache(boolean yes)

Allows the use of cache to be turned off

Parameters:

yes - Use cache or not

Returns:

this

useCache

@CheckReturnValue
public boolean useCache()

Should we use the internal cache for this query. This is primary used within loading the cache itself. Otherwise we'd get a stack overflow.

Returns:

TRUE if we should use the internal cache.

includeDirtyRows

@CheckReturnValue
public boolean includeDirtyRows()

Should we include the dirty rows ?

Returns:

true if the dirty rows should be included in the row set.

setDisableDirtyRows

@Nonnull
public DBQuery setDisableDirtyRows(boolean yes)

Should we include the dirty rows ?

Parameters:

yes - include dirty rows or not

Returns:

this

setUseLinkageCache

@Nonnull
public DBQuery setUseLinkageCache(boolean yes)

Allows the use of the inward linkage cache to be turned off

Parameters:

yes - Use cache or not

Returns:

this

useLinkageCache

@CheckReturnValue
public boolean useLinkageCache()

Can we use inward linkage cache ?

Returns:

true if yes

setTmeout

@Nonnull
public DBQuery setTmeout(long numberOfMilliseconds)

set the maximum run time for this query

Parameters:

numberOfMilliseconds - The timeout period.

Returns:

this

getTimeout

@CheckReturnValue
public long getTimeout()

get the maximum timeout

Returns:

The timeout period in milliseconds.

makeSearchPlan

@CheckReturnValue
public SearchPlan makeSearchPlan()
                                            throws java.lang.Exception

Make Search plan for the query

Returns:

SearchPlan

Throws:

java.lang.Exception - A serious problem occurs

orderBy

@Nonnull
public DBQuery orderBy(java.lang.String fields)

call

public void call(DALQueryCallBack callBack)

the called back

Parameters:

callBack - the call back