org.jooq.impl

Class CatalogImpl

java.lang.Object

org.jooq.impl.CatalogImpl

All Implemented Interfaces:

Serializable, Catalog, QueryPart, QueryPartInternal

public class CatalogImpl
extends Object
implements Catalog

A common base class for database catalogs

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
CatalogImpl(String name)

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 ctx) Deprecated.
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(Object that) Check whether this QueryPart can be considered equal to another QueryPart.
boolean	generatesCast() Subclasses may override this
String	getName() The name of this schema
Schema	getSchema(String name) Get a schema by its name (case-sensitive) in this catalog, or null if no such schema exists
List<Schema>	getSchemas() List all schemas contained in this catalog
int	hashCode() Generate a hash code from this QueryPart.
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

toString

Constructor Detail

CatalogImpl

public CatalogImpl(String name)

Method Detail

getName

public final String getName()

Description copied from interface: Catalog

The name of this schema

Specified by:

getName in interface Catalog

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.

getSchema

public final Schema getSchema(String name)

Description copied from interface: Catalog

Get a schema by its name (case-sensitive) in this catalog, or null if no such schema exists

Specified by:

getSchema in interface Catalog

getSchemas

public List<Schema> getSchemas()

List all schemas contained in this catalog

Subclasses should override this method

Specified by:

getSchemas in interface Catalog

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

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