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

Interface CustomFieldSearcherClauseHandler

All Known Implementing Classes:

DateRangeSearcherClauseHandler, SimpleAllTextCustomFieldSearcherClauseHandler, SimpleCustomFieldClauseContextHandler, SimpleCustomFieldClauseSanitiserHandler, SimpleCustomFieldClauseSanitiserValueGeneratingHandler, SimpleCustomFieldContextValueGeneratingClauseHandler, SimpleCustomFieldSearcherClauseHandler, SimpleCustomFieldValueGeneratingClauseHandler

public interface CustomFieldSearcherClauseHandler

Provides access to objects that can perform validation and query generation for clauses generated by this searcher.

Since:

v4.0

Method Summary

Modifier and Type	Method	Description
ClauseQueryFactory	getClauseQueryFactory()	Deprecated, for removal: This API element is subject to removal in a future version. use getClauseQueryMapper() instead.
default 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.

Method Details

getClauseValidator

ClauseValidator getClauseValidator()

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

Returns:

a validator for TerminalClause's created by this searcher.

getClauseQueryFactory

@Deprecated(since="10.4",
            forRemoval=true)
ClauseQueryFactory getClauseQueryFactory()

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

use getClauseQueryMapper() instead.

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

Returns:

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

getClauseQueryMapper

default ClauseQueryMapper getClauseQueryMapper()

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

Returns:

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

getSupportedOperators

Set<Operator> getSupportedOperators()

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().

Returns:

a set of supported operators.

getDataType

JiraDataType getDataType()

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().

Returns:

the JiraDataType that this clause can handle.