- All Implemented Interfaces:
Serializable
,Named
,Qualified
,QueryPart
,QueryPartInternal
,Sequence<T>
,Typed<T>
This type is for JOOQ INTERNAL USE only. Do not reference directly
- Author:
- Lukas Eder
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionExperimental query object model accessor method, see alsoQOM
.final Name
$name()
Experimental query object model accessor method, see alsoQOM
.default QueryPart
Traverse aQueryPart
hierarchy and recursively replace its elements by alternatives.final Schema
$schema()
Experimental query object model accessor method, see alsoQOM
.default <R> R
final void
final Clause[]
TheClause
s that are represented by this query part.protected final DSLContext
create()
Deprecated.protected final DSLContext
create
(Configuration configuration) Deprecated.- 3.11.0 - [#6722] - UseAttachable.configuration()
andConfiguration.dsl()
instead.protected final DSLContext
Deprecated.- 3.11.0 - [#6722] - UseAttachable.configuration()
andConfiguration.dsl()
instead.currval()
An expression to get the current value of this sequence.boolean
Subclasses may override thisboolean
Subclasses may override thisboolean
Subclasses may override thisboolean
Subclasses may override thisboolean
Subclasses may override thisboolean
Check whether thisQueryPart
can be considered equal to anotherQueryPart
.boolean
Subclasses may override thisThe object's underlyingBinding
.getCache()
Get the number of sequence values to cache for this sequence ornull
, if no such value is specified.final Catalog
Get the object's catalog.final String
The comment on this object.final Comment
The comment on this object as aQueryPart
.final ContextConverter<?,
T> The object's underlyingConverter
.final boolean
getCycle()
Returnstrue
if this sequence cycles toSequence.getMinvalue()
when it reachesSequence.getMaxvalue()
.The type of this object (might not be dialect-specific).getDataType
(Configuration configuration) The dialect-specific type of this object.Get the increment for this sequence ornull
, if no such value is specified.Get the maximum value for this sequence ornull
, if no such value is specified.Get the minimum value for this sequence ornull
, if no such value is specified.final String
getName()
The unqualified name of this object.The qualified name of this object.final Schema
Get the object's schema.Get the start value for this sequence ornull
, if no such value is specified.getType()
The Java type of the object.final Name
The unqualified name of this object.int
hashCode()
Generate a hash code from thisQueryPart
.nextval()
An expression to increment the sequence and get the next value.nextvals
(int size) An expression to increment the sequence and get the next values.boolean
rendersContent
(Context<?> ctx) Subclasses may override thistoString()
Render a SQL string representation of thisQueryPart
.protected final DataAccessException
translate
(String sql, SQLException e) Internal convenience methodMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.jooq.Named
$name, getComment, getCommentPart, getName, getQualifiedName, getUnqualifiedName
Methods inherited from interface org.jooq.Typed
$dataType, getBinding, getConverter, getDataType, getDataType, getType
-
Constructor Details
-
SequenceImpl
Deprecated.
-
-
Method Details
-
getCatalog
Description copied from interface:Qualified
Get the object's catalog.- Specified by:
getCatalog
in interfaceQualified
-
getSchema
Description copied from interface:Qualified
Get the object's schema. -
getStartWith
Description copied from interface:Sequence
Get the start value for this sequence ornull
, if no such value is specified.- Specified by:
getStartWith
in interfaceSequence<T extends Number>
-
getIncrementBy
Description copied from interface:Sequence
Get the increment for this sequence ornull
, if no such value is specified.- Specified by:
getIncrementBy
in interfaceSequence<T extends Number>
-
getMinvalue
Description copied from interface:Sequence
Get the minimum value for this sequence ornull
, if no such value is specified.- Specified by:
getMinvalue
in interfaceSequence<T extends Number>
-
getMaxvalue
Description copied from interface:Sequence
Get the maximum value for this sequence ornull
, if no such value is specified.- Specified by:
getMaxvalue
in interfaceSequence<T extends Number>
-
getCycle
public final boolean getCycle()Description copied from interface:Sequence
Returnstrue
if this sequence cycles toSequence.getMinvalue()
when it reachesSequence.getMaxvalue()
. -
getCache
Description copied from interface:Sequence
Get the number of sequence values to cache for this sequence ornull
, if no such value is specified. -
currval
Description copied from interface:Sequence
An expression to get the current value of this sequence. -
nextval
Description copied from interface:Sequence
An expression to increment the sequence and get the next value. -
nextvals
Description copied from interface:Sequence
An expression to increment the sequence and get the next values.This is done using
DSL.generateSeries(int, int)
. -
accept
Description copied from interface:QueryPartInternal
ThisQueryPart
canaccept
aContext
object in order to render a SQL string or to bind its variables.- Specified by:
accept
in interfaceQueryPartInternal
-
clauses
Description copied from interface:QueryPartInternal
TheClause
s that are represented by this query part.QueryPart
s can specify severalClause
s for which an event will be emittedbefore
(in forward order) andafter
(in reverse order) visiting the the query part throughContext.visit(QueryPart)
This method is for JOOQ INTERNAL USE only. Do not reference directly
- Specified by:
clauses
in interfaceQueryPartInternal
- Returns:
- The
Clause
s represented by this query part ornull
or an empty array if this query part does not represent a clause.
-
$schema
Description copied from interface:Qualified
Experimental query object model accessor method, see alsoQOM
. Subject to change in future jOOQ versions, use at your own risk. -
equals
Description copied from interface:QueryPart
Check whether thisQueryPart
can be considered equal to anotherQueryPart
.In general,
QueryPart
equality is defined in terms ofQueryPart.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, asQueryPart.toString()
is an expensive operation, if called many times. -
$traverse
Description copied from interface:QueryPart
Traverser thisQueryPart
expression tree using a composableTraverser
, producing a result.This offers a generic way to traverse expression trees to translate the tree to arbitrary other data structures. The simplest traversal would just count all the tree elements:
int count = CUSTOMER.NAME.eq(1).$traverse(0, (i, p) -> i + 1);
The same can be achieved by translating the JDK
Collector
API to theTraverser
API usingTraversers.collecting(Collector)
.CUSTOMER.NAME.eq(1).$traverse(Traversers.collecting(Collectors.counting()));
Unlike a
Collector
, aTraverser
is optimised for tree traversal, not stream traversal:- Is not designed for parallelism
- It can
Traverser.abort()
traversal early when the result can be produced early (e.g. when runningTraversers.containing(QueryPart)
, and a result has been found). - It can decide whether to
Traverser.recurse()
into aQueryPart
subtree, or whether that is not necessary or even undesirable, e.g. to prevent entering new subquery scopes. - Unlike a Collector, which can use its
Collector.accumulator()
to accumulate each element only once, in tree traversal, it's desirable to be able to distinguish between accumulating an itemTraverser.before()
orTraverser.after()
recursing into it. This is useful e.g. to wrap each tree node in XML opening and closing tags.
This is a commercial jOOQ edition only feature.
-
$replace
Description copied from interface:QueryPart
-
getConverter
Description copied from interface:Typed
The object's underlyingConverter
.By default, all typed objects reference an identity-converter
Converter<T, T>
. If an implementation is generated, custom data types may be obtained by a customConverter
placed on the generated object.- Specified by:
getConverter
in interfaceTyped<T>
-
getBinding
Description copied from interface:Typed
The object's underlyingBinding
.- Specified by:
getBinding
in interfaceTyped<T>
-
getType
Description copied from interface:Typed
The Java type of the object. -
getDataType
Description copied from interface:Typed
The type of this object (might not be dialect-specific).- Specified by:
getDataType
in interfaceTyped<T>
-
getDataType
Description copied from interface:Typed
The dialect-specific type of this object.- Specified by:
getDataType
in interfaceTyped<T>
-
$dataType
Description copied from interface:Typed
Experimental query object model accessor method, see alsoQOM
. Subject to change in future jOOQ versions, use at your own risk. -
getName
Description copied from interface:Named
The unqualified name of this object. -
getQualifiedName
Description copied from interface:Named
The qualified name of this object.- Specified by:
getQualifiedName
in interfaceNamed
-
getUnqualifiedName
Description copied from interface:Named
The unqualified name of this object.- Specified by:
getUnqualifiedName
in interfaceNamed
-
getComment
Description copied from interface:Named
The comment on this object.This is the same as calling
Named.getCommentPart()
and thenComment.getComment()
.- Specified by:
getComment
in interfaceNamed
-
getCommentPart
Description copied from interface:Named
The comment on this object as aQueryPart
.- Specified by:
getCommentPart
in interfaceNamed
-
hashCode
public int hashCode()Description copied from interface:QueryPart
Generate a hash code from thisQueryPart
.In general,
QueryPart
hash codes are the same as the hash codes generated fromQueryPart.toString()
. This guarantees consistent behaviour withQueryPart.equals(Object)
Some
QueryPart
implementations may choose to override this behaviour for improved performance, asQueryPart.toString()
is an expensive operation, if called many times. -
$name
Description copied from interface:Named
Experimental query object model accessor method, see alsoQOM
. Subject to change in future jOOQ versions, use at your own risk. -
rendersContent
Subclasses may override this- Specified by:
rendersContent
in interfaceQueryPartInternal
-
declaresFields
public boolean declaresFields()Subclasses may override this- Specified by:
declaresFields
in interfaceQueryPartInternal
-
declaresTables
public boolean declaresTables()Subclasses may override this- Specified by:
declaresTables
in interfaceQueryPartInternal
-
declaresWindows
public boolean declaresWindows()Subclasses may override this- Specified by:
declaresWindows
in interfaceQueryPartInternal
-
declaresCTE
public boolean declaresCTE()Subclasses may override this- Specified by:
declaresCTE
in interfaceQueryPartInternal
-
declaresParameters
Subclasses may override this- Specified by:
declaresParameters
in interfaceQueryPartInternal
-
generatesCast
public boolean generatesCast()Subclasses may override this- Specified by:
generatesCast
in interfaceQueryPartInternal
-
toString
Description copied from interface:QueryPart
Render a SQL string representation of thisQueryPart
.For improved debugging, this renders a SQL string of this
QueryPart
with inlined bind variables. If thisQueryPart
isAttachable
, then the attachedConfiguration
may be used for rendering the SQL string, includingSQLDialect
andSettings
. Do note that mostQueryPart
instances are not attached to aConfiguration
, and thus there is no guarantee that the SQL string will make sense in the context of a specific database. -
create
Deprecated.- 3.11.0 - [#6722] - UseAttachable.configuration()
andConfiguration.dsl()
instead.Internal convenience method -
create
Deprecated.- 3.11.0 - [#6722] - UseAttachable.configuration()
andConfiguration.dsl()
instead.Internal convenience method -
create
Deprecated.- 3.11.0 - [#6722] - UseAttachable.configuration()
andConfiguration.dsl()
instead.Internal convenience method -
translate
Internal convenience method
-
Attachable.configuration()
andConfiguration.dsl()
instead.