com.atlassian.jira.issue.search.searchers.impl
Class GenericDateSearcher

java.lang.Object
  com.atlassian.jira.issue.search.searchers.impl.AbstractIssueSearcher
      com.atlassian.jira.issue.search.searchers.impl.GenericDateSearcher

All Implemented Interfaces:

Comparable, Field, IssueSearcher

Direct Known Subclasses:

CreatedDateSearcher, DateRangeSearcher, DueDateSearcher, UpdatedDateSearcher

public class GenericDateSearcher

extends AbstractIssueSearcher

Field Summary

static String	ABSOLUTE_SUFFIX
static String	AFTER_KEY
static String	AFTER_SUFFIX
static String	BEFORE_KEY
static String	BEFORE_SUFFIX
protected DateConverter	dateConverter
protected FieldVisibilityBean	fieldVisibilityBean
static String	NEXT_KEY
static String	NEXT_SUFFIX
static String	PREVIOUS_KEY
static String	PREVIOUS_SUFFIX
static String	RELATIVE_SUFFIX

Fields inherited from class com.atlassian.jira.issue.search.searchers.impl.AbstractIssueSearcher

authenticationContext, EDIT_TEMPLATE_SUFFIX, field, VIEW_TEMPLATE_SUFFIX

Fields inherited from interface com.atlassian.jira.issue.search.searchers.IssueSearcher

I18N_BUNDLE, log

Constructor Summary

GenericDateSearcher(JiraAuthenticationContext authenticationContext, FieldVisibilityBean fieldVisibilityBean, DateConverter dateConverter)

Method Summary

String	getAfterField()
String	getAfterFieldLabel()
String	getBeforeField()
String	getBeforeFieldLabel()
String	getDescription()
String	getEditHtml(SearchContext searchContext, FieldValuesHolder fieldValuesHolder, Map displayParameters, webwork.action.Action action)
String	getId() The unique id of the field
String	getNameKey() The i18n key that is used to lookup the field's name when it is displayed
String	getNextField()
String	getPeriodLabel()
static Long	getPeriodOffset(Map fieldValuesHolder, String paramField)
static String	getPrettyField(String periodParamName)
String	getPrettyNextField()
String	getPrettyPreviousField()
String	getPreviousField()
String	getQuerySnippet(SearchRequest searchRequest) Returns a JiraUrlCodec.encode(String) encoded string representing the relevent SearchParameter in the searchRequest.
List	getRelatedIndexers() Returns a list of FieldIndexer objects.
static String	getSnippetFromFieldValuesHolder(FieldValuesHolder fieldValuesHolder)
protected Map	getVelocityParams(SearchContext searchContext, FieldLayoutItem fieldLayoutItem, FieldValuesHolder fieldValuesHolder, Map displayParameters, webwork.action.Action action)
String	getViewHtml(SearchContext searchContext, FieldValuesHolder fieldValuesHolder, Map displayParameters, webwork.action.Action action)
boolean	isRevelentForSeachRequest(SearchRequest searchRequest) Checks if the searchRequest object has SearchParameter objects that was created by the searcher
void	populateFromParams(FieldValuesHolder fieldValuesHolder, ActionParams actionParams) Populate FieldValuesHolder object with whatever values the searcher is interested in from the ActionParams
void	populateFromSearchRequest(FieldValuesHolder fieldValuesHolder, SearchRequest searchRequest) Populate FieldValuesHolder from the SearchRequest object.
void	populateSearchRequest(SearchRequest searchRequest, FieldValuesHolder fieldValuesHolder) Populate the SearchRequest with SearchParameter objects from the FieldValuesHolder
static String	prettyPrintPeriodOffset(I18nHelper i18n, long periodOffSet)
void	validateParams(SearchContext searchContext, FieldValuesHolder fieldValuesHolder, I18nHelper i18nHelper, ErrorCollection errors) Adds error meessages to the errors object if values in the fieldValuesHolder fails validation.

Methods inherited from class com.atlassian.jira.issue.search.searchers.impl.AbstractIssueSearcher

compareTo, equals, getI18n, getName, hashCode, hasPermission, init, isShown, register, renderEditTemplate, renderViewTemplate, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

AFTER_KEY

public static final String AFTER_KEY

See Also:

Constant Field Values

BEFORE_KEY

public static final String BEFORE_KEY

See Also:

Constant Field Values

NEXT_KEY

public static final String NEXT_KEY

See Also:

Constant Field Values

PREVIOUS_KEY

public static final String PREVIOUS_KEY

See Also:

Constant Field Values

ABSOLUTE_SUFFIX

public static final String ABSOLUTE_SUFFIX

See Also:

Constant Field Values

RELATIVE_SUFFIX

public static final String RELATIVE_SUFFIX

See Also:

Constant Field Values

AFTER_SUFFIX

public static final String AFTER_SUFFIX

See Also:

Constant Field Values

BEFORE_SUFFIX

public static final String BEFORE_SUFFIX

See Also:

Constant Field Values

NEXT_SUFFIX

public static final String NEXT_SUFFIX

See Also:

Constant Field Values

PREVIOUS_SUFFIX

public static final String PREVIOUS_SUFFIX

See Also:

Constant Field Values

fieldVisibilityBean

protected final FieldVisibilityBean fieldVisibilityBean

dateConverter

protected final DateConverter dateConverter

Constructor Detail

GenericDateSearcher

public GenericDateSearcher(JiraAuthenticationContext authenticationContext,
                           FieldVisibilityBean fieldVisibilityBean,
                           DateConverter dateConverter)

Method Detail

getId

public String getId()

Description copied from interface: Field

The unique id of the field

validateParams

public void validateParams(SearchContext searchContext,
                           FieldValuesHolder fieldValuesHolder,
                           I18nHelper i18nHelper,
                           ErrorCollection errors)

Description copied from interface: IssueSearcher

Adds error meessages to the errors object if values in the fieldValuesHolder fails validation.

Parameters:

searchContext - the context of the search (i.e. projects and issue types selected)

fieldValuesHolder - contains values populated by the searchers

i18nHelper -

errors -

getVelocityParams

protected Map getVelocityParams(SearchContext searchContext,
                                FieldLayoutItem fieldLayoutItem,
                                FieldValuesHolder fieldValuesHolder,
                                Map displayParameters,
                                webwork.action.Action action)

Overrides:

getVelocityParams in class AbstractIssueSearcher

populateFromParams

public void populateFromParams(FieldValuesHolder fieldValuesHolder,
                               ActionParams actionParams)

Description copied from interface: IssueSearcher

Populate FieldValuesHolder object with whatever values the searcher is interested in from the ActionParams

Parameters:

fieldValuesHolder - contains values populated by the searchers

actionParams - params from the webwork front end

populateFromSearchRequest

public void populateFromSearchRequest(FieldValuesHolder fieldValuesHolder,
                                      SearchRequest searchRequest)

Description copied from interface: IssueSearcher

Populate FieldValuesHolder from the SearchRequest object. Which SearchParameter really to take from the SR should match with the method IssueSearcher.populateSearchRequest(SearchRequest, FieldValuesHolder)

Parameters:

fieldValuesHolder - contains values populated by the searchers

searchRequest - relevent search request

See Also:

IssueSearcher.populateSearchRequest(SearchRequest, FieldValuesHolder)

populateSearchRequest

public void populateSearchRequest(SearchRequest searchRequest,
                                  FieldValuesHolder fieldValuesHolder)

Description copied from interface: IssueSearcher

Populate the SearchRequest with SearchParameter objects from the FieldValuesHolder

Parameters:

searchRequest - relevent search request

fieldValuesHolder - contains values populated by the searchers

isRevelentForSeachRequest

public boolean isRevelentForSeachRequest(SearchRequest searchRequest)

Description copied from interface: IssueSearcher

Checks if the searchRequest object has SearchParameter objects that was created by the searcher

Parameters:

searchRequest - relevent search request

Returns:

true if the searchRequest has relevent parameters to the searchers

getNameKey

public String getNameKey()

Description copied from interface: Field

The i18n key that is used to lookup the field's name when it is displayed

getEditHtml

public String getEditHtml(SearchContext searchContext,
                          FieldValuesHolder fieldValuesHolder,
                          Map displayParameters,
                          webwork.action.Action action)

Specified by:

getEditHtml in interface IssueSearcher

Overrides:

getEditHtml in class AbstractIssueSearcher

getViewHtml

public String getViewHtml(SearchContext searchContext,
                          FieldValuesHolder fieldValuesHolder,
                          Map displayParameters,
                          webwork.action.Action action)

Specified by:

getViewHtml in interface IssueSearcher

Overrides:

getViewHtml in class AbstractIssueSearcher

getQuerySnippet

public String getQuerySnippet(SearchRequest searchRequest)

Description copied from interface: IssueSearcher

Returns a JiraUrlCodec.encode(String) encoded string representing the relevent SearchParameter in the searchRequest. The queryString should be able to be converted back to the original SearchRequest. i.e. getQuerySnippet -> String -> populateFromParams -> FieldValuesHolder -> populateSearchRequest -> SearchRequest -> getQuerySnippet should return the same original string.

Parameters:

searchRequest - relevent search request

Returns:

JiraUrlCodec.encode(String) encoded string representing the relevent SearchParameter in the searchRequest

getRelatedIndexers

public List getRelatedIndexers()

Description copied from interface: IssueSearcher

Returns a list of FieldIndexer objects. The objects should be initialised and ready for action

Returns:

List of FieldIndexer objects. Must not be null. Return Collections.EMPTY_LIST if not available

getBeforeField

public String getBeforeField()

getAfterField

public String getAfterField()

getPreviousField

public String getPreviousField()

getNextField

public String getNextField()

getBeforeFieldLabel

public String getBeforeFieldLabel()

getAfterFieldLabel

public String getAfterFieldLabel()

getPeriodLabel

public String getPeriodLabel()

getDescription

public String getDescription()

getPrettyPreviousField

public String getPrettyPreviousField()

getPrettyNextField

public String getPrettyNextField()

getPrettyField

public static String getPrettyField(String periodParamName)

prettyPrintPeriodOffset

public static String prettyPrintPeriodOffset(I18nHelper i18n,
                                             long periodOffSet)

getPeriodOffset

public static Long getPeriodOffset(Map fieldValuesHolder,
                                   String paramField)

getSnippetFromFieldValuesHolder

public static String getSnippetFromFieldValuesHolder(FieldValuesHolder fieldValuesHolder)