com.healthmarketscience.sqlbuilder

Class SqlObject

java.lang.Object

com.healthmarketscience.common.util.AppendeeObject

com.healthmarketscience.sqlbuilder.SqlObject

All Implemented Interfaces:

Appendee

Direct Known Subclasses:

AliasedObject, AlterTableQuery.AddColumnAction, AlterTableQuery.AddConstraintAction, BaseGrantQuery.Privilege, BaseGrantQuery.TargetObject, Comment, CommonTableExpression, Condition, ConstraintClause, CustomizableSqlObject, CustomSql, CustomSyntax, Expression, OrderObject, QueryPreparer.PlaceHolder, QueryReader.Column, SqlObjectList, WindowDefinitionClause, WindowDefinitionClause.FrameBound

public abstract class SqlObject
extends AppendeeObject

Base object which all classes in this facility extend. It is an AppendeeObject so that the statement building can happen efficiently using the AppendeeObject.appendTo(com.healthmarketscience.common.util.AppendableExt) calls. Additionally, there is a collectSchemaObjects(com.healthmarketscience.sqlbuilder.SqlObject, com.healthmarketscience.sqlbuilder.ValidationContext) method which is used for validation (more details in the method comment).

Author:

James Ahlborn

Field Summary

Fields

Modifier and Type	Field and Description
static SqlObject	ALL_SYMBOL SqlObject which represents a * string for generating "SELECT *" statements.
static SqlObject	NULL_VALUE SqlObject which represents a NULL value string
static SqlObject	QUESTION_MARK SqlObject which represents a ? string for generating prepared statements.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SqlObject()

Method Summary

Modifier and Type	Method and Description
static void	collectSchemaObjects(SqlObject obj, ValidationContext vContext) Utility method for classes which may not be in this package to invoke collectSchemaObjects(ValidationContext) on a SqlObject.
protected abstract void	collectSchemaObjects(ValidationContext vContext) Used during Query.validate() calls to collect the dbschema objects referenced in a query.
protected void	doValidate() Utility method for implementing the Verifiable.validate() method.
String	toString(int size, SqlContext context) Creates a SQL string from this object using the given initial size for the AppendableExt buffer and the given SqlContext.

Methods inherited from class com.healthmarketscience.common.util.AppendeeObject

appendTo, toString, toString

Methods inherited from class java.lang.Object

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

Field Detail

QUESTION_MARK

public static final SqlObject QUESTION_MARK

SqlObject which represents a ? string for generating prepared statements.

ALL_SYMBOL

public static final SqlObject ALL_SYMBOL

SqlObject which represents a * string for generating "SELECT *" statements.

NULL_VALUE

public static final SqlObject NULL_VALUE

SqlObject which represents a NULL value string

Constructor Detail

SqlObject

protected SqlObject()

Method Detail

toString

public String toString(int size,
                       SqlContext context)

Creates a SQL string from this object using the given initial size for the AppendableExt buffer and the given SqlContext. Useful for introducing custom contexts or context settings to the SQL generation.

Parameters:

size - initial size of the output buffer

context - optional custom SqlContext for the SQL generation

Returns:

the generated SQL query

doValidate

protected void doValidate()
                   throws ValidationException

Utility method for implementing the Verifiable.validate() method.

Throws:

ValidationException

collectSchemaObjects

public static void collectSchemaObjects(SqlObject obj,
                                        ValidationContext vContext)

Utility method for classes which may not be in this package to invoke collectSchemaObjects(ValidationContext) on a SqlObject.

Parameters:

obj - relevant sql object, may be null

vContext - current ValidationContext

collectSchemaObjects

protected abstract void collectSchemaObjects(ValidationContext vContext)

Used during Query.validate() calls to collect the dbschema objects referenced in a query. Any subclass of this class should add all referenced tables and columns to the appropriate collections.

Parameters:

vContext - handle to the current validation context