Top Description Inners Fields Constructors Methods
org.jooq.impl

public abstract Class AbstractRoutine<T>

extends AbstractNamed
implements Routine<T>, UNotYetImplemented
Class Inheritance
All Implemented Interfaces
org.jooq.impl.QOM.UNotYetImplemented, org.jooq.impl.QOM.UEmpty, org.jooq.QueryPart, java.io.Serializable, org.jooq.Routine, org.jooq.Attachable, org.jooq.Qualified, org.jooq.Named
Annotations
@Internal
Static Imports
java.lang.Boolean.FALSE, .Boolean.TRUE, java.util.Arrays.asList, java.util.stream.Collectors.toList, org.jooq.Clause.FIELD, .Clause.FIELD_FUNCTION, .SQLDialect.FIREBIRD, .SQLDialect.POSTGRES, .SQLDialect.YUGABYTEDB, .XMLFormat.RecordFormat.COLUMN_NAME_ELEMENTS, org.jooq.conf.ThrowExceptions.THROW_NONE, org.jooq.impl.DSL.field, .DSL.inline, .DSL.name, .DSL.param, .DSL.sql, .DSL.table, .DSL.using, .DSL.val, .Keywords.K_BEGIN, .Keywords.K_BOOLEAN, .Keywords.K_CASE, .Keywords.K_COLUMNS, .Keywords.K_DECLARE, .Keywords.K_END, .Keywords.K_END_IF, .Keywords.K_END_LOOP, .Keywords.K_FALSE, .Keywords.K_FIRST, .Keywords.K_FOR, .Keywords.K_FROM, .Keywords.K_FUNCTION, .Keywords.K_IF, .Keywords.K_IN, .Keywords.K_IS, .Keywords.K_IS_NOT_NULL, .Keywords.K_LAST, .Keywords.K_LOOP, .Keywords.K_NEXT, .Keywords.K_NOT, .Keywords.K_OPEN, .Keywords.K_PASSING, .Keywords.K_RECORD, .Keywords.K_RETURN, .Keywords.K_SELECT, .Keywords.K_THEN, .Keywords.K_TRUE, .Keywords.K_TYPE, .Keywords.K_WHEN, .Keywords.K_WHILE, .Keywords.K_XMLTABLE, .SQLDataType.INTEGER, .SQLDataType.NUMERIC, .Tools.EMPTY_FIELD, .Tools.EMPTY_NAME, .Tools.configurationOrThrow, .Tools.executeStatementAndGetFirstResultSet, .Tools.getRecordQualifier, .Tools.settings, .Tools.toSQLDDLTypeDeclaration, .Tools.SimpleDataKey.DATA_TOP_LEVEL_CTE

Deprecated

as a consequence of QOM.UNotYetImplemented being deprecated. See corresponding docs for further information.

A common base class for stored procedures

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

Author
Lukas Eder

Nested and Inner Type Summary

Modifier and TypeClass and Description
private class
AbstractRoutine.RoutineField

Deprecated as a consequence of AbstractField and QOM.UNotYetImplemented being deprecated.
The Field representation of this Routine

Field Summary

Modifier and TypeField and Description
private final List<Parameter<?>>
allParameters

private static final Clause[]
CLAUSES

Deprecated as a consequence of Clause being deprecated.
private Configuration
configuration

private transient Field<T>
function

Deprecated as a consequence of Field being deprecated.
private boolean
hasUnnamedParameters

private final List<Parameter<?>>
inParameters

private final Map<Parameter<?>, Field<?>>
inValues

private final Set<Parameter<?>>
inValuesDefaulted

private final Set<Parameter<?>>
inValuesNonDefaulted

private Boolean
isSQLUsable

private final List<Parameter<?>>
outParameters

private final Map<Parameter<?>, Object>
outValues

private boolean
overloaded

private static final Set<SQLDialect>
REQUIRE_DISAMBIGUATE_OVERLOADS

private static final Set<SQLDialect>
REQUIRE_SELECT_FROM

private final Map<Parameter<?>, Integer>
resultIndexes

private ResultsImpl
results

private Parameter<T>
returnParameter

private final Schema
schema

private final DataType<T>
type

Constructor Summary

AccessConstructor and Description
protected
AbstractRoutine(String name, Schema schema)

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

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

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

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

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

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

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

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

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

Method Summary

Modifier and TypeMethod and Description
public final Schema
$schema()

Implements org.jooq.Qualified.$schema.

Experimental query object model accessor method, see also QOM.
public final void
accept(Context<?> ctx)

Implements org.jooq.QueryPartInternal.accept.

This QueryPart can accept a Context object in order to render a SQL string or to bind its variables.
protected final void
addInOutParameter(Parameter<?> parameter)

protected final void
addInParameter(Parameter<?> parameter)

protected final void
addOutParameter(Parameter<?> parameter)

private final void
addParameter(Parameter<?> parameter)

public final AggregateFunction<T>
asAggregateFunction()

Deprecated as a consequence of AggregateFunction being deprecated.
public final Field<T>
asField()

Deprecated as a consequence of Field being deprecated.
public final Field<T>
asField(String alias)

Deprecated as a consequence of Field being deprecated.
public final void
attach(Configuration
A configuration or null, if you wish to detach this Attachable from its previous configuration.
c)

Implements org.jooq.Attachable.attach.

Attach this object to a new Configuration.
pack-priv final void
bind0(BindContext context)

private final void
bind1(BindContext context, Parameter<?> parameter, boolean bindAsIn, boolean bindAsOut)

public final Clause[]
clauses(Context<?> ctx)

Overrides org.jooq.impl.AbstractQueryPart.clauses.

Implements org.jooq.QueryPartInternal.clauses.

Deprecated as a consequence of Clause being deprecated.
The Clauses that are represented by this query part.
public final Configuration
configuration()

Overrides org.jooq.impl.AbstractQueryPart.configuration.

Implements org.jooq.Attachable.configuration.

Get the currently attached Configuration, or null if no Configuration is attached.
protected static final <T> Parameter<T>
createParameter(String
The name of the field (case-sensitive!)
name, DataType<T>
The data type of the field
type)

Deprecated - Please, re-generate your routine code.
Subclasses may call this method to create UDTField objects that are linked to this table.
protected static final <T> Parameter<T>
createParameter(String
The name of the field (case-sensitive!)
name, DataType<T>
The data type of the field
type, boolean
Whether the parameter is defaulted (see Parameter#isDefaulted()
isDefaulted)

Deprecated - Please, re-generate your routine code.
Subclasses may call this method to create UDTField objects that are linked to this table.
protected static final <T, U> Parameter<U>
createParameter(String
The name of the field (case-sensitive!)
name, DataType<T>
The data type of the field
type, boolean
Whether the parameter is defaulted (see Parameter#isDefaulted()
isDefaulted, Converter<T, U> converter)

Deprecated - Please, re-generate your routine code.
Subclasses may call this method to create UDTField objects that are linked to this table.
protected static final <T, U> Parameter<U>
createParameter(String
The name of the field (case-sensitive!)
name, DataType<T>
The data type of the field
type, boolean
Whether the parameter is defaulted (see Parameter#isDefaulted()
isDefaulted, Binding<T, U> binding)

Deprecated - Please, re-generate your routine code.
Subclasses may call this method to create UDTField objects that are linked to this table.
protected static final <T, X, U> Parameter<U>
createParameter(String
The name of the field (case-sensitive!)
name, DataType<T>
The data type of the field
type, boolean
Whether the parameter is defaulted (see Parameter#isDefaulted()
isDefaulted, Converter<X, U> converter, Binding<T, X> binding)

Deprecated - Please, re-generate your routine code.
Subclasses may call this method to create UDTField objects that are linked to this table.
protected static final <T> Parameter<T>
createParameter(String
The name of the field (case-sensitive!)
name, DataType<T>
The data type of the field
type, boolean
Whether the parameter is defaulted (see Parameter#isDefaulted()
isDefaulted, boolean
Whether the parameter is unnamed (see Parameter#isUnnamed().
isUnnamed)

Deprecated - Please, re-generate your routine code.
Subclasses may call this method to create UDTField objects that are linked to this table.
protected static final <T, U> Parameter<U>
createParameter(String
The name of the field (case-sensitive!)
name, DataType<T>
The data type of the field
type, boolean
Whether the parameter is defaulted (see Parameter#isDefaulted()
isDefaulted, boolean
Whether the parameter is unnamed (see Parameter#isUnnamed().
isUnnamed, Converter<T, U> converter)

Deprecated - Please, re-generate your routine code.
Subclasses may call this method to create UDTField objects that are linked to this table.
protected static final <T, U> Parameter<U>
createParameter(String
The name of the field (case-sensitive!)
name, DataType<T>
The data type of the field
type, boolean
Whether the parameter is defaulted (see Parameter#isDefaulted()
isDefaulted, boolean
Whether the parameter is unnamed (see Parameter#isUnnamed().
isUnnamed, Binding<T, U> binding)

Deprecated - Please, re-generate your routine code.
Subclasses may call this method to create UDTField objects that are linked to this table.
protected static final <T, X, U> Parameter<U>
createParameter(String
The name of the field (case-sensitive!)
name, DataType<T>
The data type of the field
type, boolean
Whether the parameter is defaulted (see Parameter#isDefaulted()
isDefaulted, boolean
Whether the parameter is unnamed (see Parameter#isUnnamed().
isUnnamed, Converter<X, U> converter, Binding<T, X> binding)

Deprecated - Please, re-generate your routine code.
Subclasses may call this method to create UDTField objects that are linked to this table.
public final void
detach()

Implements org.jooq.Attachable.detach.

Detach this object from its current Configuration.
public final int
execute(Configuration c)

Implements org.jooq.Routine.execute.

Execute the stored object using a Configuration object
public final int
execute()

Implements org.jooq.Routine.execute.

Execute the stored object on an underlying connection
private final SQLException
execute0(ExecuteContext ctx, ExecuteListener listener)

private final int
executeCallableStatement()

private final int
executeSelect()

private final int
executeSelectFromHSQLDB()

private final int
executeSelectFromPOSTGRES()

private final <U> void
fetchOutParameter(ExecuteContext ctx, Parameter<U> parameter)

private final void
fetchOutParameters(ExecuteContext ctx)

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

Implements org.jooq.Routine.get.

public final Catalog
getCatalog()

Implements org.jooq.Qualified.getCatalog.

Get the object's catalog.
public final List<Parameter<?>>
getInParameters()

Implements org.jooq.Routine.getInParameters.

A list of IN parameters passed to the stored procedure as argument.
private final List<Parameter<?>>
getInParameters0(Configuration c)

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

Implements org.jooq.Routine.getInValue.

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

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

Implements org.jooq.Routine.getOutParameters.

A list of OUT parameters passed to the stored procedure as argument.
private final List<Parameter<?>>
getOutParameters0(Configuration c)

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

Implements org.jooq.Routine.getParameters.

private final List<Parameter<?>>
getParameters0(Configuration c)

private final Name
getQualifiedName(Context<?> ctx)

public final Results
getResults()

Implements org.jooq.Routine.getResults.

public final Parameter<T>
getReturnParameter()

Implements org.jooq.Routine.getReturnParameter.

The parameter representing this routine's getReturnValue()
private final Parameter<T>
getReturnParameter0(Configuration c)

public final T
getReturnValue()

Implements org.jooq.Routine.getReturnValue.

public final Schema
getSchema()

Implements org.jooq.Qualified.getSchema.

Get the object's schema.
public final <Z> Z
getValue(Parameter<Z> parameter)

Implements org.jooq.Routine.getValue.

private final boolean
hasUnnamedParameters()

protected final boolean
isOverloaded()

protected final boolean
isSQLUsable()

private final boolean
pgArgNeedsCasting(Parameter<?> parameter)

private final <U> void
registerOutParameter(ExecuteContext ctx, CallableStatement statement, Parameter<U> parameter)

private final void
registerOutParameters(ExecuteContext ctx)

private final boolean
resultParameter(Configuration c, Parameter<?> parameter)

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

Implements org.jooq.Routine.set.

Set the routine's IN value for an IN parameter.
protected final void
setField(Parameter<?> parameter, Field<?> value)

Deprecated as a consequence of Field being deprecated.
protected final <N extends Number> void
setNumber(Parameter<N> parameter, Number value)

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

Deprecated as a consequence of Field being deprecated.
protected final void
setOverloaded(boolean overloaded)

protected final void
setReturnParameter(Parameter<T> parameter)

protected final void
setSQLUsable(boolean isSQLUsable)

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

Implements org.jooq.Routine.setValue.

Set the routine's IN value for an IN parameter.
pack-priv final void
toSQL0(RenderContext context)

private final void
toSQLAssign(RenderContext context)

private final void
toSQLBegin(RenderContext context)

private final void
toSQLCall(RenderContext context)

private final void
toSQLDeclare(RenderContext context)

private final void
toSQLEnd(RenderContext context)

private final void
toSQLInParam(RenderContext ctx, Parameter<?> parameter, int index, Field<?> value)

Deprecated as a consequence of Field being deprecated.
private final void
toSQLOutParam(RenderContext ctx, Parameter<?> parameter, int index)

Inherited from org.jooq.impl.AbstractNamed:
$nameequalsfindfindfindAllfindAllfindIgnoreCasefindIgnoreCasegetCommentgetCommentPartgetNamegetQualifiedNamegetUnqualifiedNamehashCodenameOrDefaultqualify