Top Constructors Methods
org.jooq.impl

pack-priv abstract Class AbstractXMLBinding<T>

extends Object
implements Binding<XML, T>
Class Inheritance
All Implemented Interfaces
org.jooq.Binding, java.io.Serializable
Known Direct Subclasses
org.jooq.impl.XMLasDOMBinding, org.jooq.impl.AbstractXMLasObjectBinding
Static Imports
org.jooq.XML.xml, .XML.xmlOrNull, org.jooq.tools.Convert.convert
Author
Lukas Eder

Constructor Summary

AccessConstructor and Description
pack-priv
AbstractXMLBinding()

Method Summary

Modifier and TypeMethod and Description
public final void
get(BindingGetResultSetContext<T>
The context object containing all argument objects.
ctx)

Implements org.jooq.Binding.get.

Get a ResultSet's OUT value.
public final void
get(BindingGetStatementContext<T>
The context object containing all argument objects.
ctx)

Implements org.jooq.Binding.get.

Get a CallableStatement's OUT value.
public final void
get(BindingGetSQLInputContext<T>
The context object containing all argument objects.
ctx)

Implements org.jooq.Binding.get.

Get a SQLInput's OUT value.
public final void
register(BindingRegisterContext<T>
The context object containing all argument objects.
ctx)

Implements org.jooq.Binding.register.

Register a CallableStatement's OUT parameter.
public final void
set(BindingSetStatementContext<T>
The context object containing all argument objects.
ctx)

Implements org.jooq.Binding.set.

Set a PreparedStatement's IN parameter.
public final void
set(BindingSetSQLOutputContext<T>
The context object containing all argument objects.
ctx)

Implements org.jooq.Binding.set.

Set a SQLOutput's IN parameter.
public final void
sql(BindingSQLContext<T>
The context object containing all argument objects.
ctx)

Implements org.jooq.Binding.sql.

Generate SQL code for the bind variable.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

AbstractXMLBindingback to summary
pack-priv AbstractXMLBinding()

Method Detail

getback to summary
public final void get(BindingGetResultSetContext<T> ctx) throws SQLException

Implements org.jooq.Binding.get.

Doc from org.jooq.Binding.get.

Get a ResultSet's OUT value.

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

Parameters
ctx:BindingGetResultSetContext<T>

The context object containing all argument objects.

Annotations
@Override
Exceptions
SQLException:
Implementations are allowed to pass on all SQLExceptions to the caller to be wrapped in DataAccessExceptions.
getback to summary
public final void get(BindingGetStatementContext<T> ctx) throws SQLException

Implements org.jooq.Binding.get.

Doc from org.jooq.Binding.get.

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.

Parameters
ctx:BindingGetStatementContext<T>

The context object containing all argument objects.

Annotations
@Override
Exceptions
SQLException:
Implementations are allowed to pass on all SQLExceptions to the caller to be wrapped in DataAccessExceptions.
getback to summary
public final void get(BindingGetSQLInputContext<T> ctx) throws SQLException

Implements org.jooq.Binding.get.

Doc from org.jooq.Binding.get.

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.

Parameters
ctx:BindingGetSQLInputContext<T>

The context object containing all argument objects.

Annotations
@Override
Exceptions
SQLException:
Implementations are allowed to pass on all SQLExceptions to the caller to be wrapped in DataAccessExceptions.
registerback to summary
public final void register(BindingRegisterContext<T> ctx) throws SQLException

Implements org.jooq.Binding.register.

Doc from org.jooq.Binding.register.

Register a CallableStatement's OUT parameter.

Parameters
ctx:BindingRegisterContext<T>

The context object containing all argument objects.

Annotations
@Override
Exceptions
SQLException:
Implementations are allowed to pass on all SQLExceptions to the caller to be wrapped in DataAccessExceptions.
setback to summary
public final void set(BindingSetStatementContext<T> ctx) throws SQLException

Implements org.jooq.Binding.set.

Doc from org.jooq.Binding.set.

Set a PreparedStatement's IN parameter.

Parameters
ctx:BindingSetStatementContext<T>

The context object containing all argument objects.

Annotations
@Override
Exceptions
SQLException:
Implementations are allowed to pass on all SQLExceptions to the caller to be wrapped in DataAccessExceptions.
setback to summary
public final void set(BindingSetSQLOutputContext<T> ctx) throws SQLException

Implements org.jooq.Binding.set.

Doc from org.jooq.Binding.set.

Set a SQLOutput's IN parameter.

Parameters
ctx:BindingSetSQLOutputContext<T>

The context object containing all argument objects.

Annotations
@Override
Exceptions
SQLException:
Implementations are allowed to pass on all SQLExceptions to the caller to be wrapped in DataAccessExceptions.
sqlback to summary
public final void sql(BindingSQLContext<T> ctx) throws SQLException

Implements org.jooq.Binding.sql.

Doc from org.jooq.Binding.sql.

Generate SQL code for the bind variable.

Implementations should generate SQL code onto BindingSQLContext#render(), given the context's bind variable located at BindingSQLContext#value(). Examples of such SQL code are:

  • "?": Default implementations can simply generate a question mark.

  • "123": Implementations may choose to inline bind variables to influence execution plan generation.

    RenderContext#paramType() contains information whether inlined bind variables are expected in the current context.

  • "CAST(? AS DATE)": Cast a database to a more specific type. This can be useful in databases like Oracle, which map both DATE and TIMESTAMP SQL types to Timestamp.

    RenderContext#castMode() may contain some hints about whether casting is suggested in the current context.

  • "?::json": Vendor-specific bind variables can be supported, e.g. SQLDialect#POSTGRES's JSON data type.

Implementations must provide consistent behaviour between sql(BindingSQLContext) and set(BindingSetStatementContext), i.e. when bind variables are inlined, then they must not be bound to the PreparedStatement in set(BindingSetStatementContext)

Parameters
ctx:BindingSQLContext<T>

The context object containing all argument objects.

Annotations
@Override
Exceptions
SQLException:
Implementations are allowed to pass on all SQLExceptions to the caller to be wrapped in DataAccessExceptions.