org.ecoinformatics.seek.querybuilder

Class DBQueryDefParserEmitter

java.lang.Object

org.ecoinformatics.seek.querybuilder.DBQueryDefParserEmitter

public class DBQueryDefParserEmitter
extends java.lang.Object

This is class is used to parse XML and create a DBQueryDef object and/or emit XML from a DBQuery object
Call "readQueryDef" for reading in a query
Call "emitXML" to generate the XML

Field Summary

Fields

Modifier and Type	Field and Description
static int	BAD_FIELDNAME a field name was used that could not be found in the schema
static int	BAD_TABLENAME a table name was used that could not be found in the schema
static int	NO_QUERY_NODE the XML was missing a "query" element
static int	QUERY_ERROR error building query
static int	QUERY_OK query was built OK
static java.lang.String	WILDCARD

Constructor Summary

Constructors

Constructor and Description
DBQueryDefParserEmitter()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	createSQL(DSSchemaIFace aSchemaDef, DBQueryDef aQueryDef) Create SQL string
static java.lang.String	emitXML(DBQueryDef aQueryDef) Creates the XML that represents a query
static java.lang.String	getErrorCodeText() Return the text for the error code
static DBQueryDef	parseQueryDef(DSSchemaIFace aSchema, java.lang.String aXMLQueryStr) Parses and creates a DBQueryDef object from an XML String
static DBQueryDef	parseQueryDef(DSSchemaIFace aSchema, java.lang.String aXMLQueryStr, java.util.Hashtable aMappedNameHash) Parses and creates a DBQueryDef object from an XML String
static DBQueryDef	processDOM(DSSchemaIFace aSchema, org.w3c.dom.Document aDoc) Reads in a XML document that is a query definition
protected static DBWhereIFace	processWhereNode(DSSchemaIFace aSchema, org.w3c.dom.Node aNode, DBWhereOperator aParent) Processes the where node
static DBQueryDef	readQueryDef(DSSchemaIFace aSchema, java.lang.String aFileName) Reads in a Query and returns a Query object
protected static boolean	recurseWhere(java.lang.StringBuffer aStrBuf, DBWhereIFace aWhereObj, int aLevel) Recurses through the "tree" of operators and creates a textual rendering of the operators and conditions

Methods inherited from class java.lang.Object

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

Field Detail

QUERY_OK

public static final int QUERY_OK

query was built OK

See Also:

Constant Field Values

QUERY_ERROR

public static final int QUERY_ERROR

error building query

See Also:

Constant Field Values

NO_QUERY_NODE

public static final int NO_QUERY_NODE

the XML was missing a "query" element

See Also:

Constant Field Values

BAD_TABLENAME

public static final int BAD_TABLENAME

a table name was used that could not be found in the schema

See Also:

Constant Field Values

BAD_FIELDNAME

public static final int BAD_FIELDNAME

a field name was used that could not be found in the schema

See Also:

Constant Field Values

WILDCARD

public static final java.lang.String WILDCARD

See Also:

Constant Field Values

Constructor Detail

DBQueryDefParserEmitter

public DBQueryDefParserEmitter()

Method Detail

getErrorCodeText

public static java.lang.String getErrorCodeText()

Return the text for the error code

Returns:

a string representing the error

processWhereNode

protected static DBWhereIFace processWhereNode(DSSchemaIFace aSchema,
                                               org.w3c.dom.Node aNode,
                                               DBWhereOperator aParent)

Processes the where node

Parameters:

aSchema - the schema

aNode - the node

aParent - the node's parent

Returns:

a where object (tree)

processDOM

public static DBQueryDef processDOM(DSSchemaIFace aSchema,
                                    org.w3c.dom.Document aDoc)

Reads in a XML document that is a query definition

Parameters:

aSchema - the schema

aDoc - the document DOM

Returns:

the query def object

readQueryDef

public static DBQueryDef readQueryDef(DSSchemaIFace aSchema,
                                      java.lang.String aFileName)

Reads in a Query and returns a Query object

Parameters:

aSchema - the schema

aFileName - Name of XML file representing a XML document

Returns:

DBQueryDef object

parseQueryDef

public static DBQueryDef parseQueryDef(DSSchemaIFace aSchema,
                                       java.lang.String aXMLQueryStr,
                                       java.util.Hashtable aMappedNameHash)

Parses and creates a DBQueryDef object from an XML String

Parameters:

aSchema - the schema

aXMLQueryStr - XML string representing a XML document

Returns:

DBQueryDef object

parseQueryDef

public static DBQueryDef parseQueryDef(DSSchemaIFace aSchema,
                                       java.lang.String aXMLQueryStr)

Parses and creates a DBQueryDef object from an XML String

Parameters:

aSchema - the schema

aXMLQueryStr - XML string representing a XML document

Returns:

DBQueryDef object

recurseWhere

protected static boolean recurseWhere(java.lang.StringBuffer aStrBuf,
                                      DBWhereIFace aWhereObj,
                                      int aLevel)

Recurses through the "tree" of operators and creates a textual rendering of the operators and conditions

Parameters:

aStrBuf - the output buffer

aWhereObj - the where object tree

aLevel - the level within the tree

Returns:

true if done, false if not

emitXML

public static java.lang.String emitXML(DBQueryDef aQueryDef)

Creates the XML that represents a query

Returns:

the XML document

createSQL

public static java.lang.String createSQL(DSSchemaIFace aSchemaDef,
                                         DBQueryDef aQueryDef)

Create SQL string