org.jooq.impl

Class CustomQueryPart

java.lang.Object

org.jooq.impl.CustomQueryPart

All Implemented Interfaces:

Serializable, QueryPart, QueryPartInternal

public abstract class CustomQueryPart
extends Object

A base class for custom QueryPart implementations in client code.

Client code may provide proper QueryPart implementations extending this useful base class. All necessary parts of the QueryPart interface are already implemented. Only these two methods need further implementation:

• toSQL(org.jooq.RenderContext)
• bind(org.jooq.BindContext)

Refer to those methods' Javadoc for further details about their expected behaviour.

Such custom QueryPart implementations can be useful in any of these scenarios:

• When reusing a custom QueryPart in other custom QueryParts, e.g. in CustomCondition, CustomField, CustomTable, etc.
• When inlining a custom QueryPart in plain SQL methods, such as DSL.condition(String, QueryPart...), DSL.field(String, QueryPart...), DSL.table(String, QueryPart...)

Author:

Lukas Eder

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CustomQueryPart()

Method Summary

Methods

Modifier and Type	Method and Description
void	bind(BindContext context) Subclasses may implement this method Bind all parameters of this QueryPart to a PreparedStatement This method is for JOOQ INTERNAL USE only.
Clause[]	clauses(Context<?> ctx) The Clauses that are represented by this query part.
protected DSLContext	create() Internal convenience method
protected DSLContext	create(BindContext ctx) Internal convenience method
protected DSLContext	create(Configuration configuration) Internal convenience method
protected DSLContext	create(RenderContext ctx) Internal convenience method
boolean	declaresFields() Subclasses may override this
boolean	declaresTables() Subclasses may override this
boolean	equals(Object that) Check whether this QueryPart can be considered equal to another QueryPart.
int	hashCode() Generate a hash code from this QueryPart.
abstract void	toSQL(RenderContext context) Subclasses must implement this method Render this QueryPart to a SQL string contained in context.sql().
String	toString() Render a SQL string of this QueryPart For improved debugging, this renders a SQL string of this QueryPart with inlined bind variables.
protected DataAccessException	translate(String sql, SQLException e) Internal convenience method

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CustomQueryPart

protected CustomQueryPart()

Method Detail

toSQL

public abstract void toSQL(RenderContext context)

Subclasses must implement this method Render this QueryPart to a SQL string contained in context.sql(). The context will contain additional information about how to render this QueryPart, e.g. whether this QueryPart should be rendered as a declaration or reference, whether this QueryPart's contained bind variables should be inlined or replaced by '?', etc.

bind

public void bind(BindContext context)
          throws DataAccessException

Subclasses may implement this method Bind all parameters of this QueryPart to a PreparedStatement

This method is for JOOQ INTERNAL USE only. Do not reference directly

Parameters:

context - The context holding the next bind index and other information for variable binding

Throws:

DataAccessException - If something went wrong while binding a variable

clauses

public final Clause[] clauses(Context<?> ctx)

Description copied from interface: QueryPartInternal

The Clauses that are represented by this query part.

QueryParts can specify several Clauses for which an event will be emitted before (in forward order) and after (in reverse order) visiting the the query part through Context.visit(QueryPart)

This method is for JOOQ INTERNAL USE only. Do not reference directly

Returns:

The Clauses represented by this query part or null or an empty array if this query part does not represent a clause.

declaresFields

public final boolean declaresFields()

Subclasses may override this

Specified by:

declaresFields in interface QueryPartInternal

declaresTables

public final boolean declaresTables()

Subclasses may override this

Specified by:

declaresTables in interface QueryPartInternal

equals

public boolean equals(Object that)

Description copied from interface: QueryPart

Check whether this QueryPart can be considered equal to another QueryPart.

In general, QueryPart equality is defined in terms of QueryPart.toString() equality. In other words, two query parts are considered equal if their rendered SQL (with inlined bind variables) is equal. This means that the two query parts do not necessarily have to be of the same type.

Some QueryPart implementations may choose to override this behaviour for improved performance, as QueryPart.toString() is an expensive operation, if called many times.

Specified by:

equals in interface QueryPart

Overrides:

equals in class Object

Parameters:

that - The other QueryPart

Returns:

Whether the two query parts are equal

hashCode

public int hashCode()

Description copied from interface: QueryPart

Generate a hash code from this QueryPart.

In general, QueryPart hash codes are the same as the hash codes generated from QueryPart.toString(). This guarantees consistent behaviour with QueryPart.equals(Object)

Some QueryPart implementations may choose to override this behaviour for improved performance, as QueryPart.toString() is an expensive operation, if called many times.

Specified by:

hashCode in interface QueryPart

Overrides:

hashCode in class Object

Returns:

The QueryPart hash code

toString

public String toString()

Description copied from interface: QueryPart

Render a SQL string of this QueryPart

For improved debugging, this renders a SQL string of this QueryPart with inlined bind variables. If you wish to gain more control over the concrete SQL rendering of this QueryPart, use DSLContext.renderContext() to obtain a configurable render context for SQL rendering.

Specified by:

toString in interface QueryPart

Overrides:

toString in class Object

Returns:

A SQL string representation of this QueryPart

create

protected final DSLContext create()

Internal convenience method

create

protected final DSLContext create(Configuration configuration)

Internal convenience method

create

protected final DSLContext create(RenderContext ctx)

Internal convenience method

create

protected final DSLContext create(BindContext ctx)

Internal convenience method

translate

protected final DataAccessException translate(String sql,
                            SQLException e)

Internal convenience method