Package com.atlassian.jira.issue.customfields.searchers

Class SimpleCustomFieldSearcherClauseHandler

java.lang.Object

com.atlassian.jira.issue.customfields.searchers.SimpleCustomFieldSearcherClauseHandler

All Implemented Interfaces:

CustomFieldSearcherClauseHandler

Direct Known Subclasses:

DateRangeSearcherClauseHandler, SimpleAllTextCustomFieldSearcherClauseHandler, SimpleCustomFieldClauseContextHandler, SimpleCustomFieldClauseSanitiserHandler, SimpleCustomFieldValueGeneratingClauseHandler

@NonInjectableComponent
public class SimpleCustomFieldSearcherClauseHandler
extends Object
implements CustomFieldSearcherClauseHandler

A simple implementation of the CustomFieldSearcherClauseHandler.

Since:

v4.0

Constructor Summary

Constructors

Constructor	Description
SimpleCustomFieldSearcherClauseHandler(ClauseValidator validator, ClauseQueryFactory clauseQueryFactory, ClauseQueryMapper clauseQueryMapper, Set<Operator> supportedOperators, JiraDataType supportedType)	Deprecated, for removal: This API element is subject to removal in a future version. since 10.4.
SimpleCustomFieldSearcherClauseHandler(ClauseValidator validator, ClauseQueryFactory clauseQueryFactory, Set<Operator> supportedOperators, JiraDataType supportedType)	Deprecated, for removal: This API element is subject to removal in a future version. since 10.4.
SimpleCustomFieldSearcherClauseHandler(ClauseValidator validator, ClauseQueryMapper clauseQueryMapper, Set<Operator> supportedOperators, JiraDataType supportedType)

Method Summary

Modifier and Type	Method	Description
ClauseQueryFactory	getClauseQueryFactory()	Provides a lucene query generator for TerminalClause's created by this searcher.
ClauseQueryMapper	getClauseQueryMapper()	Provides a search query generator for TerminalClause's created by this searcher.
ClauseValidator	getClauseValidator()	Provides a validator for TerminalClause's created by this searcher.
JiraDataType	getDataType()	Provides the JiraDataType that this clause handles and searches on.
Set<Operator>	getSupportedOperators()	Provides a set of the supported Operator's that this custom field searcher can handle for its searching.

Methods inherited from class java.lang.Object

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

Constructor Details

SimpleCustomFieldSearcherClauseHandler

@Deprecated(since="10.4",
            forRemoval=true)
public SimpleCustomFieldSearcherClauseHandler(ClauseValidator validator,
 ClauseQueryFactory clauseQueryFactory,
 Set<Operator> supportedOperators,
 JiraDataType supportedType)

Deprecated, for removal: This API element is subject to removal in a future version.

since 10.4. Use SimpleCustomFieldSearcherClauseHandler(ClauseValidator, ClauseQueryMapper, Set, JiraDataType) instead.

SimpleCustomFieldSearcherClauseHandler

@Deprecated(since="10.4",
            forRemoval=true)
public SimpleCustomFieldSearcherClauseHandler(ClauseValidator validator,
 ClauseQueryFactory clauseQueryFactory,
 ClauseQueryMapper clauseQueryMapper,
 Set<Operator> supportedOperators,
 JiraDataType supportedType)

Deprecated, for removal: This API element is subject to removal in a future version.

since 10.4. Use SimpleCustomFieldSearcherClauseHandler(ClauseValidator, ClauseQueryMapper, Set, JiraDataType) instead.

This constructor can be used when both clauseQueryFactory and clauseQueryMapper are used for fallback purposes.

SimpleCustomFieldSearcherClauseHandler

public SimpleCustomFieldSearcherClauseHandler(ClauseValidator validator,
 ClauseQueryMapper clauseQueryMapper,
 Set<Operator> supportedOperators,
 JiraDataType supportedType)

Method Details

getClauseValidator

public ClauseValidator getClauseValidator()

Description copied from interface: CustomFieldSearcherClauseHandler

Provides a validator for TerminalClause's created by this searcher.

Specified by:

getClauseValidator in interface CustomFieldSearcherClauseHandler

Returns:

a validator for TerminalClause's created by this searcher.

getClauseQueryFactory

public ClauseQueryFactory getClauseQueryFactory()

Description copied from interface: CustomFieldSearcherClauseHandler

Provides a lucene query generator for TerminalClause's created by this searcher.

Specified by:

getClauseQueryFactory in interface CustomFieldSearcherClauseHandler

Returns:

a lucene query generator for TerminalClause's created by this searcher.

getClauseQueryMapper

public ClauseQueryMapper getClauseQueryMapper()

Description copied from interface: CustomFieldSearcherClauseHandler

Provides a search query generator for TerminalClause's created by this searcher.

Specified by:

getClauseQueryMapper in interface CustomFieldSearcherClauseHandler

Returns:

a search query generator for TerminalClause's created by this searcher.

getSupportedOperators

public Set<Operator> getSupportedOperators()

Description copied from interface: CustomFieldSearcherClauseHandler

Provides a set of the supported Operator's that this custom field searcher can handle for its searching.

This will be used to populate the ClauseInformation.getSupportedOperators().

Specified by:

getSupportedOperators in interface CustomFieldSearcherClauseHandler

Returns:

a set of supported operators.

getDataType

public JiraDataType getDataType()

Description copied from interface: CustomFieldSearcherClauseHandler

Provides the JiraDataType that this clause handles and searches on. This allows us to infer some information about how the search will behave and how it will interact with other elements in the system.

This will be used to populate the ClauseInformation.getDataType().

Specified by:

getDataType in interface CustomFieldSearcherClauseHandler

Returns:

the JiraDataType that this clause can handle.