org.jooq.impl

Class PackageImpl

java.lang.Object

org.jooq.impl.PackageImpl

All Implemented Interfaces:

java.io.Serializable, Package, QueryPart, QueryPartInternal

public class PackageImpl
extends java.lang.Object
implements Package

A default implementation for packages (containers of stored procedures and functions)

Currently, this is only supported for the SQLDialect.ORACLE dialect.

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

Author:

Lukas Eder

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PackageImpl(java.lang.String name, Schema schema)

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.
void	bind(BindContext context) Deprecated. - 3.4.0 - [#2694] - Use QueryPartInternal.accept(Context) instead.
Clause[]	clauses(Context<?> ctx) The Clauses that are represented by this query part.
protected DSLContext	create() Internal convenience method
protected DSLContext	create(Configuration configuration) Internal convenience method
protected DSLContext	create(Context<?> ctx) Internal convenience method
boolean	declaresCTE() Subclasses may override this
boolean	declaresFields() Subclasses may override this
boolean	declaresTables() Subclasses may override this
boolean	declaresWindows() Subclasses may override this
boolean	equals(java.lang.Object that) Check whether this QueryPart can be considered equal to another QueryPart.
boolean	generatesCast() Subclasses may override this
Catalog	getCatalog() Get the package catalog.
java.lang.String	getName() The name of this package
Schema	getSchema() Get the package schema
int	hashCode() Generate a hash code from this QueryPart.
void	toSQL(RenderContext context) Deprecated. - 3.4.0 - [#2694] - Use QueryPartInternal.accept(Context) instead.
java.lang.String	toString() Render a SQL string representation of this QueryPart.
protected DataAccessException	translate(java.lang.String sql, java.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

toString

Constructor Detail

PackageImpl

public PackageImpl(java.lang.String name,
                   Schema schema)

Method Detail

getCatalog

public final Catalog getCatalog()

Description copied from interface: Package

Get the package catalog.

Specified by:

getCatalog in interface Package

getSchema

public final Schema getSchema()

Description copied from interface: Package

Get the package schema

Specified by:

getSchema in interface Package

getName

public final java.lang.String getName()

Description copied from interface: Package

The name of this package

Specified by:

getName in interface Package

accept

public final 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

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.

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

bind

@Deprecated
public final void bind(BindContext context)
                             throws DataAccessException

Deprecated. - 3.4.0 - [#2694] - Use QueryPartInternal.accept(Context) instead.

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:

context - 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

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.

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 java.lang.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(java.lang.String sql,
                                              java.sql.SQLException e)

Internal convenience method