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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class NegativeRefinementFilter
extends QueryFilter

NegativeRefinementFilter provides a function for filtering out all records associated with a refinement. This filter applies to the MDEX query as a NOT record filter for the specified attributeKey and attributeValue (e.g. NOT(Vintage:1992).

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)
	NegativeRefinementFilter(java.lang.String attributeKey, java.lang.String attributeValue, java.util.List<java.lang.String> ancestors)

Method Summary

void	applyToDiscoveryServiceQuery(com.endeca.mdex.conversation.Request query) Apply this function to a Request.
java.lang.String	getAncestors()
java.util.List<java.lang.String>	getAncestorsList()
java.lang.String	getAttributeKey()
java.lang.String	getAttributeValue()
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()
void	setAncestors(java.lang.String ancestors)
void	setAncestorsList(java.util.List<java.lang.String> ancestors)
void	setAttributeKey(java.lang.String attributeKey)
void	setAttributeValue(java.lang.String attributeValue)
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.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

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)

NegativeRefinementFilter

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

Method Detail

getAttributeValue

public java.lang.String getAttributeValue()

setAttributeValue

public void setAttributeValue(java.lang.String attributeValue)

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)

getAttributeKey

public java.lang.String getAttributeKey()

setAttributeKey

public void setAttributeKey(java.lang.String attributeKey)

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)

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)

applyToDiscoveryServiceQuery

public void applyToDiscoveryServiceQuery(com.endeca.mdex.conversation.Request query)
                                  throws QueryFunctionUnsupportedException

Description copied from class: QueryFunction

Apply this function to a Request. Must be implemented by subclass.

Specified by:

applyToDiscoveryServiceQuery in class QueryFunction

Throws:

QueryFunctionUnsupportedException

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