Package com.endeca.portal.data.functions

Interface Summary

Interface	Description
SingleAttributeFilter	Implementations of this interface are a QueryFilter that acts upon a single attribute.

Class Summary

Class	Description
ArbitraryLQLASTFilter	Abstract superclass for DataSourceFilter and SelectionFilter.
AttributeTextValueSearchConfig
BreadcrumbsConfig	Configure how breadcrumbs will be returned on the QueryState's executed results.
CatalogDataSourceFilter	This filter extends SelectionFilter and not DataSourceFilter so that UNFILTERED queries are not limited by this filter.
CreatedByMeFilter
DataSourceFilter	LQL 2.3-compliant QueryFilter that adds an arbitrary LQL expression to the DataSourceFilter of the current QueryState.
DateFilter	This method implements an LQLFilter to be added to the QueryState to represent a date item, backed by an mdex:datetime object in Endeca Server.
DateFilterDimension	This class defines a full date in a complex date.
DateRangeFilter	Inherit RangeFilter class to store the selection level and format style info into data source.
DateRefinementDatePart	This class indicates a value pairing between a DatePart and it's relevant value (ie.
DurationRangeFilter	Inherit RangeFilter class to store the selection level and format style info into data source.
GeoFilter	Inherit RangeFilter class and support a 'locationName' field which describes the address name for the RangeFilter refinement of which RangeType is GEOCODE.
JoinFilter	Wraps Endeca Server's notion of com.endeca.mdex.conversation.JoinFilter.
LastNDateFilter	This query function returns the last n of the supplied date part.
LQLQueryConfig
NegativeRefinementFilter	NegativeRefinementFilter provides a LQL filter for filtering out all records associated with a refinement.
NullnessFilter
PrimaryDatasetJoinFilterset	This filter type is similar to JoinFilter but instead wraps a series of DataSetLinks that should be applied to queries originating from a particular Studio page.
QueryConfig	A subclass of QueryFunction.
QueryFilter	A subclass of QueryFunction.
QueryFunction	The base class of all QueryFunctions.
RangeFilter	This filter class allows range filters to be added to QueryState instances.
RecordDetailsConfig	Filter your MDEX query by a set of record specs.
RefinementFilter	Defines a single refinement to be added to a QueryState.
ResultsConfig	Configure how results will be returned from the results of an executed QueryState.
ResultsSummaryConfig	Configure the summarization of results returned from an executed QueryState.
SearchAdjustmentsConfig	Configure how search adjustments will be returned on the QueryState's executed results.
SearchFilter	Permits adding a keyword search to a QueryState.
SearchFilter.Builder	Use this class to build a SearchFilter object.
SelectionFilter	LQL 2.3-compliant QueryFilter that adds an arbitrary LQL expression to the SelectionFilter of the current QueryState.
SortConfig	Allow a sort to be applied to records returned from an executed QueryState.
TimeRangeFilter	Inherit RangeFilter class to store the selection level and format style info into data source.

Enum Summary

Enum	Description
DateRangeFilter.SelectionLevel	Specifies the type of RangeFilter
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)
RangeFilter.RangeType	Specifies the type of RangeFilter
SearchFilter.MatchMode

Exception Summary

Exception	Description
QueryFunctionInitializationException	Exception thrown when there is a problem creating a QueryFunction from a user-supplied definition, such as a JSON Object.
QueryFunctionUnsupportedException
RangeFilter.RangeFilterCreationException	This exception is thrown when a RangeFilter could not be created
RangeFilter.RangeOperatorNotSupportedException	This exception is thrown when an invalid RangeFilter.RangeOperator is present in a RangeFilter.
RangeFilter.RangeTypeNotSupportedException	This exception is thrown when an invalid RangeFilter.RangeType is present in a RangeFilter.

Annotation Types Summary

Annotation Type	Description
OmitFromBookmarks	This annotation can be used to mark QueryFunctions that should not be included in the serialized query state that is saved to Studio bookmarks.