Module org.jooq

Package org.jooq.impl

Class AbstractBinding<T,U>

java.lang.Object

org.jooq.impl.AbstractBinding<T,U>

All Implemented Interfaces:

Serializable, Binding<T,U>

public abstract class AbstractBinding<T,U>
extends Object
implements Binding<T,U>

A convenient base implementation for custom bindings, simplifies the implementation.

The simplification is provided by offering empty implementations for rarely used methods, such as those for stored procedure OUT parameter support:

• register(BindingRegisterContext) to register the OUT parameter.
• get(BindingGetStatementContext) to read the OUT parameter.

or SQLData serialisation support (e.g. for Oracle user defined types):

• set(BindingSetSQLOutputContext) to serialise a user defined type.
• get(BindingGetSQLInputContext) to read a user defined type.

Author:

Lukas Eder

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AbstractBinding()

Method Summary

Modifier and Type	Method	Description
void	get(BindingGetSQLInputContext<U> ctx)	Get a SQLInput's OUT value.
void	get(BindingGetStatementContext<U> ctx)	Get a CallableStatement's OUT value.
void	register(BindingRegisterContext<U> ctx)	Register a CallableStatement's OUT parameter.
void	set(BindingSetSQLOutputContext<U> ctx)	Set a SQLOutput's IN parameter.
void	sql(BindingSQLContext<U> ctx)	A convenient base implementation that handles the ParamType setting and delegates to sqlInline(BindingSQLContext) or sqlBind(BindingSQLContext) respectively.
protected void	sqlBind(BindingSQLContext<U> ctx)	Generate the SQL string for a bind variable placeholder.
protected void	sqlInline(BindingSQLContext<U> ctx)	Generate the SQL string for inline values.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jooq.Binding

converter, get, set

Constructor Details

AbstractBinding

public AbstractBinding()

Method Details

sql

public void sql(BindingSQLContext<U> ctx)
         throws SQLException

A convenient base implementation that handles the ParamType setting and delegates to sqlInline(BindingSQLContext) or sqlBind(BindingSQLContext) respectively.

Specified by:

sql in interface Binding<T,U>

Parameters:

ctx - The context object containing all argument objects.

Throws:

SQLException - Implementations are allowed to pass on all SQLExceptions to the caller to be wrapped in DataAccessExceptions.

sqlInline

protected void sqlInline(BindingSQLContext<U> ctx)
                  throws SQLException

Generate the SQL string for inline values.

The default implementation generates a string literal representation of the user defined value. Custom implementations may want to override this.

Throws:

SQLException

sqlBind

protected void sqlBind(BindingSQLContext<U> ctx)
                throws SQLException

Generate the SQL string for a bind variable placeholder.

In almost all cases, this can just be a "?" string. In some cases, the placeholder needs to be cast to a vendor specific data type, such as in PostgreSQL, "?::tsvector".

Throws:

SQLException

register

public void register(BindingRegisterContext<U> ctx)
              throws SQLException

Description copied from interface: Binding

Register a CallableStatement's OUT parameter.

Specified by:

register in interface Binding<T,U>

Parameters:

ctx - The context object containing all argument objects.

Throws:

SQLException - Implementations are allowed to pass on all SQLExceptions to the caller to be wrapped in DataAccessExceptions.

get

public void get(BindingGetStatementContext<U> ctx)
         throws SQLException

Description copied from interface: Binding

Get a CallableStatement's OUT value.

Implementations are expected to produce a value by calling BindingGetStatementContext.value(Object), passing the resulting value to the method.

Specified by:

get in interface Binding<T,U>

Parameters:

ctx - The context object containing all argument objects.

Throws:

SQLException - Implementations are allowed to pass on all SQLExceptions to the caller to be wrapped in DataAccessExceptions.

set

public void set(BindingSetSQLOutputContext<U> ctx)
         throws SQLException

Description copied from interface: Binding

Set a SQLOutput's IN parameter.

Specified by:

set in interface Binding<T,U>

Parameters:

ctx - The context object containing all argument objects.

Throws:

SQLException - Implementations are allowed to pass on all SQLExceptions to the caller to be wrapped in DataAccessExceptions.

get

public void get(BindingGetSQLInputContext<U> ctx)
         throws SQLException

Description copied from interface: Binding

Get a SQLInput's OUT value.

Implementations are expected to produce a value by calling BindingGetSQLInputContext.value(Object), passing the resulting value to the method.

Specified by:

get in interface Binding<T,U>

Parameters:

ctx - The context object containing all argument objects.

Throws:

SQLException - Implementations are allowed to pass on all SQLExceptions to the caller to be wrapped in DataAccessExceptions.