|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
public class RangeFilter
This filter class allows range filters to be added to QueryState instances. Currently supported on: ENE presentation API data sources Discovery service data sources.
Nested Class Summary | |
---|---|
static class |
RangeFilter.RangeFilterCreationException
This exception is thrown when a RangeFilter could not be created |
static class |
RangeFilter.RangeOperator
Specifies the operator used in this RangeFilter
Valid RangeOperators are
LT: Less than
LTEQ: Less than or equal to
GT: Greater than
GTEQ: Greater than or equal to
BTWN: Between (inclusive)
GCLT: Geocode less than (non-inclusive)
GCGT: Geocode greater than (non-inclusive)
CGBTWN: Geocode beween (inclusive) |
static class |
RangeFilter.RangeOperatorNotSupportedException
This exception is thrown when an invalid RangeFilter.RangeOperator is present
in a RangeFilter. |
static class |
RangeFilter.RangeType
Specifies the type of RangeFilter |
static class |
RangeFilter.RangeTypeNotSupportedException
This exception is thrown when an invalid RangeFilter.RangeType is present
in a RangeFilter. |
Field Summary |
---|
Fields inherited from class com.endeca.portal.data.functions.QueryFunction |
---|
CLASS_PROPERTY |
Constructor Summary | |
---|---|
protected |
RangeFilter()
|
|
RangeFilter(java.lang.String attributeKey,
RangeFilter.RangeType rangeType,
RangeFilter.RangeOperator rangeOperator,
java.lang.String value1)
Constructs a RangeFilter |
|
RangeFilter(java.lang.String attributeKey,
RangeFilter.RangeType rangeType,
RangeFilter.RangeOperator rangeOperator,
java.lang.String value1,
java.lang.String value2)
Constructs a RangeFilter |
|
RangeFilter(java.lang.String attributeKey,
RangeFilter.RangeType rangeType,
RangeFilter.RangeOperator rangeOperator,
java.lang.String value1,
java.lang.String value2,
java.lang.String value3)
Constructs a RangeFilter |
Method Summary | |
---|---|
void |
applyToLQLFilter(LQLFilterCollection exprCollection)
Adds the LQL filtering clause (aka fragment) produced by this class to the list of all fragments to be applied in order to generate the QueryState . |
java.lang.String |
getAttributeKey()
|
java.lang.String |
getProperty()
Deprecated. As of Latitude 2.1, replaced by getAttributeKey() |
RangeFilter.RangeOperator |
getRangeOperator()
|
RangeFilter.RangeType |
getRangeType()
|
java.lang.String |
getValue1()
|
java.lang.String |
getValue2()
|
java.lang.String |
getValue3()
|
void |
setAttributeKey(java.lang.String attributeKey)
|
void |
setProperty(java.lang.String property)
Deprecated. As of Latitude 2.1, replaced by setAttributeKey(String) |
void |
setRangeOperator(RangeFilter.RangeOperator rangeOperator)
|
void |
setRangeType(RangeFilter.RangeType rangeType)
|
void |
setValue1(java.lang.String value1)
|
void |
setValue2(java.lang.String value2)
|
void |
setValue3(java.lang.String value3)
|
java.lang.String |
toString()
Creates a string representation of the RangeFilter |
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 |
Constructor Detail |
---|
protected RangeFilter()
public RangeFilter(java.lang.String attributeKey, RangeFilter.RangeType rangeType, RangeFilter.RangeOperator rangeOperator, java.lang.String value1) throws RangeFilter.RangeFilterCreationException
RangeFilter
attributeKey
- on which the range filter will operaterangeType
- rangeOperator
- value1
-
RangeFilter.RangeFilterCreationException
public RangeFilter(java.lang.String attributeKey, RangeFilter.RangeType rangeType, RangeFilter.RangeOperator rangeOperator, java.lang.String value1, java.lang.String value2) throws RangeFilter.RangeFilterCreationException
RangeFilter
attributeKey
- rangeType
- rangeOperator
- value1
- value2
-
RangeFilter.RangeFilterCreationException
public RangeFilter(java.lang.String attributeKey, RangeFilter.RangeType rangeType, RangeFilter.RangeOperator rangeOperator, java.lang.String value1, java.lang.String value2, java.lang.String value3) throws RangeFilter.RangeFilterCreationException
RangeFilter
attributeKey
- rangeType
- rangeOperator
- value1
- value2
- value3
-
RangeFilter.RangeFilterCreationException
Method Detail |
---|
public java.lang.String getAttributeKey()
RangeFilter
operatespublic void setAttributeKey(java.lang.String attributeKey)
attributeKey
- on which this RangeFilter
operates@Deprecated public java.lang.String getProperty()
getAttributeKey()
RangeFilter
operates@Deprecated public void setProperty(java.lang.String property)
setAttributeKey(String)
property
- on which this RangeFilter
operatespublic RangeFilter.RangeType getRangeType()
RangeFilter.RangeType
of this RangeFilter
public void setRangeType(RangeFilter.RangeType rangeType)
rangeType
- the RangeFilter.RangeType
of this RangeFilter
public RangeFilter.RangeOperator getRangeOperator()
RangeFilter.RangeOperator
associated with this RangeFilter
public void setRangeOperator(RangeFilter.RangeOperator rangeOperator)
rangeOperator
- associated with this RangeFilter
public java.lang.String getValue1()
public void setValue1(java.lang.String value1)
value1
- public java.lang.String getValue2()
public void setValue2(java.lang.String value2)
value2
- public java.lang.String getValue3()
public void setValue3(java.lang.String value3)
value3
- public java.lang.String toString()
RangeFilter
toString
in class QueryFunction
public void applyToLQLFilter(LQLFilterCollection exprCollection) throws QueryFunctionUnsupportedException
LQLFilter
QueryState
.
applyToLQLFilter
in class LQLFilter
exprCollection
- the collection of all fragments to be applied
QueryFunctionUnsupportedException
- if the filter cannot be applied
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |