org.ecoinformatics.seek.querybuilder

Class DBQueryDef

java.lang.Object

org.ecoinformatics.seek.querybuilder.DBQueryDef

public class DBQueryDef
extends java.lang.Object

This class represents a single query. It is made up of three different parts:
1) The "select" part that describes all the fields that will be "displayed" by the query
2) The "joins" part that is basically table/field name pairs
3) The "where" part which describes a heirarchical (tree) of operators and conditions

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUILD_ERROR A generic error during parsing and building
static int	BUILD_OK The query was built ok with no errors
static int	BUILD_TOO_COMPLEX_JOINS Was unable to convert a set of complex ORs to a standard format
static int	BUILD_TOO_COMPLEX_WHERE More than likely the where clause had a mix of ANDs and ORs
protected boolean	mIsAdv
protected java.util.Vector	mJoins
protected java.util.Vector	mSelects
protected java.util.Vector	mTables
protected DBWhereIFace	mWhere

Constructor Summary

Constructors

Constructor and Description
DBQueryDef() Default Constructor

Method Summary

Modifier and Type	Method and Description
void	addSelectItem(DBSelectTableModelItem aItem) Adds an item to the selects vector
void	addTable(DBQueryDefTable aItem) Adds table DBQueryDefTable item to "table" list
void	addTable(int aId, java.lang.String aName, int aX, int aY) Adds table item to "table" list, it will create a new DBQueryDefTable object
void	addTable(java.lang.String aName) Adds table item to "from" list
void	clear() Clears all the vectors and the where object
java.util.Vector	getJoins() Returns a vector of pairs of items, meaning this vector MUST have an even number of items.
java.util.Vector	getSelects() The vector of items representing the the items to be disdplayed The items are object of class DBSelectTableModelItem
java.util.Vector	getTables() Returns a vector of table names that would represent the "table" portion
DBWhereIFace	getWhere() A copy of the where object and all of its children.
boolean	isAdv() Returns whether it considers the query to be "advanced" An advanced query is one that was built with the advanced tab and then saved out.
void	setIsAdv(boolean aIsAdv) Sets the hint as to whether it is an advanced query
void	setJoins(java.util.Vector aJoins) Sets a vector of DBSelectTableModelItem "pairs", assumes that the vector always holds an even number of elements, one left and right in pairs
void	setWhere(DBWhereIFace aItem) Sets the where object

Methods inherited from class java.lang.Object

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

Field Detail

BUILD_OK

public static final int BUILD_OK

The query was built ok with no errors

See Also:

Constant Field Values

BUILD_ERROR

public static final int BUILD_ERROR

A generic error during parsing and building

See Also:

Constant Field Values

BUILD_TOO_COMPLEX_WHERE

public static final int BUILD_TOO_COMPLEX_WHERE

More than likely the where clause had a mix of ANDs and ORs

See Also:

Constant Field Values

BUILD_TOO_COMPLEX_JOINS

public static final int BUILD_TOO_COMPLEX_JOINS

Was unable to convert a set of complex ORs to a standard format

See Also:

Constant Field Values

mIsAdv

protected boolean mIsAdv

mSelects

protected java.util.Vector mSelects

mTables

protected java.util.Vector mTables

mJoins

protected java.util.Vector mJoins

mWhere

protected DBWhereIFace mWhere

Constructor Detail

DBQueryDef

public DBQueryDef()

Default Constructor

Method Detail

isAdv

public boolean isAdv()

Returns whether it considers the query to be "advanced"
An advanced query is one that was built with the advanced tab and then saved out. It is more of a hint to the tool when reading queries back in.

Returns:

true if it is advanced, false if standard

setIsAdv

public void setIsAdv(boolean aIsAdv)

Sets the hint as to whether it is an advanced query

Parameters:

aIsAdv - The mIsAdv to set.

addSelectItem

public void addSelectItem(DBSelectTableModelItem aItem)

Adds an item to the selects vector

Parameters:

aItem -

setWhere

public void setWhere(DBWhereIFace aItem)

Sets the where object

Parameters:

aItem -

getWhere

public DBWhereIFace getWhere()

A copy of the where object and all of its children. It traverses and builds a duplicate tree of the where object

Returns:

a copy of the where object and all of its children

getSelects

public java.util.Vector getSelects()

The vector of items representing the the items to be disdplayed
The items are object of class DBSelectTableModelItem

Returns:

the Vector of selects, (the display elements)

getJoins

public java.util.Vector getJoins()

Returns a vector of pairs of items, meaning this vector MUST have an even number of items. The objects are of class DBSelectTableModelItem

Returns:

the vector of join pairs

setJoins

public void setJoins(java.util.Vector aJoins)

Sets a vector of DBSelectTableModelItem "pairs", assumes that the vector always holds an even number of elements, one left and right in pairs

Parameters:

aJoins - the join vector

addTable

public void addTable(int aId,
                     java.lang.String aName,
                     int aX,
                     int aY)

Adds table item to "table" list, it will create a new DBQueryDefTable object

Parameters:

aId - id of table

aName - name of table

aX - x coord

aY - y coord

addTable

public void addTable(java.lang.String aName)

Adds table item to "from" list

Parameters:

aName - name of table

addTable

public void addTable(DBQueryDefTable aItem)

Adds table DBQueryDefTable item to "table" list

Parameters:

aItem - DBQueryDefTable item

getTables

public java.util.Vector getTables()

Returns a vector of table names that would represent the "table" portion

Returns:

vector

clear

public void clear()

Clears all the vectors and the where object