com.atlassian.jira.issue.customfields.statistics

Class CustomFieldSearchRequestAppender

java.lang.Object

com.atlassian.jira.issue.customfields.statistics.CustomFieldSearchRequestAppender

All Implemented Interfaces:

SearchRequestAppender

public class CustomFieldSearchRequestAppender
extends Object
implements SearchRequestAppender

This is an implementation of SearchRequestAppender suitable for handling custom field values. This is typically used by subclasses of AbstractCustomFieldStatisticsMapper which also implement SearchRequestAppender.Factory.

Since:

v6.0

See Also:

SearchRequestAppender, AbstractCustomFieldStatisticsMapper, SearchRequestAppender.Factory, CustomField

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.jira.issue.search.SearchRequestAppender

SearchRequestAppender.Factory<T>

Constructor Summary

Constructors

Constructor and Description
CustomFieldSearchRequestAppender(CustomField customField, AbstractCustomFieldStatisticsMapper customFieldStatisticsMapper)

Method Summary

Modifier and Type	Method and Description
SearchRequest	appendExclusiveMultiValueClause(Iterable values, SearchRequest searchRequest) Append a multi-value clause to the given SearchRequest, specifying that the given values should not be included.
SearchRequest	appendInclusiveSingleValueClause(Object value, SearchRequest searchRequest) Append a single AND clause to the given SearchRequest, specifying that the given single value should be included.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomFieldSearchRequestAppender

public CustomFieldSearchRequestAppender(CustomField customField,
                                        AbstractCustomFieldStatisticsMapper customFieldStatisticsMapper)

Method Detail

appendInclusiveSingleValueClause

public SearchRequest appendInclusiveSingleValueClause(Object value,
                                                      SearchRequest searchRequest)

Description copied from interface: SearchRequestAppender

Append a single AND clause to the given SearchRequest, specifying that the given single value should be included.

Specified by:

appendInclusiveSingleValueClause in interface SearchRequestAppender

Parameters:

value - The value used to populate the new clause.

searchRequest - The existing query to be used as the basis for the new query. Will not be modified.

Returns:

A new SearchRequest containing the modified query, or null if the new clause cannot be added.

appendExclusiveMultiValueClause

public SearchRequest appendExclusiveMultiValueClause(Iterable values,
                                                     SearchRequest searchRequest)

Description copied from interface: SearchRequestAppender

Append a multi-value clause to the given SearchRequest, specifying that the given values should not be included.

Specified by:

appendExclusiveMultiValueClause in interface SearchRequestAppender

Parameters:

values - The values used to populate the new clause

searchRequest - The existing query to be used as the basis for the new query. Will not be modified.

Returns:

A new SearchRequest containing the modified query, or null if the new clause cannot be added.