com.endeca.portal.data.functions
Class TimeRangeFilter

java.lang.Object
  com.endeca.portal.data.functions.QueryFunction
      com.endeca.portal.data.functions.QueryFilter
          com.endeca.portal.data.functions.LQLFilter
              com.endeca.portal.data.functions.RangeFilter
                  com.endeca.portal.data.functions.TimeRangeFilter

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class TimeRangeFilter
extends RangeFilter

Inherit RangeFilter class to store the selection level and format style info into data source.

Author:

Endeca Technologies, Inc.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.endeca.portal.data.functions.RangeFilter

RangeFilter.RangeFilterCreationException, RangeFilter.RangeOperator, RangeFilter.RangeOperatorNotSupportedException, RangeFilter.RangeType, RangeFilter.RangeTypeNotSupportedException

Field Summary

Fields inherited from class com.endeca.portal.data.functions.QueryFunction

CLASS_PROPERTY

Constructor Summary

protected	TimeRangeFilter()
	TimeRangeFilter(java.lang.String attributeKey, RangeFilter.RangeOperator rangeOperator, java.lang.String value1, java.lang.String timeFormat) Constructs a TimeRangeFilter
	TimeRangeFilter(java.lang.String attributeKey, RangeFilter.RangeOperator rangeOperator, java.lang.String value1, java.lang.String value2, java.lang.String timeFormat) Constructs a TimeRangeFilter

Method Summary

java.lang.String	getTimeFormat()
void	setTimeFormat(java.lang.String timeFormat)
java.lang.String	toString() Creates a string representation of the TimeRangeFilter by appending location name to a string representation of the RangeFilter.

Methods inherited from class com.endeca.portal.data.functions.RangeFilter

applyToLQLFilter, getAttributeKey, getCompareString, getProperty, getRangeOperator, getRangeType, getValue1, getValue2, getValue3, passesSelectiveFilter, setAttributeKey, setProperty, setRangeOperator, setRangeType, setValue1, setValue2, setValue3

Methods inherited from class com.endeca.portal.data.functions.LQLFilter

applyToDiscoveryServiceQuery

Methods inherited from class com.endeca.portal.data.functions.QueryFunction

beforeQueryStateAdd, clone, equals, equals, getName, getOriginatingDataSourceId, getVersion, hashCode, initializeFromJSON, setName, setOriginatingDataSourceId, setVersion, upgrade

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeRangeFilter

protected TimeRangeFilter()

TimeRangeFilter

public TimeRangeFilter(java.lang.String attributeKey,
                       RangeFilter.RangeOperator rangeOperator,
                       java.lang.String value1,
                       java.lang.String value2,
                       java.lang.String timeFormat)
                throws RangeFilter.RangeFilterCreationException

Constructs a TimeRangeFilter

Parameters:

attributeKey -

rangeOperator -

value1 -

value2 -

timeFormat -

unit -

Throws:

RangeFilterCreationException

RangeFilter.RangeFilterCreationException

TimeRangeFilter

public TimeRangeFilter(java.lang.String attributeKey,
                       RangeFilter.RangeOperator rangeOperator,
                       java.lang.String value1,
                       java.lang.String timeFormat)
                throws RangeFilter.RangeFilterCreationException

Constructs a TimeRangeFilter

Parameters:

attributeKey -

rangeOperator -

value1 -

value2 -

timeFormat -

unit -

Throws:

RangeFilterCreationException

RangeFilter.RangeFilterCreationException

Method Detail

getTimeFormat

public java.lang.String getTimeFormat()

Returns:

the timeFormat

setTimeFormat

public void setTimeFormat(java.lang.String timeFormat)

Parameters:

timeFormat - the timeFormat to set

toString

public java.lang.String toString()

Creates a string representation of the TimeRangeFilter by appending location name to a string representation of the RangeFilter. By doing this, two GeoFilter with different locationName will never be considered equal.

Overrides:

toString in class RangeFilter