com.endeca.navigation.analytics
Class FilterNot

java.lang.Object
  extended by com.endeca.navigation.analytics.FilterNot
All Implemented Interfaces:
Filter, QueryNode

public class FilterNot
extends Object
implements Filter

A FilterNot is a Filter implementing a Boolean NOT operation. The filter evaluates to true for a given record if its child filter evaluates to false for that record.


Constructor Summary
FilterNot(Filter filter)
          Creates a new FilterNot.
 
Method Summary
 Filter getFilter()
          Gets the filter sub-expression for this FilterNot.
 void setFilter(Filter filter)
          Sets the filter sub-expression for this FilterNot.
 String toString()
          Returns the string form of this FilterNot.
 String toWire()
          Returns the wire format of this FilterNot.
 void validateSyntax()
          Validates the syntax of this FilterNot.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FilterNot

public FilterNot(Filter filter)
Creates a new FilterNot. The FilterNot represents the negation of the specified filter.

Parameters:
filter - the Filter to be set.
Method Detail

getFilter

public Filter getFilter()
Gets the filter sub-expression for this FilterNot.

Returns:
The Filter sub-expression in this FilterNot.

setFilter

public void setFilter(Filter filter)
Sets the filter sub-expression for this FilterNot.

Parameters:
filter - the Filter to be set.

toString

public String toString()
Returns the string form of this FilterNot. These are of the format:
NOT(subfilter)
For example:
NOT("SalesTotal" "FilterCompare.GT" "10000")
is returned if a NOT operation is to be performed on the result of the GREATER THAN comparison.

Specified by:
toString in interface QueryNode
Overrides:
toString in class Object
Returns:
A string representation of the FilterNot in the specified format.

toWire

public String toWire()
Returns the wire format of this FilterNot. This method is not intended for public use because the wire format is subject to change.

Specified by:
toWire in interface QueryNode
Returns:
A wire format representation of this FilterNot.

validateSyntax

public void validateSyntax()
                    throws SyntaxException
Validates the syntax of this FilterNot. A FilterNot is valid if it contains a a sub-filter and that sub-filter is itself valid.

Specified by:
validateSyntax in interface QueryNode
Throws:
SyntaxException - if the syntax requirements are not satisfied.


2010 Endeca Technologies, Inc.
Endeca Confidential