com.healthmarketscience.sqlbuilder

Class BaseCreateQuery<ThisType extends BaseCreateQuery<ThisType>>

java.lang.Object

com.healthmarketscience.common.util.AppendeeObject

com.healthmarketscience.sqlbuilder.SqlObject

com.healthmarketscience.sqlbuilder.CustomizableSqlObject

com.healthmarketscience.sqlbuilder.Query<ThisType>

com.healthmarketscience.sqlbuilder.BaseCreateQuery<ThisType>

All Implemented Interfaces:

Appendee, Verifiable<ThisType>

Direct Known Subclasses:

CreateIndexQuery, CreateTableQuery, CreateViewQuery

public abstract class BaseCreateQuery<ThisType extends BaseCreateQuery<ThisType>>
extends Query<ThisType>

Query which generates a CREATE statement.

Author:

James Ahlborn

Field Summary

Fields

Modifier and Type	Field and Description
protected SqlObjectList<SqlObject>	_columns
protected SqlObject	_object

Fields inherited from class com.healthmarketscience.sqlbuilder.SqlObject

ALL_SYMBOL, NULL_VALUE, QUESTION_MARK

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseCreateQuery(SqlObject objectStr)

Method Summary

Modifier and Type	Method and Description
ThisType	addColumns(Column... columns) Adds column descriptions for the given Columns.
abstract ThisType	addCustomColumns(Object... typedColumnStrs) Adds the given SqlObjects as column descriptions, according to the subclass type.
protected void	collectSchemaObjects(ValidationContext vContext) Used during Query.validate() calls to collect the dbschema objects referenced in a query.
abstract DropQuery	getDropQuery()
ThisType	setCustomName(Object name) Sets the name of the object being created.
ThisType	setName(String name) Sets the name of the object being created.
void	validate(ValidationContext vContext) Runs validation on this verifiable object using a previously collected ValidationContext.

Methods inherited from class com.healthmarketscience.sqlbuilder.Query

appendTo, appendTo, getThisType, prependTo, validate, validateTables

Methods inherited from class com.healthmarketscience.sqlbuilder.CustomizableSqlObject

addCustomization, customAppendTo, customAppendTo, maybeAppendTo, maybeAppendTo

Methods inherited from class com.healthmarketscience.sqlbuilder.SqlObject

collectSchemaObjects, doValidate, toString

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

toString, toString

Methods inherited from class java.lang.Object

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

Field Detail

_object

protected SqlObject _object

_columns

protected SqlObjectList<SqlObject> _columns

Constructor Detail

BaseCreateQuery

protected BaseCreateQuery(SqlObject objectStr)

Method Detail

setName

public ThisType setName(String name)

Sets the name of the object being created.

setCustomName

public ThisType setCustomName(Object name)

Sets the name of the object being created.

Object -> SqlObject conversions handled by Converter.toCustomSqlObject(Object).

addColumns

public ThisType addColumns(Column... columns)

Adds column descriptions for the given Columns.

collectSchemaObjects

protected void collectSchemaObjects(ValidationContext vContext)

Description copied from class: SqlObject

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.

Overrides:

collectSchemaObjects in class Query<ThisType extends BaseCreateQuery<ThisType>>

Parameters:

vContext - handle to the current validation context

validate

public void validate(ValidationContext vContext)
              throws ValidationException

Description copied from interface: Verifiable

Runs validation on this verifiable object using a previously collected ValidationContext.

In general, this method will only be called internally, not by users.

Specified by:

validate in interface Verifiable<ThisType extends BaseCreateQuery<ThisType>>

Overrides:

validate in class Query<ThisType extends BaseCreateQuery<ThisType>>

Parameters:

vContext - handle to the current, filled-in validation context

Throws:

ValidationException

addCustomColumns

public abstract ThisType addCustomColumns(Object... typedColumnStrs)

Adds the given SqlObjects as column descriptions, according to the subclass type.

getDropQuery

public abstract DropQuery getDropQuery()

Returns:

a DropQuery for the object which would be created by this create query.