com.aspc.DBObj.Query

Class DBPathClause

java.lang.Object

com.aspc.DBObj.Query.DBPathClause

All Implemented Interfaces:

DBClause, java.lang.Cloneable

public final class DBPathClause
extends java.lang.Object
implements DBClause

DBClause is a stored query clause. This is the basis of the report generator. There maybe one or more clauses per DBCriteria. A report query is made of one or many DBCriteria
THREAD MODE: MULTI-THREADED not mutable

Since:

August 19, 2000, 10:47 AM

Author:

Nigel Leck

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DISABLE_IN_MEMORY_CHECK disabled the check of IN MEMORY objects first.
DataSource	ds the data source
static int	MAX_IN_VALUES the max number IN values.
static java.lang.String	PROPERTY_DISABLE_IN_MEMORY_CHECK The property to disable the IN MEMORY objects first.
static java.lang.String	SYMBOL_BETWEEN
static java.lang.String	SYMBOL_CONTAINS
static java.lang.String	SYMBOL_CONTAINS_ANY_OF
static java.lang.String	SYMBOL_ENDSWITH
static java.lang.String	SYMBOL_EQUALS = symbol
static java.lang.String	SYMBOL_GREATER greater than symbol
static java.lang.String	SYMBOL_GREATER_EQUALS
static java.lang.String	SYMBOL_IN IN operator
static java.lang.String	SYMBOL_IS IS symbol
static java.lang.String	SYMBOL_IS_IN IS IN symbol
static java.lang.String	SYMBOL_LESS less than symbol
static java.lang.String	SYMBOL_LESS_EQUALS less than equals symbol
static java.lang.String	SYMBOL_LIKE LIKE symbol
static java.lang.String	SYMBOL_MATCHES matches
static java.lang.String	SYMBOL_NOT_BETWEEN
static java.lang.String	SYMBOL_NOT_EQUAL not equals symbol
static java.lang.String	SYMBOL_NOT_IN SELECT * FROM Person WHERE Name NOT IN ( 'Jack', 'Sam')
static java.lang.String	SYMBOL_NOT_IS NOT IS symbol
static java.lang.String	SYMBOL_NOT_IS_IN NOT IS IN symbol
static java.lang.String	SYMBOL_NOT_LIKE NOT LIKE symbol
static java.lang.String	SYMBOL_NOT_NULL
static java.lang.String	SYMBOL_NOTCONTAINS
static java.lang.String	SYMBOL_NOTENDSWITH
static java.lang.String	SYMBOL_NOTSTARTSWITH
static java.lang.String	SYMBOL_NULL null symbol
static java.lang.String	SYMBOL_STARTSWITH

Constructor Summary

Constructors

Constructor and Description
DBPathClause(DataSource ds, DBClassConcrete baseClass, DBField field, java.lang.String symbol, java.lang.Object value) Creates new DBClause
DBPathClause(DataSource ds, DBClassConcrete baseClass, java.lang.String fieldPath, java.lang.String symbol, java.lang.Object value) Creates a new clause
DBPathClause(DataSource ds, Path path, java.lang.String symbol, java.lang.Object value) Creates a new clause

Method Summary

Modifier and Type	Method and Description
boolean	canSelect(boolean isIndexed, VirtualDB layer) Can we select this from the database.
DBClause	cloneOpposite() make the opposite clause
static java.lang.String	convertSymbol(java.lang.String orgSymbol)
DBClause	doClone()
DBClassConcrete	getBaseClassConcrete()
java.lang.Object[]	getBetweenValues()
java.lang.String	getComment()
DBField	getField()
Path	getPath()
long	getRowsEstimate(VirtualDB layer) the estimated rows for this clause.
int	getRowsEstimatePerMatch(VirtualDB layer) the estimated rows for this clause.
long	getRowsEstimateTargetField(VirtualDB layer)
java.lang.String	getSQLValue(VirtualDB layer, boolean isIndexed, int step)
java.lang.String	getString()
java.lang.String	getSymbol()
DBClassConcrete	getTargetClassConcrete() get the target class of this path
java.lang.Object	getValue()
java.lang.String[]	getValueList()
boolean	isAfirmitiveRestriction()
boolean	isBottomLevel(VirtualDB layer) Are we at the bottom level
boolean	isComplex() Is this clause complex ?
boolean	isFinal() Is this clause final ?
static boolean	isValidSymbol(java.lang.String orgSymbol)
boolean	matches(DBObject obj, HintField hint) Does this object match this clause ? the checkRes flag dictates when we should return false when checking a path which can return multiple results from the same base For e.g if the condition is to return all invoices that have a linked task with a status of done then we would return false if no tasks where found with a status of done.
void	setComment(java.lang.String comment)
void	setFinal() make the clause final
java.lang.String	toString() a string version of this clause
java.lang.String	where()

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_DISABLE_IN_MEMORY_CHECK

public static final java.lang.String PROPERTY_DISABLE_IN_MEMORY_CHECK

The property to disable the IN MEMORY objects first.

See Also:

Constant Field Values

DISABLE_IN_MEMORY_CHECK

public static final boolean DISABLE_IN_MEMORY_CHECK

disabled the check of IN MEMORY objects first.

SYMBOL_IN

public static final java.lang.String SYMBOL_IN

IN operator

See Also:

Constant Field Values

SYMBOL_NOT_IN

public static final java.lang.String SYMBOL_NOT_IN

SELECT * FROM Person WHERE Name NOT IN ( 'Jack', 'Sam')

See Also:

Constant Field Values

SYMBOL_IS_IN

public static final java.lang.String SYMBOL_IS_IN

IS IN symbol

See Also:

Constant Field Values

SYMBOL_NOT_IS_IN

public static final java.lang.String SYMBOL_NOT_IS_IN

NOT IS IN symbol

See Also:

Constant Field Values

SYMBOL_EQUALS

public static final java.lang.String SYMBOL_EQUALS

= symbol

See Also:

Constant Field Values

SYMBOL_IS

public static final java.lang.String SYMBOL_IS

IS symbol

See Also:

Constant Field Values

SYMBOL_NOT_IS

public static final java.lang.String SYMBOL_NOT_IS

NOT IS symbol

See Also:

Constant Field Values

SYMBOL_LIKE

public static final java.lang.String SYMBOL_LIKE

LIKE symbol

See Also:

Constant Field Values

SYMBOL_NOT_LIKE

public static final java.lang.String SYMBOL_NOT_LIKE

NOT LIKE symbol

See Also:

Constant Field Values

SYMBOL_NOT_EQUAL

public static final java.lang.String SYMBOL_NOT_EQUAL

not equals symbol

See Also:

Constant Field Values

SYMBOL_GREATER

public static final java.lang.String SYMBOL_GREATER

greater than symbol

See Also:

Constant Field Values

SYMBOL_LESS

public static final java.lang.String SYMBOL_LESS

less than symbol

See Also:

Constant Field Values

SYMBOL_LESS_EQUALS

public static final java.lang.String SYMBOL_LESS_EQUALS

less than equals symbol

See Also:

Constant Field Values

SYMBOL_NULL

public static final java.lang.String SYMBOL_NULL

null symbol

See Also:

Constant Field Values

SYMBOL_NOT_NULL

public static final java.lang.String SYMBOL_NOT_NULL

See Also:

Constant Field Values

SYMBOL_GREATER_EQUALS

public static final java.lang.String SYMBOL_GREATER_EQUALS

See Also:

Constant Field Values

SYMBOL_BETWEEN

public static final java.lang.String SYMBOL_BETWEEN

See Also:

Constant Field Values

SYMBOL_NOT_BETWEEN

public static final java.lang.String SYMBOL_NOT_BETWEEN

See Also:

Constant Field Values

SYMBOL_STARTSWITH

public static final java.lang.String SYMBOL_STARTSWITH

See Also:

Constant Field Values

SYMBOL_ENDSWITH

public static final java.lang.String SYMBOL_ENDSWITH

See Also:

Constant Field Values

SYMBOL_CONTAINS

public static final java.lang.String SYMBOL_CONTAINS

See Also:

Constant Field Values

SYMBOL_MATCHES

public static final java.lang.String SYMBOL_MATCHES

matches

See Also:

Constant Field Values

SYMBOL_NOTSTARTSWITH

public static final java.lang.String SYMBOL_NOTSTARTSWITH

See Also:

Constant Field Values

SYMBOL_NOTENDSWITH

public static final java.lang.String SYMBOL_NOTENDSWITH

See Also:

Constant Field Values

SYMBOL_NOTCONTAINS

public static final java.lang.String SYMBOL_NOTCONTAINS

See Also:

Constant Field Values

SYMBOL_CONTAINS_ANY_OF

public static final java.lang.String SYMBOL_CONTAINS_ANY_OF

See Also:

Constant Field Values

ds

public final DataSource ds

the data source

MAX_IN_VALUES

public static final int MAX_IN_VALUES

the max number IN values. Sybase was ignoring the indexes at 250.
TODO: Make this database and class dependent

See Also:

Constant Field Values

Constructor Detail

DBPathClause

public DBPathClause(@Nonnull
                    DataSource ds,
                    @Nonnull
                    DBClassConcrete baseClass,
                    @Nonnull
                    DBField field,
                    @Nonnull
                    java.lang.String symbol,
                    @Nullable
                    java.lang.Object value)
             throws InvalidClauseException

Creates new DBClause

Parameters:

baseClass - the base class for this clause

ds - the data source

field - the field to restrict on

symbol - the restriction symbol

value - the restriction value

Throws:

InvalidClauseException - the clause is not valid

DBPathClause

public DBPathClause(@Nonnull
                    DataSource ds,
                    @Nonnull
                    DBClassConcrete baseClass,
                    @Nonnull
                    java.lang.String fieldPath,
                    @Nonnull
                    java.lang.String symbol,
                    @Nullable
                    java.lang.Object value)
             throws InvalidClauseException

Creates a new clause

Parameters:

ds - the data source

baseClass - the base class for this clause

fieldPath - the field to restrict on

symbol - the restriction symbol

value - the restriction value

Throws:

InvalidClauseException - the clause is not valid

DBPathClause

public DBPathClause(DataSource ds,
                    Path path,
                    java.lang.String symbol,
                    java.lang.Object value)
             throws InvalidClauseException

Creates a new clause

Parameters:

ds - the data source

path - the path to restrict on

symbol - the restriction symbol

value - the restriction value

Throws:

InvalidClauseException - the clause is not valid

Method Detail

matches

@CheckReturnValue
public boolean matches(@Nonnull
                                         DBObject obj,
                                         @Nullable
                                         HintField hint)
                                  throws java.lang.Exception

Does this object match this clause ?

the checkRes flag dictates when we should return false when checking
a path which can return multiple results from the same base
For e.g if the condition is to return all invoices that have a linked task
with a status of done then we would return false if no tasks where found
with a status of done. In the other case where we want all invoices that
have a status not equal to done then we would return false if any tasks
were found with a status of done.

Specified by:

matches in interface DBClause

Parameters:

hint - the hint of the next records.

obj - the object to match

Returns:

true if a match

Throws:

java.lang.Exception - a serious problem

isComplex

@CheckReturnValue
public boolean isComplex()

Is this clause complex ?

Specified by:

isComplex in interface DBClause

Returns:

true if complex

where

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

Specified by:

where in interface DBClause

toString

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

a string version of this clause

Overrides:

toString in class java.lang.Object

Returns:

the description

isBottomLevel

@CheckReturnValue
public boolean isBottomLevel(@Nonnull
                                               VirtualDB layer)

Are we at the bottom level

Specified by:

isBottomLevel in interface DBClause

Parameters:

layer - the layer

Returns:

true if the bottom

setFinal

public void setFinal()

make the clause final

Specified by:

setFinal in interface DBClause

isFinal

@CheckReturnValue
public boolean isFinal()

Is this clause final ?

Specified by:

isFinal in interface DBClause

Returns:

true if final

getValueList

@CheckReturnValue
 @Nonnull
public java.lang.String[] getValueList()

Returns:

the value

convertSymbol

@CheckReturnValue
 @Nonnull
public static java.lang.String convertSymbol(@Nullable
                                                                         java.lang.String orgSymbol)

Parameters:

orgSymbol -

Returns:

the value

isAfirmitiveRestriction

@CheckReturnValue
public boolean isAfirmitiveRestriction()

Returns:

the value

getBaseClassConcrete

@CheckReturnValue
 @Nonnull
public DBClassConcrete getBaseClassConcrete()

Returns:

the value

getTargetClassConcrete

@CheckReturnValue
 @Nonnull
public DBClassConcrete getTargetClassConcrete()

get the target class of this path

Returns:

the class

getRowsEstimatePerMatch

@CheckReturnValue
 @Nonnegative
public int getRowsEstimatePerMatch(@Nonnull
                                                                   VirtualDB layer)

the estimated rows for this clause.

Parameters:

layer - the layer

Returns:

the estimated rows.

getRowsEstimate

@CheckReturnValue
 @Nonnegative
public long getRowsEstimate(@Nonnull
                                                            VirtualDB layer)

the estimated rows for this clause.

Parameters:

layer - the layer

Returns:

the estimated rows.

getRowsEstimateTargetField

@CheckReturnValue
 @Nonnegative
public long getRowsEstimateTargetField(@Nonnull
                                                                       VirtualDB layer)

Parameters:

layer -

Returns:

the value

isValidSymbol

@CheckReturnValue
public static boolean isValidSymbol(@Nonnull
                                                      java.lang.String orgSymbol)

Parameters:

orgSymbol -

Returns:

the value

canSelect

@CheckReturnValue
public boolean canSelect(boolean isIndexed,
                                           @Nonnull
                                           VirtualDB layer)

Can we select this from the database.

Parameters:

isIndexed -

layer - the layer

Returns:

the value

getField

@CheckReturnValue
 @Nonnull
public DBField getField()

Returns:

the value

getSymbol

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

Returns:

the value

getValue

@CheckReturnValue
 @Nullable
public java.lang.Object getValue()

Returns:

the value

getString

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

Returns:

the value

getBetweenValues

@CheckReturnValue
 @Nullable
public java.lang.Object[] getBetweenValues()

Returns:

the value

getPath

@CheckReturnValue
 @Nullable
public Path getPath()

Returns:

the value

setComment

public void setComment(@Nullable
                       java.lang.String comment)

Parameters:

comment -

getComment

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

Returns:

the value

getSQLValue

@CheckReturnValue
 @Nullable
public java.lang.String getSQLValue(@Nonnull
                                                                 VirtualDB layer,
                                                                 boolean isIndexed,
                                                                 int step)
                                                          throws java.lang.Exception

Parameters:

layer - the layer

isIndexed -

step -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

doClone

@Nonnull
 @CheckReturnValue
public DBClause doClone()

Specified by:

doClone in interface DBClause

cloneOpposite

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

Description copied from interface: DBClause

make the opposite clause

Specified by:

cloneOpposite in interface DBClause

Returns:

the value

Throws:

java.lang.CloneNotSupportedException

InvalidClauseException