org.apache.ojb.broker.accesslayer.sql
Class SqlQueryStatement

java.lang.Object
  org.apache.ojb.broker.accesslayer.sql.SqlQueryStatement

All Implemented Interfaces:

JoinSyntaxTypes, SqlStatement

Direct Known Subclasses:

SqlDeleteByQuery, SqlSelectStatement

public abstract class SqlQueryStatement
extends Object
implements SqlStatement, JoinSyntaxTypes

Model a Statement based on Query.

Version:

$Id: SqlQueryStatement.java,v 1.1 2007-08-24 22:17:39 ewestfal Exp $

Author:

Jakob Braeuchi

Field Summary

protected HashMap

m_attrToFld

Fields inherited from interface org.apache.ojb.broker.accesslayer.JoinSyntaxTypes

ORACLE_JOIN_SYNTAX, SQL92_JOIN_SYNTAX, SQL92_NOPAREN_JOIN_SYNTAX, SYBASE_JOIN_SYNTAX

Constructor Summary

SqlQueryStatement(Platform pf, ClassDescriptor cld, Query query, Logger logger)
Constructor for SqlCriteriaStatement.

SqlQueryStatement(SqlQueryStatement parent, Platform pf, ClassDescriptor cld, Query query, Logger logger)
Constructor for SqlCriteriaStatement.

Method Summary

protected void	appendClause(StringBuffer clause, Criteria crit, StringBuffer stmt) appends a WHERE/HAVING-clause to the Statement
protected boolean	appendColName(org.apache.ojb.broker.accesslayer.sql.SqlQueryStatement.TableAlias aTableAlias, SqlHelper.PathInfo aPathInfo, boolean translate, StringBuffer buf) Add the Column to the StringBuffer
protected boolean	appendColName(String attr, boolean useOuterJoins, UserAlias aUserAlias, StringBuffer buf) Append the appropriate ColumnName to the buffer if a FIELDDESCRIPTOR is found for the Criteria the colName is taken from there otherwise its taken from Criteria.
protected boolean	appendColName(String attr, String attrAlias, boolean useOuterJoins, UserAlias aUserAlias, StringBuffer buf) Append the appropriate ColumnName to the buffer if a FIELDDESCRIPTOR is found for the Criteria the colName is taken from there otherwise its taken from Criteria.
protected void	appendCriteria(org.apache.ojb.broker.accesslayer.sql.SqlQueryStatement.TableAlias alias, SqlHelper.PathInfo pathInfo, SelectionCriteria c, StringBuffer buf) Answer the SQL-Clause for a SelectionCriteria
protected void	appendGroupByClause(List groupByFields, StringBuffer buf) Appends the GROUP BY clause for the Query
protected void	appendHavingClause(StringBuffer having, Criteria crit, StringBuffer stmt) appends a HAVING-clause to the Statement
protected void	appendOrderByClause(List orderByFields, List selectedFields, StringBuffer buf) Appends the ORDER BY clause for the Query.
protected void	appendSQLClause(SelectionCriteria c, StringBuffer buf) Answer the SQL-Clause for a SelectionCriteria If the Criteria references a class with extents an OR-Clause is added for each extent
protected void	appendTableWithJoins(org.apache.ojb.broker.accesslayer.sql.SqlQueryStatement.TableAlias alias, StringBuffer where, StringBuffer buf) Appends to the statement table and all tables joined to it.
protected void	appendWhereClause(StringBuffer where, Criteria crit, StringBuffer stmt) appends a WHERE-clause to the Statement
protected abstract String	buildStatement() Build the SQL String.
protected void	buildSuperJoinTree(org.apache.ojb.broker.accesslayer.sql.SqlQueryStatement.TableAlias left, ClassDescriptor cld, String name, boolean useOuterJoin) build the Join-Information if a super reference exists
protected void	ensureColumns(List columns, List existingColumns) Builds the Join for columns if they are not found among the existingColumns.
protected List	ensureColumns(List columns, List existingColumns, StringBuffer buf) Builds the Join for columns if they are not found among the existingColumns.
protected org.apache.ojb.broker.accesslayer.sql.SqlQueryStatement.AttributeInfo	getAttributeInfo(String attr, boolean useOuterJoins, UserAlias aUserAlias, Map pathClasses) Return the TableAlias and the PathInfo for an Attribute name field names in functions (ie: sum(name) ) are tried to resolve ie: name from FIELDDESCRIPTOR , UPPER(name_test) from Criteria also resolve pathExpression adress.city or owner.konti.saldo
protected ClassDescriptor	getBaseClassDescriptor()
protected String	getColName(org.apache.ojb.broker.accesslayer.sql.SqlQueryStatement.TableAlias aTableAlias, SqlHelper.PathInfo aPathInfo, boolean translate) Answer the column name for alias and path info if translate try to convert attribute name into column name otherwise use attribute name if a FieldDescriptor is found for the attribute name the column name is taken from there prefixed with the alias (firstname -> A0.F_NAME).
protected FieldDescriptor	getFieldDescriptor(org.apache.ojb.broker.accesslayer.sql.SqlQueryStatement.TableAlias aTableAlias, SqlHelper.PathInfo aPathInfo) Get the FieldDescriptor for the PathInfo
protected byte	getJoinSyntaxType() Returns the joinSyntaxType.
protected HashMap	getJoinTreeToCriteria() Gets the joinTreeToCriteria.
protected Logger	getLogger() Returns the logger.
protected QueryByCriteria	getQuery() Gets the query.
protected org.apache.ojb.broker.accesslayer.sql.SqlQueryStatement.TableAlias	getRoot() Gets the root.
protected ClassDescriptor	getSearchClassDescriptor()
protected org.apache.ojb.broker.accesslayer.sql.SqlQueryStatement.TableAlias	getSearchTable() Gets the search table of this query.
String	getStatement() Answer the SELECT by primary key Sql for the Statement
protected org.apache.ojb.broker.accesslayer.sql.SqlQueryStatement.TableAlias	getTableAliasForClassDescriptor(ClassDescriptor aCld) Answer the TableAlias for ClassDescriptor.
protected void	setRoot(org.apache.ojb.broker.accesslayer.sql.SqlQueryStatement.TableAlias root) Sets the root.
protected void	splitCriteria() First reduce the Criteria to the normal disjunctive form, then calculate the necessary tree of joined tables for each item, then group items with the same tree of joined tables.

Methods inherited from class java.lang.Object

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

Field Detail

m_attrToFld

protected HashMap m_attrToFld

Constructor Detail

SqlQueryStatement

public SqlQueryStatement(Platform pf,
                         ClassDescriptor cld,
                         Query query,
                         Logger logger)

Constructor for SqlCriteriaStatement.

Parameters:

pf - the Platform

cld - the ClassDescriptor

query - the Query

logger - the Logger

SqlQueryStatement

public SqlQueryStatement(SqlQueryStatement parent,
                         Platform pf,
                         ClassDescriptor cld,
                         Query query,
                         Logger logger)

Constructor for SqlCriteriaStatement.

Parameters:

parent - the Parent Query

pf - the Platform

cld - the ClassDescriptor

query - the Query

logger - the Logger

Method Detail

getBaseClassDescriptor

protected ClassDescriptor getBaseClassDescriptor()

getSearchClassDescriptor

protected ClassDescriptor getSearchClassDescriptor()

getAttributeInfo

protected org.apache.ojb.broker.accesslayer.sql.SqlQueryStatement.AttributeInfo getAttributeInfo(String attr,
                                                                                                 boolean useOuterJoins,
                                                                                                 UserAlias aUserAlias,
                                                                                                 Map pathClasses)

Return the TableAlias and the PathInfo for an Attribute name
field names in functions (ie: sum(name) ) are tried to resolve ie: name from FIELDDESCRIPTOR , UPPER(name_test) from Criteria
also resolve pathExpression adress.city or owner.konti.saldo

Parameters:

attr -

useOuterJoins -

aUserAlias -

pathClasses -

Returns:

ColumnInfo

getColName

protected String getColName(org.apache.ojb.broker.accesslayer.sql.SqlQueryStatement.TableAlias aTableAlias,
                            SqlHelper.PathInfo aPathInfo,
                            boolean translate)

Answer the column name for alias and path info
if translate try to convert attribute name into column name otherwise use attribute name
if a FieldDescriptor is found for the attribute name the column name is taken from there prefixed with the alias (firstname -> A0.F_NAME).

appendColName

protected boolean appendColName(org.apache.ojb.broker.accesslayer.sql.SqlQueryStatement.TableAlias aTableAlias,
                                SqlHelper.PathInfo aPathInfo,
                                boolean translate,
                                StringBuffer buf)

Add the Column to the StringBuffer

Parameters:

aTableAlias -

aPathInfo -

translate - flag to indicate translation of pathInfo

buf -

Returns:

true if appended

getFieldDescriptor

protected FieldDescriptor getFieldDescriptor(org.apache.ojb.broker.accesslayer.sql.SqlQueryStatement.TableAlias aTableAlias,
                                             SqlHelper.PathInfo aPathInfo)

Get the FieldDescriptor for the PathInfo

Parameters:

aTableAlias -

aPathInfo -

Returns:

FieldDescriptor

appendColName

protected boolean appendColName(String attr,
                                boolean useOuterJoins,
                                UserAlias aUserAlias,
                                StringBuffer buf)

Append the appropriate ColumnName to the buffer
if a FIELDDESCRIPTOR is found for the Criteria the colName is taken from there otherwise its taken from Criteria.
field names in functions (ie: sum(name) ) are tried to resolve ie: name from FIELDDESCRIPTOR , UPPER(name_test) from Criteria
also resolve pathExpression adress.city or owner.konti.saldo

appendColName

protected boolean appendColName(String attr,
                                String attrAlias,
                                boolean useOuterJoins,
                                UserAlias aUserAlias,
                                StringBuffer buf)

Append the appropriate ColumnName to the buffer
if a FIELDDESCRIPTOR is found for the Criteria the colName is taken from there otherwise its taken from Criteria.
field names in functions (ie: sum(name) ) are tried to resolve ie: name from FIELDDESCRIPTOR , UPPER(name_test) from Criteria
also resolve pathExpression adress.city or owner.konti.saldo

ensureColumns

protected void ensureColumns(List columns,
                             List existingColumns)

Builds the Join for columns if they are not found among the existingColumns.

Parameters:

columns - the list of columns represented by Criteria.Field to ensure

existingColumns - the list of column names (String) that are already appended

ensureColumns

protected List ensureColumns(List columns,
                             List existingColumns,
                             StringBuffer buf)

Builds the Join for columns if they are not found among the existingColumns. These columns are added to the statement using a column-alias "ojb_col_x", x being the number of existing columns

Parameters:

columns - the list of columns represented by Criteria.Field to ensure

existingColumns - the list of column names (String) that are already appended

buf - the statement

Returns:

List of existingColumns including ojb_col_x

appendWhereClause

protected void appendWhereClause(StringBuffer where,
                                 Criteria crit,
                                 StringBuffer stmt)

appends a WHERE-clause to the Statement

Parameters:

where -

crit -

stmt -

appendHavingClause

protected void appendHavingClause(StringBuffer having,
                                  Criteria crit,
                                  StringBuffer stmt)

appends a HAVING-clause to the Statement

Parameters:

having -

crit -

stmt -

appendClause

protected void appendClause(StringBuffer clause,
                            Criteria crit,
                            StringBuffer stmt)

appends a WHERE/HAVING-clause to the Statement

Parameters:

clause -

crit -

stmt -

appendCriteria

protected void appendCriteria(org.apache.ojb.broker.accesslayer.sql.SqlQueryStatement.TableAlias alias,
                              SqlHelper.PathInfo pathInfo,
                              SelectionCriteria c,
                              StringBuffer buf)

Answer the SQL-Clause for a SelectionCriteria

Parameters:

alias -

pathInfo -

c - SelectionCriteria

buf -

appendSQLClause

protected void appendSQLClause(SelectionCriteria c,
                               StringBuffer buf)

Answer the SQL-Clause for a SelectionCriteria If the Criteria references a class with extents an OR-Clause is added for each extent

Parameters:

c - SelectionCriteria

getTableAliasForClassDescriptor

protected org.apache.ojb.broker.accesslayer.sql.SqlQueryStatement.TableAlias getTableAliasForClassDescriptor(ClassDescriptor aCld)

Answer the TableAlias for ClassDescriptor.

appendOrderByClause

protected void appendOrderByClause(List orderByFields,
                                   List selectedFields,
                                   StringBuffer buf)

Appends the ORDER BY clause for the Query.
If the orderByField is found in the list of selected fields it's index is added. Otherwise it's name is added.

Parameters:

orderByFields -

selectedFields - the names of the fields in the SELECT clause

buf -

appendGroupByClause

protected void appendGroupByClause(List groupByFields,
                                   StringBuffer buf)

Appends the GROUP BY clause for the Query

Parameters:

groupByFields -

buf -

appendTableWithJoins

protected void appendTableWithJoins(org.apache.ojb.broker.accesslayer.sql.SqlQueryStatement.TableAlias alias,
                                    StringBuffer where,
                                    StringBuffer buf)

Appends to the statement table and all tables joined to it.

Parameters:

alias - the table alias

where - append conditions for WHERE clause here

buildSuperJoinTree

protected void buildSuperJoinTree(org.apache.ojb.broker.accesslayer.sql.SqlQueryStatement.TableAlias left,
                                  ClassDescriptor cld,
                                  String name,
                                  boolean useOuterJoin)

build the Join-Information if a super reference exists

Parameters:

left -

cld -

name -

splitCriteria

protected void splitCriteria()

First reduce the Criteria to the normal disjunctive form, then calculate the necessary tree of joined tables for each item, then group items with the same tree of joined tables.

getQuery

protected QueryByCriteria getQuery()

Gets the query.

Returns:

Returns a Query

getRoot

protected org.apache.ojb.broker.accesslayer.sql.SqlQueryStatement.TableAlias getRoot()

Gets the root.

Returns:

Returns a TableAlias

setRoot

protected void setRoot(org.apache.ojb.broker.accesslayer.sql.SqlQueryStatement.TableAlias root)

Sets the root.

Parameters:

root - The root to set

getSearchTable

protected org.apache.ojb.broker.accesslayer.sql.SqlQueryStatement.TableAlias getSearchTable()

Gets the search table of this query.

Returns:

Returns a TableAlias

getJoinTreeToCriteria

protected HashMap getJoinTreeToCriteria()

Gets the joinTreeToCriteria.

Returns:

Returns a HashMap

getJoinSyntaxType

protected byte getJoinSyntaxType()

Returns the joinSyntaxType.

Returns:

byte

getLogger

protected Logger getLogger()

Returns the logger.

Returns:

Logger

getStatement

public String getStatement()

Description copied from interface: SqlStatement

Answer the SELECT by primary key Sql for the Statement

Specified by:

getStatement in interface SqlStatement

buildStatement

protected abstract String buildStatement()

Build the SQL String.

Returns:

SQL String