com.endeca.itl.cas.api
Class Filter

java.lang.Object
  extended by com.endeca.itl.cas.api.Filter
Direct Known Subclasses:
ComparableValueFilter, DateFilter, RegexFilter, WildcardFilter

public abstract class Filter
extends Object

Filter is a filter that is applied to a particular property of a record. This is an abstract type, specifying the name of the property, but not the filtering.


Constructor Summary
Filter()
           
 
Method Summary
 boolean equals(Object other)
           
 String getPropertyName()
           
 FilterScope getScope()
           
 int hashCode()
           
 void setPropertyName(String value)
           
 void setScope(FilterScope value)
           
 String toString()
           
 String validate()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Filter

public Filter()
Method Detail

getScope

public FilterScope getScope()

setScope

public void setScope(FilterScope value)

getPropertyName

public String getPropertyName()

setPropertyName

public void setPropertyName(String value)

validate

public String validate()
Returns:
null if filter is valid otherwise return the error message that will be visible to the user

equals

public boolean equals(Object other)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

toString

public String toString()
Overrides:
toString in class Object


Copyright © 2011 Endeca. All Rights Reserved.