CustomQueryPart (jOOQ 3.6.4 API)

java.lang.Object
- org.jooq.impl.CustomQueryPart

All Implemented Interfaces:

java.io.Serializable, QueryPart, QueryPartInternal
```
public abstract class CustomQueryPart
extends java.lang.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()

Constructors
Modifier	Constructor and Description
`protected`	`CustomQueryPart()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`accept(Context<?> ctx)` Subclasses may implement this method.
`void`	`bind(BindContext context)` Deprecated. - 3.4.0 - [#2694] - Use `accept(Context)` instead.
`Clause[]`	`clauses(Context<?> ctx)` The `Clause`s that are represented by this query part.
`protected DSLContext`	`create()` Internal convenience method
`protected DSLContext`	`create(Configuration configuration)` Internal convenience method
`protected DSLContext`	`create(Context<?> ctx)` Internal convenience method
`boolean`	`declaresCTE()` Subclasses may override this
`boolean`	`declaresFields()` Subclasses may override this
`boolean`	`declaresTables()` Subclasses may override this
`boolean`	`declaresWindows()` Subclasses may override this
`boolean`	`equals(java.lang.Object that)` Check whether this `QueryPart` can be considered equal to another `QueryPart`.
`int`	`hashCode()` Generate a hash code from this `QueryPart`.
`void`	`toSQL(RenderContext context)` Deprecated. - 3.4.0 - [#2694] - Use `accept(Context)` instead.
`java.lang.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(java.lang.String sql, java.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
```
@Deprecated
public void toSQL(RenderContext context)
```
    Deprecated. - 3.4.0 - [#2694] - Use accept(Context) instead.
    
    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.
    
    Specified by:
    
    toSQL in interface QueryPartInternal
  - accept
```
public void accept(Context<?> ctx)
```
    Subclasses may implement this method.
    This QueryPart can accept a Context object in order to render a SQL string or to bind its variables.
    
    Specified by:
    
    accept in interface QueryPartInternal
  - bind
```
@Deprecated
public void bind(BindContext context)
                       throws DataAccessException
```
    Deprecated. - 3.4.0 - [#2694] - Use accept(Context) instead.
    
    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
    
    Specified by:
    
    bind in interface QueryPartInternal
    
    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
  - declaresWindows
```
public boolean declaresWindows()
```
    Subclasses may override this
    
    Specified by:
    
    declaresWindows in interface QueryPartInternal
  - declaresCTE
```
public boolean declaresCTE()
```
    Subclasses may override this
    
    Specified by:
    
    declaresCTE in interface QueryPartInternal
  - equals
```
public boolean equals(java.lang.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 java.lang.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 java.lang.Object
    
    Returns:
    
    The QueryPart hash code
  - toString
```
public java.lang.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 java.lang.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(Context<?> ctx)
```
    Internal convenience method
  - translate
```
protected final DataAccessException translate(java.lang.String sql,
                                              java.sql.SQLException e)
```
    Internal convenience method

Class CustomQueryPart

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CustomQueryPart

Method Detail

toSQL

accept

bind

clauses

declaresFields

declaresTables

declaresWindows

declaresCTE

equals

hashCode

toString

create

create

create

translate