com.atlassian.jira.jql

Class DefaultClauseHandler

java.lang.Object

com.atlassian.jira.jql.DefaultClauseHandler

All Implemented Interfaces:

ClauseHandler

public final class DefaultClauseHandler
extends Object
implements ClauseHandler

A container for all the objects needed to process a Jql clause.

Since:

v4.0

Constructor Summary

Constructors

Constructor and Description
DefaultClauseHandler(ClauseInformation information, ClauseQueryFactory factory, DbClauseQueryFactory dbFactory, ClauseValidator validator, ClausePermissionHandler permissionHandler, ClauseContextFactory contextFactory)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
ClauseContextFactory	getClauseContextFactory()
DbClauseQueryFactory	getDbClauseFactory()
ClauseQueryFactory	getFactory()
ClauseInformation	getInformation()
ClausePermissionHandler	getPermissionHandler()
ClauseValidator	getValidator()
int	hashCode()
boolean	isDbQueryCapable() This is an interim SPI method until all searching is fully handled by the database.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultClauseHandler

public DefaultClauseHandler(ClauseInformation information,
                            ClauseQueryFactory factory,
                            @Nullable
                            DbClauseQueryFactory dbFactory,
                            ClauseValidator validator,
                            ClausePermissionHandler permissionHandler,
                            ClauseContextFactory contextFactory)

Method Detail

getInformation

public ClauseInformation getInformation()

Specified by:

getInformation in interface ClauseHandler

Returns:

an object that contains some static naming information (clause names, field id, index id) about the clause handler and its associations.

getFactory

public ClauseQueryFactory getFactory()

Specified by:

getFactory in interface ClauseHandler

Returns:

a factory that can create a lucene query for the clause.

getValidator

public ClauseValidator getValidator()

Specified by:

getValidator in interface ClauseHandler

Returns:

a validator that will inspect the clause and return any validation errors it encounters.

getPermissionHandler

public ClausePermissionHandler getPermissionHandler()

Specified by:

getPermissionHandler in interface ClauseHandler

Returns:

a permission handler that will check the users who is executing the queries permission to include the clause.

getClauseContextFactory

public ClauseContextFactory getClauseContextFactory()

Specified by:

getClauseContextFactory in interface ClauseHandler

Returns:

a clause context factory that will be able to generate the clause context

isDbQueryCapable

public boolean isDbQueryCapable()

Description copied from interface: ClauseHandler

This is an interim SPI method until all searching is fully handled by the database. Implementations of ClauseHandler should implement this and return true when they add support for returning a DBClauseQueryFactory

Specified by:

isDbQueryCapable in interface ClauseHandler

Returns:

true if this handler can generate a clause for a database backed search

getDbClauseFactory

@Nonnull
public DbClauseQueryFactory getDbClauseFactory()

Specified by:

getDbClauseFactory in interface ClauseHandler

Returns:

a factory that can create a SQL clause query factory.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object