com.atlassian.jira.issue.customfields.searchers.transformer
Class VersionCustomFieldSearchInputTransformer

java.lang.Object
  com.atlassian.jira.issue.customfields.searchers.transformer.AbstractCustomFieldSearchInputTransformer
      com.atlassian.jira.issue.customfields.searchers.transformer.VersionCustomFieldSearchInputTransformer

All Implemented Interfaces:

SearchInputTransformer

public class VersionCustomFieldSearchInputTransformer
extends AbstractCustomFieldSearchInputTransformer
implements SearchInputTransformer

The SearchInputTransformer for Version custom fields.

Since:

v4.0

Constructor Summary

VersionCustomFieldSearchInputTransformer(String urlParameterName, ClauseNames clauseNames, CustomField field, IndexInfoResolver<Version> indexInfoResolver, JqlOperandResolver operandResolver, FieldFlagOperandRegistry fieldFlagOperandRegistry, SearchContextVisibilityChecker searchContextVisibilityChecker, NameResolver<Version> versionResolver, CustomFieldInputHelper customFieldInputHelper, VersionManager versionManager)

Method Summary

boolean	doRelevantClausesFitFilterForm(com.atlassian.crowd.embedded.api.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.
protected Clause	getClauseFromParams(com.atlassian.crowd.embedded.api.User searcher, CustomFieldParams params) Note: only provide a sensible implementation of this if you intend on using AbstractCustomFieldSearchInputTransformer.getSearchClause(User, com.atlassian.jira.issue.transport.FieldValuesHolder) as implemented here.
protected Clause	getClauseFromParams(com.atlassian.crowd.embedded.api.User searcher, CustomFieldParams params, FieldValuesHolder fieldValuesHolder)
protected CustomFieldParams	getParamsFromSearchRequest(com.atlassian.crowd.embedded.api.User searcher, Query query, SearchContext searchContext) Gets CustomField search parameters from the given JQL Query.
Clause	getSearchClause(com.atlassian.crowd.embedded.api.User searcher, FieldValuesHolder fieldValuesHolder) Gets the portion of the Search Query that this searcher is responsible for.

Methods inherited from class com.atlassian.jira.issue.customfields.searchers.transformer.AbstractCustomFieldSearchInputTransformer

getClauseName, getCustomField, populateFromParams, populateFromQuery, validateParams

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.jira.issue.search.searchers.transformer.SearchInputTransformer

populateFromParams, populateFromQuery, validateParams

Constructor Detail

VersionCustomFieldSearchInputTransformer

public VersionCustomFieldSearchInputTransformer(String urlParameterName,
                                                ClauseNames clauseNames,
                                                CustomField field,
                                                IndexInfoResolver<Version> indexInfoResolver,
                                                JqlOperandResolver operandResolver,
                                                FieldFlagOperandRegistry fieldFlagOperandRegistry,
                                                SearchContextVisibilityChecker searchContextVisibilityChecker,
                                                NameResolver<Version> versionResolver,
                                                CustomFieldInputHelper customFieldInputHelper,
                                                VersionManager versionManager)

Method Detail

doRelevantClausesFitFilterForm

public boolean doRelevantClausesFitFilterForm(com.atlassian.crowd.embedded.api.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

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.

getParamsFromSearchRequest

protected CustomFieldParams getParamsFromSearchRequest(com.atlassian.crowd.embedded.api.User searcher,
                                                       Query query,
                                                       SearchContext searchContext)

Description copied from class: AbstractCustomFieldSearchInputTransformer

Gets CustomField search parameters from the given JQL Query.

it may return null, indicating no search parameters for this searcher were specified, or the query will not fit into the "simple navigator".

Specified by:

getParamsFromSearchRequest in class AbstractCustomFieldSearchInputTransformer

Parameters:

searcher - User

query - JQL query

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

Returns:

CustomField search parameters from the given JQL Query.

getSearchClause

public Clause getSearchClause(com.atlassian.crowd.embedded.api.User searcher,
                              FieldValuesHolder fieldValuesHolder)

Description copied from interface: SearchInputTransformer

Gets the portion of the Search Query that this searcher is responsible for.

Specified by:

getSearchClause in interface SearchInputTransformer

Overrides:

getSearchClause in class AbstractCustomFieldSearchInputTransformer

Parameters:

searcher - performing this action.

fieldValuesHolder - contains values populated by the searchers

Returns:

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

getClauseFromParams

protected Clause getClauseFromParams(com.atlassian.crowd.embedded.api.User searcher,
                                     CustomFieldParams params)

Description copied from class: AbstractCustomFieldSearchInputTransformer

Note: only provide a sensible implementation of this if you intend on using AbstractCustomFieldSearchInputTransformer.getSearchClause(User, com.atlassian.jira.issue.transport.FieldValuesHolder) as implemented here. If you are overriding AbstractCustomFieldSearchInputTransformer.getSearchClause(User, com.atlassian.jira.issue.transport.FieldValuesHolder) then you do not have to implement this method sensibly.

Specified by:

getClauseFromParams in class AbstractCustomFieldSearchInputTransformer

Parameters:

searcher - the user performing the search

params - the custom field params

Returns:

the clause that represents the params

getClauseFromParams

protected Clause getClauseFromParams(com.atlassian.crowd.embedded.api.User searcher,
                                     CustomFieldParams params,
                                     FieldValuesHolder fieldValuesHolder)