com.atlassian.jira.jql.context
Class QueryContextVisitor

java.lang.Object
  com.atlassian.jira.jql.context.QueryContextVisitor

All Implemented Interfaces:

ClauseVisitor<QueryContextVisitor.ContextResult>

@NotThreadSafe
@NonInjectableComponent
public class QueryContextVisitor
extends Object
implements ClauseVisitor<QueryContextVisitor.ContextResult>

A visitor that is used to generate a QueryContextVisitor.ContextResult, which contains the full and simple QueryContexts of the visited Query.

To construct an instance of this class, please use the QueryContextVisitor.QueryContextVisitorFactory.

Since:

v4.0

See Also:

QueryContextVisitor.QueryContextVisitorFactory, QueryContextVisitor.ContextResult

Nested Class Summary

static class	QueryContextVisitor.ContextResult The result of visiting a Query with the QueryContextVisitor.
static class	QueryContextVisitor.QueryContextVisitorFactory Constructs an instance of QueryContextVisitor for use.

Constructor Summary

QueryContextVisitor(com.atlassian.crowd.embedded.api.User searcher, ContextSetUtil contextSetUtil, SearchHandlerManager searchHandlerManager)

Method Summary

QueryContextVisitor.ContextResult	createContext(Clause clause)
QueryContextVisitor.ContextResult	visit(AndClause andClause) Visit called when accepting a AndClause.
QueryContextVisitor.ContextResult	visit(ChangedClause clause) Visit called when accepting a ChangedClause.
QueryContextVisitor.ContextResult	visit(NotClause notClause) Visit called when accepting a NotClause.
QueryContextVisitor.ContextResult	visit(OrClause orClause) Visit called when accepting a OrClause.
QueryContextVisitor.ContextResult	visit(TerminalClause clause) Visit called when accepting a TerminalClause.
QueryContextVisitor.ContextResult	visit(WasClause clause) Visit called when accepting a WasClause.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryContextVisitor

public QueryContextVisitor(com.atlassian.crowd.embedded.api.User searcher,
                           ContextSetUtil contextSetUtil,
                           SearchHandlerManager searchHandlerManager)

Method Detail

createContext

public QueryContextVisitor.ContextResult createContext(Clause clause)

visit

public QueryContextVisitor.ContextResult visit(AndClause andClause)

Description copied from interface: ClauseVisitor

Visit called when accepting a AndClause.

Specified by:

visit in interface ClauseVisitor<QueryContextVisitor.ContextResult>

Parameters:

andClause - the node being visited.

Returns:

The return type specified by the visitor.

visit

public QueryContextVisitor.ContextResult visit(NotClause notClause)

Description copied from interface: ClauseVisitor

Visit called when accepting a NotClause.

Specified by:

visit in interface ClauseVisitor<QueryContextVisitor.ContextResult>

Parameters:

notClause - the node being visited.

Returns:

The return type specified by the visitor.

visit

public QueryContextVisitor.ContextResult visit(OrClause orClause)

Description copied from interface: ClauseVisitor

Visit called when accepting a OrClause.

Specified by:

visit in interface ClauseVisitor<QueryContextVisitor.ContextResult>

Parameters:

orClause - the node being visited.

Returns:

The return type specified by the visitor.

visit

public QueryContextVisitor.ContextResult visit(TerminalClause clause)

Description copied from interface: ClauseVisitor

Visit called when accepting a TerminalClause.

Specified by:

visit in interface ClauseVisitor<QueryContextVisitor.ContextResult>

Parameters:

clause - the node being visited.

Returns:

The return type specified by the visitor.

visit

public QueryContextVisitor.ContextResult visit(WasClause clause)

Description copied from interface: ClauseVisitor

Visit called when accepting a WasClause.

Specified by:

visit in interface ClauseVisitor<QueryContextVisitor.ContextResult>

Parameters:

clause - the node being visited.

Returns:

The return type specified by the visitor.

visit

public QueryContextVisitor.ContextResult visit(ChangedClause clause)

Description copied from interface: ClauseVisitor

Visit called when accepting a ChangedClause.

Specified by:

visit in interface ClauseVisitor<QueryContextVisitor.ContextResult>

Parameters:

clause - the node being visited.

Returns:

The return type specified by the visitor.