com.endeca.portal.data.functions
Class GeoFilter

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.GeoFilter

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class GeoFilter
extends RangeFilter

Inherit RangeFilter class and support a 'locationName' field which describes the address name for the RangeFilter refinement of which RangeType is GEOCODE.

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

static java.lang.String	KM
static java.lang.String	MI

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

CLASS_PROPERTY

Constructor Summary

protected	GeoFilter()
	GeoFilter(java.lang.String attributeKey, RangeFilter.RangeOperator rangeOperator, java.lang.String value1, java.lang.String radius, java.lang.String locationName, java.lang.String unit) Constructs a GeoFilter

Method Summary

java.lang.String	getLocationName()
java.lang.String	getRadius()
java.lang.String	getUnit()
void	setLocationName(java.lang.String locationName)
void	setRadius(java.lang.String radius)
void	setUnit(java.lang.String unit)
java.lang.String	toString() Creates a string representation of the GeoFilter by appending location name to a string representation of the RangeFilter.

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

applyToLQLFilter, getAttributeKey, getProperty, getRangeOperator, getRangeType, getValue1, getValue2, getValue3, 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, hashCode, initializeFromJSON, setName

Methods inherited from class java.lang.Object

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

Field Detail

KM

public static final java.lang.String KM

See Also:

Constant Field Values

MI

public static final java.lang.String MI

See Also:

Constant Field Values

Constructor Detail

GeoFilter

protected GeoFilter()

GeoFilter

public GeoFilter(java.lang.String attributeKey,
                 RangeFilter.RangeOperator rangeOperator,
                 java.lang.String value1,
                 java.lang.String radius,
                 java.lang.String locationName,
                 java.lang.String unit)
          throws RangeFilter.RangeFilterCreationException

Constructs a GeoFilter

Parameters:

attributeKey -

rangeOperator -

value1 -

radius -

locationName -

unit -

Throws:

RangeFilterCreationException

RangeFilter.RangeFilterCreationException

Method Detail

getRadius

public java.lang.String getRadius()

setRadius

public void setRadius(java.lang.String radius)
               throws java.lang.NumberFormatException

Throws:

java.lang.NumberFormatException

getUnit

public java.lang.String getUnit()

setUnit

public void setUnit(java.lang.String unit)
             throws java.lang.NumberFormatException

Throws:

java.lang.NumberFormatException

getLocationName

public java.lang.String getLocationName()

setLocationName

public void setLocationName(java.lang.String locationName)

toString

public java.lang.String toString()

Creates a string representation of the GeoFilter 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