com.atlassian.jira.issue.search.searchers.transformer
Class TextQuerySearchInputTransformer
java.lang.Object
com.atlassian.jira.issue.search.searchers.transformer.AbstractSearchInputTransformer
com.atlassian.jira.issue.search.searchers.transformer.TextQuerySearchInputTransformer
- All Implemented Interfaces:
- SearchInputTransformer
public class TextQuerySearchInputTransformer
- extends AbstractSearchInputTransformer
A transformer that handles the 2012 Issue Search interface.
- Since:
- v5.2
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
TextQuerySearchInputTransformer
public TextQuerySearchInputTransformer(String id,
ClauseInformation information,
JqlOperandResolver operandResolver)
doRelevantClausesFitFilterForm
public boolean doRelevantClausesFitFilterForm(com.atlassian.crowd.embedded.api.User user,
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.
- Parameters:
user
- 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.
populateFromParams
public void populateFromParams(com.atlassian.crowd.embedded.api.User user,
FieldValuesHolder fieldValuesHolder,
ActionParams actionParams)
- Description copied from interface:
SearchInputTransformer
- Populate
FieldValuesHolder
object with whatever values the searcher is interested in from the
ActionParams
. This transforms the "raw" request parameters
into a form that the other processing methods can handle (usually a mapping of the fields name as the key
and a list of the values as the value).
- Parameters:
user
- performing this action.fieldValuesHolder
- is the object that should have its values set by this method and that will contain
any other values that have been set by other SearchInputTransformers.actionParams
- params from the webwork front end that contains a String[] of values as submitted via the
populateFromQuery
public void populateFromQuery(com.atlassian.crowd.embedded.api.User user,
FieldValuesHolder fieldValuesHolder,
Query query,
SearchContext searchContext)
- Description copied from interface:
SearchInputTransformer
- This method transforms any query information contained in the query that is relevant to this
SearchInputTransformer into the values that the HTML rendering expects. This should
populate the
FieldValuesHolder
from the a query information in the
query.
The query elements that are considered "relevant" to this method would be those that are produced by the
SearchInputTransformer.getSearchClause(User, com.atlassian.jira.issue.transport.FieldValuesHolder)
method.
- Parameters:
user
- performing this action.fieldValuesHolder
- is the object that should have its values set by this method and that will contain
any other values that have been set by other SearchInputTransformers.query
- the search criteria used to populate the field values holder.searchContext
- contains the projects and issue types that the search and filter form is restricted to
getSearchClause
public Clause getSearchClause(com.atlassian.crowd.embedded.api.User user,
FieldValuesHolder fieldValuesHolder)
- Description copied from interface:
SearchInputTransformer
- Gets the portion of the Search Query that this searcher is responsible for.
- Parameters:
user
- 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.
Copyright © 2002-2013 Atlassian. All Rights Reserved.