Module org.jooq

Package org.jooq.impl

Class XMLasDOMBinding

java.lang.Object

org.jooq.impl.XMLasDOMBinding

All Implemented Interfaces:

Serializable, Binding<XML,Node>

public class XMLasDOMBinding
extends Object

A binding that binds Node types to SQLXML types from your database.

Author:

Lukas Eder

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
XMLasDOMBinding()

Method Summary

Modifier and Type	Method	Description
static DocumentBuilder	builder()	Get a namespace-aware document builder
final Converter<XML,Node>	converter()	A converter that can convert between the database type and the custom type.
static Document	fromString(String name)	Create a new DOM element in an independent document
final void	get(BindingGetResultSetContext<Node> ctx)	Get a ResultSet's OUT value.
final void	get(BindingGetSQLInputContext<Node> ctx)	Get a SQLInput's OUT value.
final void	get(BindingGetStatementContext<Node> ctx)	Get a CallableStatement's OUT value.
final void	register(BindingRegisterContext<Node> ctx)	Register a CallableStatement's OUT parameter.
final void	set(BindingSetSQLOutputContext<Node> ctx)	Set a SQLOutput's IN parameter.
final void	set(BindingSetStatementContext<Node> ctx)	Set a PreparedStatement's IN parameter.
final void	sql(BindingSQLContext<Node> ctx)	Generate SQL code for the bind variable.

Methods inherited from class java.lang.Object

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

Constructor Details

XMLasDOMBinding

public XMLasDOMBinding()

Method Details

converter

public final Converter<XML,Node> converter()

Description copied from interface: Binding

A converter that can convert between the database type and the custom type.

While the Converter property of a binding is not optional (Converter.fromType() and Converter.toType() are needed by jOOQ's internals), the conversion implementation (i.e. Converter.from(Object) and Converter.to(Object)) isn't strictly required if implementations don't rely on it. If these conversion implementations are non-functional, it is advised to hint at this fact in Converter.fromSupported() and Converter.toSupported().

fromString

public static Document fromString(String name)

Create a new DOM element in an independent document

builder

public static DocumentBuilder builder()

Get a namespace-aware document builder

sql

public final void sql(BindingSQLContext<Node> ctx)
               throws SQLException

Description copied from interface: Binding

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.
  
  Context.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.
  
  Context.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 Binding.sql(BindingSQLContext) and Binding.set(BindingSetStatementContext), i.e. when bind variables are inlined, then they must not be bound to the PreparedStatement in Binding.set(BindingSetStatementContext)

Specified by:

sql in interface Binding<XML,T>

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.

register

public final void register(BindingRegisterContext<Node> ctx)
                    throws SQLException

Description copied from interface: Binding

Register a CallableStatement's OUT parameter.

Specified by:

register in interface Binding<XML,T>

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 final void set(BindingSetStatementContext<Node> ctx)
               throws SQLException

Description copied from interface: Binding

Set a PreparedStatement's IN parameter.

Specified by:

set in interface Binding<XML,T>

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 final void get(BindingGetResultSetContext<Node> ctx)
               throws SQLException

Description copied from interface: Binding

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.

Specified by:

get in interface Binding<XML,T>

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 final void get(BindingGetStatementContext<Node> 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<XML,T>

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 final void set(BindingSetSQLOutputContext<Node> ctx)
               throws SQLException

Description copied from interface: Binding

Set a SQLOutput's IN parameter.

Specified by:

set in interface Binding<XML,T>

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 final void get(BindingGetSQLInputContext<Node> 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<XML,T>

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.