Package org.jooq.impl

Class AbstractRoutine<T>

    • Constructor Detail

      • AbstractRoutine

        protected AbstractRoutine​(java.lang.String name,
                          Schema schema)

      • AbstractRoutine

        protected AbstractRoutine​(java.lang.String name,
                          Schema schema,
                          Package pkg)

      • AbstractRoutine

        protected AbstractRoutine​(java.lang.String name,
                          Schema schema,
                          DataType<T> type)

      • AbstractRoutine

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

      • AbstractRoutine

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

      • AbstractRoutine

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

      • AbstractRoutine

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

      • AbstractRoutine

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

    • Method Detail

      • setNumber

        protected final <N extends java.lang.Number> void setNumber​(Parameter<N> parameter,
                                                            java.lang.Number value)

      • setNumber

        protected final void setNumber​(Parameter<? extends java.lang.Number> parameter,
                               Field<? extends java.lang.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>

      • set

        public final <Z> void set​(Parameter<Z> parameter,
                          Z value)
        Description copied from interface: Routine
        Set the routine's IN value for an IN parameter.
        Specified by:
        set 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

      • 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.

      • 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.

      • get

        public final <Z> Z get​(Parameter<Z> parameter)
        Specified by:
        get in interface Routine<T>
        Returns:
        The routine's OUT value for an OUT parameter.

      • getInValues

        protected final java.util.Map<Parameter<?>,​Field<?>> getInValues()

      • getOutParameters

        public final java.util.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 java.util.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 java.util.List<Parameter<?>> getParameters()
        Specified by:
        getParameters in interface Routine<T>
        Returns:
        A list of parameters passed to the stored object as argument

      • getCatalog

        public final Catalog getCatalog()
        Description copied from interface: Routine
        Get the routine catalog.
        Specified by:
        getCatalog in interface Routine<T>

      • getSchema

        public final Schema getSchema()
        Description copied from interface: Routine
        Get the routine schema
        Specified by:
        getSchema in interface Routine<T>

      • getPackage

        @Pro
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.

      • setOverloaded

        protected final void setOverloaded​(boolean overloaded)

      • isOverloaded

        protected final boolean isOverloaded()

      • setPipelined

        @Pro
protected final void setPipelined​(boolean pipelined)

      • isPipelined

        @Pro
protected final boolean isPipelined()

      • 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)

      • setPLSQLBooleanParameter

        @Pro
protected final void setPLSQLBooleanParameter​(Parameter<?> parameter)

      • asField

        public final Field<T> asField()

      • asField

        public final Field<T> asField​(java.lang.String alias)

      • createParameter

        @Deprecated
protected static final <T> Parameter<T> createParameter​(java.lang.String name,
                                                        DataType<T> type)
        Deprecated.
        - Please, re-generate your routine code.
        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

        @Deprecated
protected static final <T> Parameter<T> createParameter​(java.lang.String name,
                                                        DataType<T> type,
                                                        boolean isDefaulted)
        Deprecated.
        - Please, re-generate your routine code.
        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

        @Deprecated
protected static final <T,​U> Parameter<U> createParameter​(java.lang.String name,
                                                                DataType<T> type,
                                                                boolean 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.
        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

        @Deprecated
protected static final <T,​U> Parameter<U> createParameter​(java.lang.String name,
                                                                DataType<T> type,
                                                                boolean 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.
        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

        @Deprecated
protected static final <T,​X,​U> Parameter<U> createParameter​(java.lang.String name,
                                                                        DataType<T> type,
                                                                        boolean 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.
        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

        @Deprecated
protected static final <T> Parameter<T> createParameter​(java.lang.String name,
                                                        DataType<T> type,
                                                        boolean isDefaulted,
                                                        boolean isUnnamed)
        Deprecated.
        - Please, re-generate your routine code.
        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()
        isUnnamed - Whether the parameter is unnamed (see Parameter.isUnnamed().

      • createParameter

        @Deprecated
protected static final <T,​U> Parameter<U> createParameter​(java.lang.String name,
                                                                DataType<T> type,
                                                                boolean isDefaulted,
                                                                boolean 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.
        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()
        isUnnamed - Whether the parameter is unnamed (see Parameter.isUnnamed().

      • createParameter

        @Deprecated
protected static final <T,​U> Parameter<U> createParameter​(java.lang.String name,
                                                                DataType<T> type,
                                                                boolean isDefaulted,
                                                                boolean 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.
        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()
        isUnnamed - Whether the parameter is unnamed (see Parameter.isUnnamed().

      • createParameter

        @Deprecated
protected static final <T,​X,​U> Parameter<U> createParameter​(java.lang.String name,
                                                                        DataType<T> type,
                                                                        boolean isDefaulted,
                                                                        boolean 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.
        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()
        isUnnamed - Whether the parameter is unnamed (see Parameter.isUnnamed().

      • getName

        public final java.lang.String getName()
        Description copied from interface: Named
        The unqualified name of this object.
        Specified by:
        getName in interface Named

      • getQualifiedName

        public final Name getQualifiedName()
        Description copied from interface: Named
        The qualified name of this object.
        Specified by:
        getQualifiedName in interface Named

      • getUnqualifiedName

        public final Name getUnqualifiedName()
        Description copied from interface: Named
        The unqualified name of this object.
        Specified by:
        getUnqualifiedName in interface Named

      • getComment

        public final java.lang.String getComment()
        Description copied from interface: Named
        The comment on this object.
        Specified by:
        getComment in interface Named

      • 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

      • equals

        public boolean equals​(java.lang.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
        Parameters:
        that - The other QueryPart
        Returns:
        Whether the two query parts are equal

      • toSQL

        @Deprecated
public final void toSQL​(RenderContext context)
        Deprecated.
        - 3.4.0 - [#2694] - Use QueryPartInternal.accept(Context) instead.
        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

      • toString

        public java.lang.String toString()
        Description copied from interface: QueryPart
        Render a SQL string representation of this QueryPart.

        For improved debugging, this renders a SQL string of this QueryPart with inlined bind variables. If this QueryPart is Attachable, then the attached Configuration may be used for rendering the SQL string, including SQLDialect and Settings. Do note that most QueryPart instances are not attached to a Configuration, and thus there is no guarantee that the SQL string will make sense in the context of a specific database.

        Specified by:
        toString in interface QueryPart
        Overrides:
        toString in class java.lang.Object
        Returns:
        A SQL string representation of this QueryPart

      • translate

        protected final DataAccessException translate​(java.lang.String sql,
                                              java.sql.SQLException e)
        Internal convenience method