com.endeca.portal.data.functions
Class NegativeRefinementFilter

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class NegativeRefinementFilter
extends LQLFilter

NegativeRefinementFilter provides a LQL filter for filtering out all records associated with a refinement. Its previous version was based on record filter, instead of LQL filter.

The syntax of the LQL filter expression looks like:

• NOT(IS_DESCENDANT(attributeKey, attributeValue))

The following properties will be needed to construct a NegativeRefinementFilter instance.

• attributeKey
• attributeValue
• attributeValueName (optional, same as atributeValue by default)
• attributeType (optional, String by default)
• ancestors (optional, null by default)

  Author:

  Endeca Technologies, Inc.

  See Also:

  Serialized Form

  Field Summary

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

  CLASS_PROPERTY

  Constructor Summary

  protected	NegativeRefinementFilter() Empty constructor is not public, to nudge users toward one of the more useful constructors.
  	NegativeRefinementFilter(java.lang.String attributeKey, java.lang.String attributeValue) Class constructor creating a negative refinement filter with a normal attribute of the type String or a non-hierarchical managed attribute whose value spec and name are same.
  	NegativeRefinementFilter(java.lang.String attributeKey, java.lang.String attributeValue, MDEXAttribute.PropertyType attributeType) Class constructor creating a negative refinement filter with a normal attribute of any type.
  	NegativeRefinementFilter(java.lang.String attributeKey, java.lang.String attributeValue, java.lang.String attributeType) Class constructor creating a negative refinement filter with a normal attribute of any type.
  	NegativeRefinementFilter(java.lang.String attributeKey, java.lang.String attributeValueSpec, java.lang.String attributeValueName, java.util.List<java.lang.String> ancestors) Class constructor creating a negative refinement filter for a managed attribute.
  protected	NegativeRefinementFilter(java.lang.String attributeKey, java.lang.String attributeValueSpec, java.lang.String attributeValueName, MDEXAttribute.PropertyType attributeType, java.util.List<java.lang.String> ancestors) Make this constructor not public to enforce user to choose a right constructor based on the attribute type

  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	getAncestors()
  java.util.List<java.lang.String>	getAncestorsList()
  java.lang.String	getAttributeKey()
  MDEXAttribute.PropertyType	getAttributeType()
  java.lang.String	getAttributeValue()
  java.lang.String	getAttributeValueName()
  java.lang.String	getDimensionName() Deprecated. As of Latitude 2.1, replaced by getAttributeKey()
  java.lang.String	getDimValName() Deprecated. As of Latitude 2.1, replaced by getAttributeValue()
  boolean	passesSelectiveFilter(java.util.List<java.lang.String> selectiveRefinements) Override this method for each query filter that can be restricted by the selective refinements state manager feature.
  void	setAncestors(java.lang.String ancestors)
  void	setAncestorsList(java.util.List<java.lang.String> ancestors)
  void	setAttributeKey(java.lang.String attributeKey)
  void	setAttributeType(MDEXAttribute.PropertyType attributeType)
  void	setAttributeValue(java.lang.String attributeValue)
  void	setAttributeValueName(java.lang.String attributeValueName)
  void	setDimensionName(java.lang.String dimensionName) Deprecated. As of Latitude 2.1, replaced by setAttributeKey(String)
  void	setDimValName(java.lang.String dimValName) Deprecated. As of Latitude 2.1, replaced by setAttributeValue(String)
  java.lang.String	toString() This class' toString is abstract: all concrete subclasses are expected to provide an implementation. toString is used in comparing QueryFunction instances for equality, so if you implement a QueryFunction subclass it is important that your toString implementation be consistent and deterministic.

  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, getCompareString, 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

  NegativeRefinementFilter

  protected NegativeRefinementFilter()

  Empty constructor is not public, to nudge users toward one of the more useful constructors.

  NegativeRefinementFilter

  public NegativeRefinementFilter(java.lang.String attributeKey,
                                  java.lang.String attributeValue)

  Class constructor creating a negative refinement filter with a normal attribute of the type String or a non-hierarchical managed attribute whose value spec and name are same.

  Parameters:

  attributeKey -

  attributeValue -

  NegativeRefinementFilter

  public NegativeRefinementFilter(java.lang.String attributeKey,
                                  java.lang.String attributeValue,
                                  MDEXAttribute.PropertyType attributeType)

  Class constructor creating a negative refinement filter with a normal attribute of any type.

  Parameters:

  attributeKey -

  attributeValue -

  attributeType -

  NegativeRefinementFilter

  public NegativeRefinementFilter(java.lang.String attributeKey,
                                  java.lang.String attributeValue,
                                  java.lang.String attributeType)

  Class constructor creating a negative refinement filter with a normal attribute of any type.

  Parameters:

  attributeKey -

  attributeValue -

  attributeType - A String representation of MDEXAttribute.PropertyType. Valid values are "STRING", "LONG", "BOOLEAN", "INT", "DOUBLE", "GEOCODE", "DATETIME", "TIME" and "DURATION". IllegalArgumentException will be thrown if an invalid value is present.

  NegativeRefinementFilter

  public NegativeRefinementFilter(java.lang.String attributeKey,
                                  java.lang.String attributeValueSpec,
                                  java.lang.String attributeValueName,
                                  java.util.List<java.lang.String> ancestors)

  Class constructor creating a negative refinement filter for a managed attribute.

  Parameters:

  attributeKey - the key of the managed attribute

  attributeValueSpec - the spec of the attribute value

  attributeValueName - the display name of the attribute value

  ancestors - A list of the display names of the ancestors of the specified attribute value. Set it as null if the specified attribute value is a root node or the attribute is non-hierarchical.

  NegativeRefinementFilter

  protected NegativeRefinementFilter(java.lang.String attributeKey,
                                     java.lang.String attributeValueSpec,
                                     java.lang.String attributeValueName,
                                     MDEXAttribute.PropertyType attributeType,
                                     java.util.List<java.lang.String> ancestors)

  Make this constructor not public to enforce user to choose a right constructor based on the attribute type

  Method Detail

  applyToLQLFilter

  public void applyToLQLFilter(LQLFilterCollection exprCollection)
                        throws QueryFunctionUnsupportedException

  Description copied from class: LQLFilter

  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.

  Specified by:

  applyToLQLFilter in class LQLFilter

  Parameters:

  exprCollection - the collection of all fragments to be applied

  Throws:

  QueryFunctionUnsupportedException - if the filter cannot be applied

  toString

  public java.lang.String toString()

  Description copied from class: QueryFunction

  This class' toString is abstract: all concrete subclasses are expected to provide an implementation. toString is used in comparing QueryFunction instances for equality, so if you implement a QueryFunction subclass it is important that your toString implementation be consistent and deterministic.

  Specified by:

  toString in class QueryFunction

  getAttributeValue

  public java.lang.String getAttributeValue()

  setAttributeValue

  public void setAttributeValue(java.lang.String attributeValue)

  getAttributeType

  public MDEXAttribute.PropertyType getAttributeType()

  setAttributeType

  public void setAttributeType(MDEXAttribute.PropertyType attributeType)

  getAttributeValueName

  public java.lang.String getAttributeValueName()

  setAttributeValueName

  public void setAttributeValueName(java.lang.String attributeValueName)

  getDimValName

  @Deprecated
  public java.lang.String getDimValName()

  Deprecated. As of Latitude 2.1, replaced by getAttributeValue()

  setDimValName

  @Deprecated
  public void setDimValName(java.lang.String dimValName)

  Deprecated. As of Latitude 2.1, replaced by setAttributeValue(String)

  getAncestorsList

  public java.util.List<java.lang.String> getAncestorsList()

  setAncestorsList

  public void setAncestorsList(java.util.List<java.lang.String> ancestors)

  getAncestors

  public java.lang.String getAncestors()

  setAncestors

  public void setAncestors(java.lang.String ancestors)

  getAttributeKey

  public java.lang.String getAttributeKey()

  setAttributeKey

  public void setAttributeKey(java.lang.String attributeKey)

  passesSelectiveFilter

  public boolean passesSelectiveFilter(java.util.List<java.lang.String> selectiveRefinements)

  Description copied from class: QueryFunction

  Override this method for each query filter that can be restricted by the selective refinements state manager feature. Determines whether or not the filter is valid for the current data source, given a list of valid attributes.

  Overrides:

  passesSelectiveFilter in class QueryFunction

  Parameters:

  selectiveRefinements - List of selective refinement attributes that are valid for the current data source.

  Returns:

  true if the filter is valid for the current data source

  getDimensionName

  @Deprecated
  public java.lang.String getDimensionName()

  Deprecated. As of Latitude 2.1, replaced by getAttributeKey()

  setDimensionName

  @Deprecated
  public void setDimensionName(java.lang.String dimensionName)

  Deprecated. As of Latitude 2.1, replaced by setAttributeKey(String)