com.atlassian.jira.issue.search.searchers.transformer
Class VersionSearchInputTransformer

java.lang.Object
  com.atlassian.jira.issue.search.searchers.transformer.IdIndexedSearchInputTransformer<Version>
      com.atlassian.jira.issue.search.searchers.transformer.VersionSearchInputTransformer

All Implemented Interfaces:

SearchInputTransformer

public class VersionSearchInputTransformer
extends IdIndexedSearchInputTransformer<Version>

A version-specific IdIndexedSearchInputTransformer.

Since:

v4.0

Field Summary

Fields inherited from class com.atlassian.jira.issue.search.searchers.transformer.IdIndexedSearchInputTransformer

fieldFlagOperandRegistry, indexInfoResolver, operandResolver, searchContextVisibilityChecker

Constructor Summary

VersionSearchInputTransformer(ClauseNames clauseNames, String urlParameterName, IndexInfoResolver<Version> versionIndexInfoResolver, JqlOperandResolver operandResolver, FieldFlagOperandRegistry fieldFlagOperandRegistry, SearchContextVisibilityChecker searchContextVisibilityChecker, NameResolver<Version> versionResolver, VersionManager versionManager)

Method Summary

boolean	doRelevantClausesFitFilterForm(User searcher, Query query, SearchContext searchContext) Tells the caller whether or not the relevant clauses from the passed query can be represented on the issue navigator.
Clause	getSearchClause(User searcher, FieldValuesHolder fieldValuesHolder) For this implementation we expect that the fieldValuesHolder will contain a list of strings or nothing at all, if not then this will throw an exception.

Methods inherited from class com.atlassian.jira.issue.search.searchers.transformer.IdIndexedSearchInputTransformer

getDefaultIndexedInputHelper, getIndexedInputHelper, populateFromParams, populateFromQuery, validateParams

Methods inherited from class java.lang.Object

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

Constructor Detail

VersionSearchInputTransformer

public VersionSearchInputTransformer(ClauseNames clauseNames,
                                     String urlParameterName,
                                     IndexInfoResolver<Version> versionIndexInfoResolver,
                                     JqlOperandResolver operandResolver,
                                     FieldFlagOperandRegistry fieldFlagOperandRegistry,
                                     SearchContextVisibilityChecker searchContextVisibilityChecker,
                                     NameResolver<Version> versionResolver,
                                     VersionManager versionManager)

Method Detail

getSearchClause

public Clause getSearchClause(User searcher,
                              FieldValuesHolder fieldValuesHolder)

Description copied from class: IdIndexedSearchInputTransformer

For this implementation we expect that the fieldValuesHolder will contain a list of strings or nothing at all, if not then this will throw an exception.

Specified by:

getSearchClause in interface SearchInputTransformer

Overrides:

getSearchClause in class IdIndexedSearchInputTransformer<Version>

Parameters:

searcher - the user performing the search

fieldValuesHolder - contains values populated by the searchers @return Clause that represents the raw values.

Returns:

a Clause that represents the users search based on the fieldValuesHolder; null if this searcher has no responsibility in the given input.

doRelevantClausesFitFilterForm

public boolean doRelevantClausesFitFilterForm(User searcher,
                                              Query query,
                                              SearchContext searchContext)

Description copied from interface: SearchInputTransformer

Tells the caller whether or not the relevant clauses from the passed query can be represented on the issue navigator. Implementors of this method needs to ensure that it can represent *ALL* related clauses on the navigator, and that the clauses' structure conforms to the simple navigator structure.

The method should only be concerned with the clauses related to this transformer. Other irrelevant clauses should be ignored.

Specified by:

doRelevantClausesFitFilterForm in interface SearchInputTransformer

Overrides:

doRelevantClausesFitFilterForm in class IdIndexedSearchInputTransformer<Version>

Parameters:

searcher - performing this action.

query - to check if it can fit in the simple (GUI form based) issue navigator.

searchContext - contains the projects and issue types that the search and filter form is restricted to

Returns:

true if the query can be represented on navigator.