com.endeca.portal.data.functions
Class LQLFilter

java.lang.Object
  extended by com.endeca.portal.data.functions.QueryFunction
      extended by com.endeca.portal.data.functions.QueryFilter
          extended by com.endeca.portal.data.functions.LQLFilter
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable
Direct Known Subclasses:
ArbitraryLQLASTFilter, RangeFilter

public abstract class LQLFilter
extends QueryFilter

A specialization of QueryFilter that supports LQL unified filters instead of Conversation Service operators. Any filters that support LQL should subclass this class instead of QueryFilter.

Author:
Endeca Technologies, Inc.
See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.endeca.portal.data.functions.QueryFunction
CLASS_PROPERTY
 
Constructor Summary
LQLFilter()
           
 
Method Summary
 void applyToDiscoveryServiceQuery(com.endeca.mdex.conversation.Request query)
          Subclasses of LQLFilter must use applyToLQLFilter(LQLFilterCollection) instead of this method.
abstract  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.
 
Methods inherited from class com.endeca.portal.data.functions.QueryFunction
beforeQueryStateAdd, clone, equals, equals, getName, hashCode, initializeFromJSON, setName, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

LQLFilter

public LQLFilter()
Method Detail

applyToLQLFilter

public abstract void applyToLQLFilter(LQLFilterCollection exprCollection)
                               throws QueryFunctionUnsupportedException
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.

Parameters:
exprCollection - the collection of all fragments to be applied
Throws:
QueryFunctionUnsupportedException - if the filter cannot be applied

applyToDiscoveryServiceQuery

public final void applyToDiscoveryServiceQuery(com.endeca.mdex.conversation.Request query)
                                        throws QueryFunctionUnsupportedException
Subclasses of LQLFilter must use applyToLQLFilter(LQLFilterCollection) instead of this method.

Specified by:
applyToDiscoveryServiceQuery in class QueryFunction
Throws:
QueryFunctionUnsupportedException