com.aspc.DBObj.Internal

Class LayerPlan

java.lang.Object

com.aspc.DBObj.Internal.LayerPlan

public class LayerPlan
extends java.lang.Object

Analyze the clauses to create the best method of search. THREAD MODE: SINGLE-THREADED one search plan per query

Since:

2 June 2002

Author:

Nigel Leck

Constructor Summary

Constructors

Constructor and Description
LayerPlan(SearchPlan searchPlan, DBClass dbClass, VirtualDB layer, DBCriteria criteria, boolean useIndexes)

Method Summary

Modifier and Type	Method and Description
void	generate()
DBCriteria	getCriteria()
DBClass	getDBClass()
VirtualDB	getLayer()
DBField	getNullField()
boolean	getRecordClauses()
SearchPlan	getSearchPlan()
DBPathClause	getSelectableClause(int pos)
int	getSelectableClauseCount()
int	getStep(DBPathClause theClause)
int	getStepCount()
boolean	isBottomLevel() is this the bottom layer ?
boolean	isIndexed(DBPathClause pc) is this field indexed.
boolean	isIndexed(DBPathClause pc, boolean allowLeadingWildCard) is this field indexed.
void	setRecordClauses(boolean flag)
void	setStep(int step)

Methods inherited from class java.lang.Object

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

Constructor Detail

LayerPlan

public LayerPlan(SearchPlan searchPlan,
                 DBClass dbClass,
                 VirtualDB layer,
                 DBCriteria criteria,
                 boolean useIndexes)
          throws java.lang.Exception

Parameters:

searchPlan - the search plan.

dbClass - the class

layer - the layer

criteria - the criteria

useIndexes - use the indexes.

Throws:

java.lang.Exception - a serious problem.

Method Detail

generate

public void generate()
              throws java.lang.Exception

Throws:

java.lang.Exception - a serious problem

getDBClass

public DBClass getDBClass()

Returns:

the class

isIndexed

public boolean isIndexed(DBPathClause pc)

is this field indexed.

Parameters:

pc - the clause

Returns:

is indexed

isIndexed

public boolean isIndexed(DBPathClause pc,
                         boolean allowLeadingWildCard)

is this field indexed.

Parameters:

pc - the clause

allowLeadingWildCard - should we allow a leading wild card

Returns:

is indexed

getStep

public int getStep(DBPathClause theClause)

Parameters:

theClause - the clause

Returns:

the step

getStepCount

public int getStepCount()

Returns:

the count

setStep

public void setStep(int step)

Parameters:

step - the step

getSelectableClause

public DBPathClause getSelectableClause(int pos)

Parameters:

pos - the position

Returns:

the clause

getCriteria

public DBCriteria getCriteria()

Returns:

the criteria

getSelectableClauseCount

public int getSelectableClauseCount()

Returns:

the count

isBottomLevel

public boolean isBottomLevel()

is this the bottom layer ?

Returns:

true if the bottom layer.

getLayer

public VirtualDB getLayer()

Returns:

the layer.

getNullField

public DBField getNullField()

Returns:

the null field

getSearchPlan

public SearchPlan getSearchPlan()

Returns:

the search plan

setRecordClauses

public void setRecordClauses(boolean flag)

Parameters:

flag - record the clauses

getRecordClauses

public boolean getRecordClauses()

Returns:

true if we are recording.