org.jooq.impl

Class DefaultVisitListener

java.lang.Object

org.jooq.impl.DefaultVisitListener

All Implemented Interfaces:

java.util.EventListener, VisitListener

public class DefaultVisitListener
extends java.lang.Object
implements VisitListener

A publicly available default implementation of VisitListener.

Use this to stay compatible with future API changes (i.e. added methods to VisitListener)

Author:

Lukas Eder

Constructor Summary

Constructors

Constructor and Description
DefaultVisitListener()

Method Summary

Modifier and Type	Method and Description
void	clauseEnd(VisitContext context) Called after leaving a Clause.
void	clauseStart(VisitContext context) Called before entering a Clause.
void	visitEnd(VisitContext context) Called after visiting a QueryPart.
void	visitStart(VisitContext context) Called before visiting a QueryPart.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultVisitListener

public DefaultVisitListener()

Method Detail

clauseStart

public void clauseStart(VisitContext context)

Description copied from interface: VisitListener

Called before entering a Clause.

Specified by:

clauseStart in interface VisitListener

See Also:

Context.start(Clause)

clauseEnd

public void clauseEnd(VisitContext context)

Description copied from interface: VisitListener

Called after leaving a Clause.

Specified by:

clauseEnd in interface VisitListener

See Also:

Context.end(Clause)

visitStart

public void visitStart(VisitContext context)

Description copied from interface: VisitListener

Called before visiting a QueryPart.

Certain VisitListener implementations may chose to replace the QueryPart contained in the argument VisitContext through VisitContext.queryPart(QueryPart). This can be used for many use-cases, for example to add a CHECK OPTION to an Oracle INSERT statement:

 -- Original query
 INSERT INTO book (id, author_id, title)
 VALUES (10, 15, '1984')

 -- Transformed query
 INSERT INTO (
   SELECT * FROM book
   WHERE author_id IN (1, 2, 3)
   WITH CHECK OPTION
 ) (id, author_id, title)
 VALUES (10, 15, '1984')
 

The above SQL transformation allows to prevent inserting new books for authors other than those with author_id IN (1, 2, 3)

Specified by:

visitStart in interface VisitListener

See Also:

Context.visit(QueryPart)

visitEnd

public void visitEnd(VisitContext context)

Description copied from interface: VisitListener

Called after visiting a QueryPart.

Specified by:

visitEnd in interface VisitListener

See Also:

Context.visit(QueryPart)