com.endeca.infront.navigation.model
Class EqlFilter

java.lang.Object
  com.endeca.infront.navigation.model.Filter
      com.endeca.infront.navigation.model.EqlFilter

All Implemented Interfaces:

Cloneable

public class EqlFilter
extends Filter

The EqlFilter contains an EQL expression, which is used to filter the results of a search.

Constructor Summary

EqlFilter()
Creates an empty EQL filter.

EqlFilter(String expression)
Creates an EQL filter.

Method Summary

EqlFilter	clone()
boolean	equals(Object obj)
String	getExpression() Returns the EQL expression.
int	hashCode()
void	setExpression(String expression) Sets the EQL expression on this filter.
String	toString() For debugging.

Methods inherited from class com.endeca.infront.navigation.model.Filter

verifyNotNull

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EqlFilter

public EqlFilter()

Creates an empty EQL filter. The expression must be set.

See Also:

setExpression(String)

EqlFilter

public EqlFilter(String expression)

Creates an EQL filter.

Parameters:

expression - Sets the EQL expression. Cannot be null.

Throws:

IllegalArgumentException - if expression is null.

See Also:

setExpression(String)

Method Detail

getExpression

public String getExpression()

Returns the EQL expression.

Returns:

the EQL expression.

See Also:

setExpression(String)

setExpression

public void setExpression(String expression)

Sets the EQL expression on this filter. Cannot be null. For example: collection()/record[endeca:matches(., "product.description", searchTerms)]

Parameters:

expression - the EQL expression. Cannot be null.

Throws:

IllegalArgumentException - if expression is null.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

For debugging.

Overrides:

toString in class Object

clone

public EqlFilter clone()

Overrides:

clone in class Filter