com.aspc.DBObj.Query

Class DBCriteria

java.lang.Object

com.aspc.DBObj.Query.DBCriteria

All Implemented Interfaces:

DBClause, java.lang.Cloneable

public class DBCriteria
extends java.lang.Object
implements DBClause, java.lang.Cloneable

DBCriteria stores a set of Query Constraints The set of constraints can be either mutually exclusive of not.
THREAD MODE: MULTI-THREADED

Since:

October 17, 2002

Author:

Jason McGrath

Constructor Summary

Constructors

Constructor and Description
DBCriteria() Creates new DBClause
DBCriteria(boolean andCriteria) database clause
DBCriteria(boolean andCriteria, boolean notMode) database clause

Method Summary

Modifier and Type	Method and Description
void	addClause(DataSource ds, DBClass baseClass, java.lang.String path, java.lang.String value) add a clause
void	addClause(DataSource ds, DBClass baseClass, java.lang.String path, java.lang.String symbol, java.lang.Object value) add a clause
void	addClause(DBClause qc) add a clause
java.lang.Object	clone() clone the clause
DBClause	cloneOpposite() create a opposite a clause
int	count() The number of constraints for this criteria
void	decode(DataSource ds, DBClassConcrete dbClass, java.lang.String clauses) decode the criteria
DBClause	doClone()
DBClause	getClause(int pos) get a clause at a position
java.lang.String	getDescription(int level) get the description
boolean	isAndCriteria() is this an AND criteria
boolean	isBottomLevel(VirtualDB vDB) Is this the bottom possible level for this criteria ? If this is an AND criteria then any positive clause that map to a field that is defined in this layer means this is the bottom layer.
boolean	isComplex() Is this criteria complex ?
boolean	isFinal() is the clause marked as final ?
boolean	isNotMode() is NOT mode
DBClause[]	listAndClauses() Returns as many clauses as possible that are ANDed together This is used to determine the clauses that can be used directly in a select while not excluding data that could be valid by the use of an OR criteria.
boolean	matches(DBObject obj, HintField hint) does the object match ?
boolean	omitsAll() is this clause is marked as OMIT ALL
DBClause	removeClause(int pos) Removes a clause at a position
void	setDescription(java.lang.String description) The description
void	setFinal() make the clause final ( and remove blank clauses)
java.lang.String	toString() display the clause
java.lang.String	toString(int level) display the clause
java.lang.String	where()

Methods inherited from class java.lang.Object

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

Constructor Detail

DBCriteria

public DBCriteria()

Creates new DBClause

DBCriteria

public DBCriteria(boolean andCriteria)

database clause

Parameters:

andCriteria - is an and criteria

DBCriteria

public DBCriteria(boolean andCriteria,
                  boolean notMode)

database clause

Parameters:

andCriteria - is an and criteria

notMode - is not mode

Method Detail

isNotMode

@CheckReturnValue
public boolean isNotMode()

is NOT mode

Returns:

TRUE if not mode

decode

public void decode(DataSource ds,
                   DBClassConcrete dbClass,
                   java.lang.String clauses)
            throws java.lang.Exception

decode the criteria

Parameters:

ds - the data source

dbClass - The base class

clauses - the clauses to decode

Throws:

java.lang.Exception - a serious problem

addClause

public void addClause(DataSource ds,
                      DBClass baseClass,
                      java.lang.String path,
                      java.lang.String symbol,
                      java.lang.Object value)
               throws InvalidClauseException

add a clause

Parameters:

ds - the datasource

baseClass - The base class

path - the path of the clause

symbol - the symbol

value - the value to match

Throws:

InvalidClauseException - invalid clause

addClause

public void addClause(DataSource ds,
                      DBClass baseClass,
                      java.lang.String path,
                      java.lang.String value)
               throws java.lang.Exception

add a clause

Parameters:

ds - the datasource

baseClass - The base class

path - the path of the clause

value - the value to match

Throws:

java.lang.Exception - a serious problem

addClause

public void addClause(@Nullable
                      DBClause qc)

add a clause

Parameters:

qc - a clause

count

@CheckReturnValue
public final int count()

The number of constraints for this criteria

Returns:

the count

getClause

@CheckReturnValue
 @Nullable
public final DBClause getClause(@Nonnegative
                                                             int pos)

get a clause at a position

Parameters:

pos - the position

Returns:

the clause

removeClause

@Nullable
public final DBClause removeClause(@Nonnegative
                                             int pos)

Removes a clause at a position

Parameters:

pos - the position

Returns:

the removed clause

isComplex

@CheckReturnValue
public final boolean isComplex()

Is this criteria complex ?

Specified by:

isComplex in interface DBClause

Returns:

TRUE is complex

matches

@CheckReturnValue
public boolean matches(DBObject obj,
                                         @Nullable
                                         HintField hint)

does the object match ?

Specified by:

matches in interface DBClause

Parameters:

hint - the hint of next records.

obj - the object to check

Returns:

TRUE if match

isAndCriteria

@CheckReturnValue
public boolean isAndCriteria()

is this an AND criteria

Returns:

TRUE is and AND criteria

setFinal

public void setFinal()

make the clause final ( and remove blank clauses)

Specified by:

setFinal in interface DBClause

isFinal

@CheckReturnValue
public final boolean isFinal()

is the clause marked as final ?

Specified by:

isFinal in interface DBClause

Returns:

TRUE if is final

omitsAll

@CheckReturnValue
public boolean omitsAll()
                                   throws java.lang.Exception

is this clause is marked as OMIT ALL

Returns:

TRUE if omit

Throws:

java.lang.Exception - a serious problem

isBottomLevel

@CheckReturnValue
public boolean isBottomLevel(VirtualDB vDB)

Is this the bottom possible level for this criteria ?

If this is an AND criteria then any positive clause that map to a field that is defined in this layer means this is the bottom layer.
If this is an OR criteria then any positive clause that maps to a field in a layer below means that this is not the bottom layer.

Specified by:

isBottomLevel in interface DBClause

Parameters:

vDB - the layer

Returns:

true if the bottom layer.

doClone

@Nonnull
 @CheckReturnValue
public DBClause doClone()

Specified by:

doClone in interface DBClause

clone

@CheckReturnValue
 @Nonnull
public java.lang.Object clone()
                                                   throws java.lang.CloneNotSupportedException

clone the clause

Overrides:

clone in class java.lang.Object

Returns:

the new clause

Throws:

java.lang.CloneNotSupportedException - not thrown

cloneOpposite

@CheckReturnValue
public DBClause cloneOpposite()
                                         throws java.lang.CloneNotSupportedException

create a opposite a clause

Specified by:

cloneOpposite in interface DBClause

Returns:

the new opposite clause

Throws:

java.lang.CloneNotSupportedException - not thrown

listAndClauses

@CheckReturnValue
public DBClause[] listAndClauses()

Returns as many clauses as possible that are ANDed together This is used to determine the clauses that can be used directly in a select while not excluding data that could be valid by the use of an OR criteria.

Returns:

the list of clauses.

setDescription

public void setDescription(@Nullable
                           java.lang.String description)

The description

Parameters:

description - a text description

getDescription

@CheckReturnValue
 @Nonnull
public java.lang.String getDescription(int level)

get the description

Parameters:

level - the level

Returns:

the description

where

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

Specified by:

where in interface DBClause

toString

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

display the clause

Overrides:

toString in class java.lang.Object

Returns:

display of the clause

toString

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

display the clause

Parameters:

level - indent level

Returns:

display the clause