org.jooq

Interface Context<C extends Context<C>>

All Known Subinterfaces:

BindContext, RenderContext

public interface Context<C extends Context<C>>

A context type that is used for rendering SQL or for binding.

Author:

Lukas Eder

See Also:

BindContext, RenderContext

Method Summary

Methods

Modifier and Type	Method and Description
Configuration	configuration() The configuration wrapped by this context.
Map<Object,Object>	data() Get all custom data from this Context.
Object	data(Object key) Get some custom data from this Context.
Object	data(Object key, Object value) Set some custom data to this Context.
boolean	declareFields() Whether the current context is rendering a SQL field declaration (e.g. a Field in the SELECT clause of the query).
C	declareFields(boolean declareFields) Set the new context value for declareFields()
boolean	declareTables() Whether the current context is rendering a SQL table declaration (e.g. a Table in the FROM or JOIN clause of the query).
C	declareTables(boolean declareTables) Set the new context value for declareTables()
boolean	declareWindows() Whether the current context is rendering a SQL window declaration (e.g. a WindowDefinition in the WINDOW clause of the query).
C	declareWindows(boolean declareWindows) Set the new context value for declareWindows()
C	end(Clause clause)
int	nextIndex() Get the next bind index.
int	peekIndex() Peek the next bind index.
C	start(Clause clause) TODO [#2667] Properties of these methods: - A clause is always started / ended, even if it isn't rendered or if it's empty!
boolean	subquery() Whether the current context is rendering a sub-query (nested query)
C	subquery(boolean subquery) Set the new context value for subquery()
C	visit(QueryPart part) Visit a QueryPart in the current Context.

Method Detail

configuration

Configuration configuration()

The configuration wrapped by this context.

data

Map<Object,Object> data()

Get all custom data from this Context.

This is custom data that was previously set to the context using data(Object, Object). Use custom data if you want to pass data to QueryPart objects for a given RenderContext or BindContext.

Unlike Configuration.data(), these data's lifecycle only matches that of a render or bind context.

Returns:

The custom data. This is never null

data

Object data(Object key)

Get some custom data from this Context.

This is custom data that was previously set to the context using data(Object, Object). Use custom data if you want to pass data to QueryPart objects for a given RenderContext or BindContext.

Unlike Configuration.data(), these data's lifecycle only matches that of a render or bind context.

Parameters:

key - A key to identify the custom data

Returns:

The custom data or null if no such data is contained in this ExecuteContext

See Also:

ExecuteListener

data

Object data(Object key,
          Object value)

Set some custom data to this Context.

This is custom data that was previously set to the context using data(Object, Object). Use custom data if you want to pass data to QueryPart objects for a given RenderContext or BindContext.

Unlike Configuration.data(), these data's lifecycle only matches that of a render or bind context.

Parameters:

key - A key to identify the custom data

value - The custom data

Returns:

The previously set custom data or null if no data was previously set for the given key

See Also:

ExecuteListener

visit

C visit(QueryPart part)
                           throws DataAccessException

Visit a QueryPart in the current Context.

This method is called by certain QueryPart implementations to recursively visit component QueryParts.

Parameters:

part - The component QueryPart

Throws:

DataAccessException - If something went wrong while visiting the component QueryPart, e.g. when binding a variable

start

C start(Clause clause)

TODO [#2667] Properties of these methods: - A clause is always started / ended, even if it isn't rendered or if it's empty!

end

C end(Clause clause)

declareFields

boolean declareFields()

Whether the current context is rendering a SQL field declaration (e.g. a Field in the SELECT clause of the query).

declareFields

C declareFields(boolean declareFields)

Set the new context value for declareFields()

declareTables

boolean declareTables()

Whether the current context is rendering a SQL table declaration (e.g. a Table in the FROM or JOIN clause of the query).

declareTables

C declareTables(boolean declareTables)

Set the new context value for declareTables()

declareWindows

boolean declareWindows()

Whether the current context is rendering a SQL window declaration (e.g. a WindowDefinition in the WINDOW clause of the query).

declareWindows

C declareWindows(boolean declareWindows)

Set the new context value for declareWindows()

subquery

boolean subquery()

Whether the current context is rendering a sub-query (nested query)

subquery

C subquery(boolean subquery)

Set the new context value for subquery()

nextIndex

int nextIndex()

Get the next bind index. This increments an internal counter. This is relevant for two use-cases:

• When binding variables to a PreparedStatement. Client code must assure that calling nextIndex() is followed by setting a bind value to BindContext.statement()
• When rendering unnamed bind variables with RenderContext.paramType() being to NAMED

peekIndex

int peekIndex()

Peek the next bind index. This won't increment the internal counter, unlike nextIndex()