com.healthmarketscience.sqlbuilder.custom.postgresql

Class PgLimitClause

java.lang.Object

com.healthmarketscience.common.util.AppendeeObject

com.healthmarketscience.sqlbuilder.SqlObject

com.healthmarketscience.sqlbuilder.custom.CustomSyntax

com.healthmarketscience.sqlbuilder.custom.postgresql.PgLimitClause

All Implemented Interfaces:

Appendee, Verifiable<PgLimitClause>

public class PgLimitClause
extends CustomSyntax
implements Verifiable<PgLimitClause>

Appends a PostgreSQL limit clause like " LIMIT <limit>" for use in SelectQuerys.

Author:

James Ahlborn

See Also:

SelectQuery.addCustomization(CustomSyntax)

Field Summary

Fields inherited from class com.healthmarketscience.sqlbuilder.SqlObject

ALL_SYMBOL, NULL_VALUE, QUESTION_MARK

Constructor Summary

Constructors

Constructor and Description
PgLimitClause(Object value)

Method Summary

Modifier and Type	Method and Description
void	appendTo(AppendableExt app) Appends this object to the given AppendableExt.
void	apply(SelectQuery query) Called by SelectQuery.addCustomization(CustomSyntax) to add this custom syntax to the appropriate location in the SelectQuery.
protected void	collectSchemaObjects(ValidationContext vContext) Used during Query.validate() calls to collect the dbschema objects referenced in a query.
PgLimitClause	validate() Runs validation on this verifiable object.
void	validate(ValidationContext vContext) Runs validation on this verifiable object using a previously collected ValidationContext.

Methods inherited from class com.healthmarketscience.sqlbuilder.custom.CustomSyntax

apply, apply

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

Constructor Detail

PgLimitClause

public PgLimitClause(Object value)

Method Detail

apply

public void apply(SelectQuery query)

Description copied from class: CustomSyntax

Called by SelectQuery.addCustomization(CustomSyntax) to add this custom syntax to the appropriate location in the SelectQuery.

Overrides:

apply in class CustomSyntax

appendTo

public void appendTo(AppendableExt app)
              throws IOException

Description copied from interface: Appendee

Appends this object to the given AppendableExt. Called by an AppendableExt when a request is made to append an instance of Appendee.

Specified by:

appendTo in interface Appendee

Overrides:

appendTo in class AppendeeObject

Parameters:

app - the AppendableExt to which this class should append itself

Throws:

IOException - if the append fails

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.

Specified by:

collectSchemaObjects in class SqlObject

Parameters:

vContext - handle to the current validation context

validate

public final PgLimitClause validate()
                             throws ValidationException

Description copied from interface: Verifiable

Runs validation on this verifiable object.

Specified by:

validate in interface Verifiable<PgLimitClause>

Returns:

a handle to this instance

Throws:

ValidationException

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<PgLimitClause>

Parameters:

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

Throws:

ValidationException