org.jooq.impl

Class AbstractRoutine<T>

java.lang.Object

org.jooq.impl.AbstractRoutine<T>

All Implemented Interfaces:

Serializable, Attachable, AttachableInternal, QueryPart, QueryPartInternal, Routine<T>

public abstract class AbstractRoutine<T>
extends Object
implements Routine<T>, AttachableInternal

A common base class for stored procedures

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

Author:

Lukas Eder

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRoutine(String name, Schema schema)
protected	AbstractRoutine(String name, Schema schema, DataType<T> type)
protected	AbstractRoutine(String name, Schema schema, DataType<X> type, Binding<X,T> binding)
protected	AbstractRoutine(String name, Schema schema, DataType<X> type, Converter<X,T> converter)
protected	AbstractRoutine(String name, Schema schema, DataType<X> type, Converter<Y,T> converter, Binding<X,Y> binding)
protected	AbstractRoutine(String name, Schema schema, Package pkg)
protected	AbstractRoutine(String name, Schema schema, Package pkg, DataType<T> type)
protected	AbstractRoutine(String name, Schema schema, Package pkg, DataType<X> type, Binding<X,T> binding)
protected	AbstractRoutine(String name, Schema schema, Package pkg, DataType<X> type, Converter<X,T> converter)
protected	AbstractRoutine(String name, Schema schema, Package pkg, DataType<X> type, Converter<Y,T> converter, Binding<X,Y> binding)

Method Summary

Modifier and Type	Method and Description
void	accept(Context<?> ctx) This QueryPart can accept a Context object in order to render a SQL string or to bind its variables.
protected void	addInOutParameter(Parameter<?> parameter)
protected void	addInParameter(Parameter<?> parameter)
protected void	addOutParameter(Parameter<?> parameter)
AggregateFunction<T>	asAggregateFunction()
Field<T>	asField()
Field<T>	asField(String alias)
void	attach(Configuration c) Attach this object to a new Configuration.
void	bind(BindContext ctx) Deprecated.
Clause[]	clauses(Context<?> ctx) The Clauses that are represented by this query part.
Configuration	configuration() Get the underlying configuration
protected DSLContext	create() Internal convenience method
protected DSLContext	create(Configuration configuration) Internal convenience method
protected DSLContext	create(Context<?> ctx) Internal convenience method
protected static <T> Parameter<T>	createParameter(String name, DataType<T> type) Subclasses may call this method to create UDTField objects that are linked to this table.
protected static <T> Parameter<T>	createParameter(String name, DataType<T> type, boolean isDefaulted) Subclasses may call this method to create UDTField objects that are linked to this table.
protected static <T,U> Parameter<U>	createParameter(String name, DataType<T> type, boolean isDefaulted, Binding<T,U> binding) Subclasses may call this method to create UDTField objects that are linked to this table.
protected static <T,U> Parameter<U>	createParameter(String name, DataType<T> type, boolean isDefaulted, Converter<T,U> converter) Subclasses may call this method to create UDTField objects that are linked to this table.
protected static <T,X,U> Parameter<U>	createParameter(String name, DataType<T> type, boolean isDefaulted, Converter<X,U> converter, Binding<T,X> binding) Subclasses may call this method to create UDTField objects that are linked to this table.
boolean	declaresCTE() Subclasses may override this
boolean	declaresFields() Subclasses may override this
boolean	declaresTables() Subclasses may override this
boolean	declaresWindows() Subclasses may override this
void	detach() Detach this object from its current Configuration.
boolean	equals(Object that) Check whether this QueryPart can be considered equal to another QueryPart.
int	execute() Execute the stored object on an underlying connection
int	execute(Configuration c) Execute the stored object using a Configuration object
boolean	generatesCast() Subclasses may override this
List<Parameter<?>>	getInParameters() A list of IN parameters passed to the stored procedure as argument.
protected Map<Parameter<?>,Field<?>>	getInValues()
String	getName() The name of this routine
List<Parameter<?>>	getOutParameters() A list of OUT parameters passed to the stored procedure as argument.
Package	getPackage() The container package of this stored procedure or function.
List<Parameter<?>>	getParameters()
Results	getResults()
Parameter<T>	getReturnParameter() The parameter representing this routine's Routine.getReturnValue()
T	getReturnValue()
Schema	getSchema() Get the routine schema
<Z> Z	getValue(Parameter<Z> parameter)
int	hashCode() Generate a hash code from this QueryPart.
protected boolean	isOverloaded()
protected void	setField(Parameter<?> parameter, Field<?> value)
protected void	setNumber(Parameter<? extends Number> parameter, Field<? extends Number> value)
protected <N extends Number> void	setNumber(Parameter<N> parameter, Number value)
protected void	setOverloaded(boolean overloaded)
protected void	setReturnParameter(Parameter<T> parameter)
<Z> void	setValue(Parameter<Z> parameter, Z value) Set the routine's IN value for an IN parameter.
void	toSQL(RenderContext ctx) Deprecated.
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

Methods inherited from interface org.jooq.QueryPart

equals, toString

Constructor Detail

AbstractRoutine

protected AbstractRoutine(String name,
                          Schema schema)

AbstractRoutine

protected AbstractRoutine(String name,
                          Schema schema,
                          Package pkg)

AbstractRoutine

protected AbstractRoutine(String name,
                          Schema schema,
                          DataType<T> type)

AbstractRoutine

protected AbstractRoutine(String name,
                          Schema schema,
                          DataType<X> type,
                          Converter<X,T> converter)

AbstractRoutine

protected AbstractRoutine(String name,
                          Schema schema,
                          DataType<X> type,
                          Binding<X,T> binding)

AbstractRoutine

protected AbstractRoutine(String name,
                          Schema schema,
                          DataType<X> type,
                          Converter<Y,T> converter,
                          Binding<X,Y> binding)

AbstractRoutine

protected AbstractRoutine(String name,
                          Schema schema,
                          Package pkg,
                          DataType<T> type)

AbstractRoutine

protected AbstractRoutine(String name,
                          Schema schema,
                          Package pkg,
                          DataType<X> type,
                          Converter<X,T> converter)

AbstractRoutine

protected AbstractRoutine(String name,
                          Schema schema,
                          Package pkg,
                          DataType<X> type,
                          Binding<X,T> binding)

AbstractRoutine

protected AbstractRoutine(String name,
                          Schema schema,
                          Package pkg,
                          DataType<X> type,
                          Converter<Y,T> converter,
                          Binding<X,Y> binding)

Method Detail

setNumber

protected final <N extends Number> void setNumber(Parameter<N> parameter,
                                                  Number value)

setNumber

protected final void setNumber(Parameter<? extends Number> parameter,
                               Field<? extends Number> value)

setValue

public final <Z> void setValue(Parameter<Z> parameter,
                               Z value)

Description copied from interface: Routine

Set the routine's IN value for an IN parameter.

Specified by:

setValue in interface Routine<T>

setField

protected final void setField(Parameter<?> parameter,
                              Field<?> value)

attach

public final void attach(Configuration c)

Description copied from interface: Attachable

Attach this object to a new Configuration.

Specified by:

attach in interface Attachable

Parameters:

c - A configuration or null, if you wish to detach this Attachable from its previous configuration.

detach

public final void detach()

Description copied from interface: Attachable

Detach this object from its current Configuration.

This is the same as calling attach(null).

Specified by:

detach in interface Attachable

configuration

public final Configuration configuration()

Description copied from interface: AttachableInternal

Get the underlying configuration

Specified by:

configuration in interface AttachableInternal

execute

public final int execute(Configuration c)

Description copied from interface: Routine

Execute the stored object using a Configuration object

Specified by:

execute in interface Routine<T>

execute

public final int execute()

Description copied from interface: Routine

Execute the stored object on an underlying connection

Specified by:

execute in interface Routine<T>

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

Specified by:

clauses in interface QueryPartInternal

Returns:

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

accept

public void accept(Context<?> ctx)

Description copied from interface: QueryPartInternal

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

getReturnValue

public final T getReturnValue()

Specified by:

getReturnValue in interface Routine<T>

Returns:

The routine's return value (if it is a function)

getResults

public final Results getResults()

Specified by:

getResults in interface Routine<T>

Returns:

The routine's results (if available)

getValue

public final <Z> Z getValue(Parameter<Z> parameter)

Specified by:

getValue in interface Routine<T>

Returns:

The routine's OUT value for an OUT parameter.

getInValues

protected final Map<Parameter<?>,Field<?>> getInValues()

getOutParameters

public final List<Parameter<?>> getOutParameters()

Description copied from interface: Routine

A list of OUT parameters passed to the stored procedure as argument. This list contains all parameters that are either OUT or INOUT in their respective order of appearance in Routine.getParameters().

Specified by:

getOutParameters in interface Routine<T>

Returns:

The list of out parameters

See Also:

Routine.getParameters()

getInParameters

public final List<Parameter<?>> getInParameters()

Description copied from interface: Routine

A list of IN parameters passed to the stored procedure as argument. This list contains all parameters that are either IN or INOUT in their respective order of appearance in Routine.getParameters().

Specified by:

getInParameters in interface Routine<T>

Returns:

The list of in parameters

See Also:

Routine.getParameters()

getParameters

public final List<Parameter<?>> getParameters()

Specified by:

getParameters in interface Routine<T>

Returns:

A list of parameters passed to the stored object as argument

getSchema

public final Schema getSchema()

Description copied from interface: Routine

Get the routine schema

Specified by:

getSchema in interface Routine<T>

getPackage

public final Package getPackage()

Description copied from interface: Routine

The container package of this stored procedure or function.

This is only supported in the SQLDialect.ORACLE dialect.

Specified by:

getPackage in interface Routine<T>

Returns:

The container package of this object, or null if there is no such container.

getName

public final String getName()

Description copied from interface: Routine

The name of this routine

Specified by:

getName in interface Routine<T>

getReturnParameter

public final Parameter<T> getReturnParameter()

Description copied from interface: Routine

The parameter representing this routine's Routine.getReturnValue()

Specified by:

getReturnParameter in interface Routine<T>

Returns:

The return parameter or null if this routine doesn't have a return value.

See Also:

Routine.getParameters()

setOverloaded

protected final void setOverloaded(boolean overloaded)

isOverloaded

protected final boolean isOverloaded()

addInParameter

protected final void addInParameter(Parameter<?> parameter)

addInOutParameter

protected final void addInOutParameter(Parameter<?> parameter)

addOutParameter

protected final void addOutParameter(Parameter<?> parameter)

setReturnParameter

protected final void setReturnParameter(Parameter<T> parameter)

asField

public final Field<T> asField()

asField

public final Field<T> asField(String alias)

asAggregateFunction

public final AggregateFunction<T> asAggregateFunction()

createParameter

protected static final <T> Parameter<T> createParameter(String name,
                                                        DataType<T> type)

Subclasses may call this method to create UDTField objects that are linked to this table.

Parameters:

name - The name of the field (case-sensitive!)

type - The data type of the field

createParameter

protected static final <T> Parameter<T> createParameter(String name,
                                                        DataType<T> type,
                                                        boolean isDefaulted)

Subclasses may call this method to create UDTField objects that are linked to this table.

Parameters:

name - The name of the field (case-sensitive!)

type - The data type of the field

isDefaulted - Whether the parameter is defaulted (see Parameter.isDefaulted()

createParameter

protected static final <T,U> Parameter<U> createParameter(String name,
                                                          DataType<T> type,
                                                          boolean isDefaulted,
                                                          Converter<T,U> converter)

Subclasses may call this method to create UDTField objects that are linked to this table.

Parameters:

name - The name of the field (case-sensitive!)

type - The data type of the field

isDefaulted - Whether the parameter is defaulted (see Parameter.isDefaulted()

createParameter

protected static final <T,U> Parameter<U> createParameter(String name,
                                                          DataType<T> type,
                                                          boolean isDefaulted,
                                                          Binding<T,U> binding)

Subclasses may call this method to create UDTField objects that are linked to this table.

Parameters:

name - The name of the field (case-sensitive!)

type - The data type of the field

isDefaulted - Whether the parameter is defaulted (see Parameter.isDefaulted()

createParameter

protected static final <T,X,U> Parameter<U> createParameter(String name,
                                                            DataType<T> type,
                                                            boolean isDefaulted,
                                                            Converter<X,U> converter,
                                                            Binding<T,X> binding)

Subclasses may call this method to create UDTField objects that are linked to this table.

Parameters:

name - The name of the field (case-sensitive!)

type - The data type of the field

isDefaulted - Whether the parameter is defaulted (see Parameter.isDefaulted()

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

Returns:

The QueryPart hash code

toSQL

@Deprecated
public void toSQL(RenderContext ctx)

Deprecated.

Description copied from interface: QueryPartInternal

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

bind

@Deprecated
public void bind(BindContext ctx)
                       throws DataAccessException

Deprecated.

Description copied from interface: QueryPartInternal

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:

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

Throws:

DataAccessException - If something went wrong while binding a variable

declaresFields

public boolean declaresFields()

Subclasses may override this

Specified by:

declaresFields in interface QueryPartInternal

declaresTables

public 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

generatesCast

public boolean generatesCast()

Subclasses may override this

Specified by:

generatesCast 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

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(Context<?> ctx)

Internal convenience method

translate

protected final DataAccessException translate(String sql,
                                              SQLException e)

Internal convenience method