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

java.lang.Object
  com.atlassian.jira.issue.search.searchers.util.DefaultDateSearcherInputHelper

All Implemented Interfaces:

DateSearcherInputHelper

public class DefaultDateSearcherInputHelper
extends Object
implements DateSearcherInputHelper

Helper class to parse JQL clauses and determine if they are suitable for usage in the Navigator or Search URL.

Since:

v4.0

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.jira.issue.search.searchers.util.DateSearcherInputHelper

DateSearcherInputHelper.ConvertClauseResult

Constructor Summary

DefaultDateSearcherInputHelper(DateSearcherConfig config, JqlOperandResolver operandResolver, JqlDateSupport jqlDateSupport, DateConverter primaryDateConverter, DateTimeConverter dateTimeConverter)

Method Summary

DateSearcherInputHelper.ConvertClauseResult

convertClause(Clause clause, User user, boolean allowTimeComponent) Take the passed clause and try and get the equivalent navigator parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultDateSearcherInputHelper

public DefaultDateSearcherInputHelper(DateSearcherConfig config,
                                      JqlOperandResolver operandResolver,
                                      JqlDateSupport jqlDateSupport,
                                      DateConverter primaryDateConverter,
                                      DateTimeConverter dateTimeConverter)

Method Detail

convertClause

public DateSearcherInputHelper.ConvertClauseResult convertClause(Clause clause,
                                                                 User user,
                                                                 boolean allowTimeComponent)

Description copied from interface: DateSearcherInputHelper

Take the passed clause and try and get the equivalent navigator parameters. Note: this also performs a validity check on the structure of the clause to determine if it fits for the Navigator. Therefore, it is not required to check this before the call is made.

Specified by:

convertClause in interface DateSearcherInputHelper

Parameters:

clause - the clause to convert.

user - the user trying to convert the clause.

allowTimeComponent - if true, date values which aren't midnight dates will be returned as midnight dates (thereby losing precision)

Returns:

on success a map of navigator param -> value, or null on failure. The map will only contain the params that were present in the clause.