com.atlassian.jira.issue.search.searchers.util

Interface IndexedInputHelper

All Known Implementing Classes:

DefaultIndexedInputHelper, IssueConstantIndexedInputHelper, VersionIndexedInputHelper

public interface IndexedInputHelper

Provides methods for retreiving the Navigator or index representations of the values in a query clause, be they index values, functions or string values.

NOTE: this method will give back the values it finds in the named clauses and does not take into account the affects of the surrounding logical search query (i.e. AND, NOT, OR clauses that the clause may be contained in).

Since:

v4.0

Method Summary

Modifier and Type	Method and Description
Set<String>	getAllIndexValuesForMatchingClauses(ApplicationUser searcher, ClauseNames jqlClauseNames, Query query) Retrieves the index values for the clauses in the SearchRequest.
Set<String>	getAllIndexValuesForMatchingClauses(ApplicationUser searcher, ClauseNames jqlClauseNames, Query query, SearchContext searchContext) Deprecated. Since 6.3.4. The SearchContext parameter is no longer needed. Use getAllIndexValuesForMatchingClauses(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.issue.search.ClauseNames, com.atlassian.query.Query).
Set<String>	getAllNavigatorValuesForMatchingClauses(ApplicationUser searcher, ClauseNames jqlClauseNames, Query query) Retreives the navigator id values for the values in the clauses.
Set<String>	getAllNavigatorValuesForMatchingClauses(ApplicationUser searcher, ClauseNames jqlClauseNames, Query query, SearchContext searchContext) Deprecated. Since 6.3.3. The SearchContext parameter is no longer needed. Use getAllNavigatorValuesForMatchingClauses(ApplicationUser, com.atlassian.jira.issue.search.ClauseNames, com.atlassian.query.Query)
Clause	getClauseForNavigatorValues(String jqlClauseName, Set<String> values) Converts a set of Navigator value strings into a Clause that will match at least one of the specified values for the given field.

Method Detail

getAllIndexValuesForMatchingClauses

@Deprecated
Set<String> getAllIndexValuesForMatchingClauses(ApplicationUser searcher,
                                                            ClauseNames jqlClauseNames,
                                                            Query query,
                                                            SearchContext searchContext)

Deprecated. Since 6.3.4. The SearchContext parameter is no longer needed. Use getAllIndexValuesForMatchingClauses(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.issue.search.ClauseNames, com.atlassian.query.Query).

Retrieves the index values for the clauses in the SearchRequest. Function Operands are expanded to their values.

Parameters:

searcher - the user running the search

jqlClauseNames - the names of the clauses on which to retreive the values.

query - the search criteria used to populate the field values holder.

searchContext - the context under which the search is being performed

Returns:

a set of strings containing the index values of the clause values. Never null.

getAllIndexValuesForMatchingClauses

Set<String> getAllIndexValuesForMatchingClauses(ApplicationUser searcher,
                                                ClauseNames jqlClauseNames,
                                                Query query)

Retrieves the index values for the clauses in the SearchRequest. Function Operands are expanded to their values.

Parameters:

searcher - the user running the search

jqlClauseNames - the names of the clauses on which to retreive the values.

query - the search criteria used to populate the field values holder.

Returns:

a set of strings containing the index values of the clause values. Never null.

getAllNavigatorValuesForMatchingClauses

@Deprecated
Set<String> getAllNavigatorValuesForMatchingClauses(ApplicationUser searcher,
                                                                ClauseNames jqlClauseNames,
                                                                Query query,
                                                                SearchContext searchContext)

Deprecated. Since 6.3.3. The SearchContext parameter is no longer needed. Use getAllNavigatorValuesForMatchingClauses(ApplicationUser, com.atlassian.jira.issue.search.ClauseNames, com.atlassian.query.Query)

Retreives the navigator id values for the values in the clauses. If there is a flag associated with a function operand then that flag is returned, otherwise the function operand is expanded to its index values.

Parameters:

searcher - the user running the search

jqlClauseNames - the names of the clauses on which to retreive the values.

query - the search criteria used to populate the field values holder.

searchContext - the context under which the search is being performed

Returns:

a set of strings containing the navigator values of the clause values. Never Null.

getAllNavigatorValuesForMatchingClauses

Set<String> getAllNavigatorValuesForMatchingClauses(ApplicationUser searcher,
                                                    ClauseNames jqlClauseNames,
                                                    Query query)

Retreives the navigator id values for the values in the clauses. If there is a flag associated with a function operand then that flag is returned, otherwise the function operand is expanded to its index values.

Parameters:

searcher - the user running the search

jqlClauseNames - the names of the clauses on which to retreive the values.

query - the search criteria used to populate the field values holder.

Returns:

a set of strings containing the navigator values of the clause values. Never Null.

getClauseForNavigatorValues

Clause getClauseForNavigatorValues(String jqlClauseName,
                                   Set<String> values)

Converts a set of Navigator value strings into a Clause that will match at least one of the specified values for the given field.

Note: where possible, the helper should try to create a clause, even when the value strings do not make sense in the given domain. That is, it is preferred that a non-validating clause gets created than no clause at all.

Parameters:

jqlClauseName - the name of the clause to generate

values - a set of Navigator value strings; may contain flag values. May not be null.

Returns:

a clause that will match any of the values specified; null if no values were specified.