no.sesat.search.mode.command.querybuilder
Interface FilterBuilder

All Superinterfaces:

QueryBuilder, no.sesat.commons.visitor.Visitor

All Known Implementing Classes:

BaseFilterBuilder, FastAdvancedFilterBuilder, FastSimpleFilterBuilder

public interface FilterBuilder
extends QueryBuilder

An extension to a QueryBuilder for building the associated filter string.

Version:

$Id: FilterBuilder.java 7225 2009-04-09 00:32:20Z ssmiweve $

Nested Class Summary

Nested classes/interfaces inherited from interface no.sesat.search.mode.command.querybuilder.QueryBuilder

QueryBuilder.Context

Method Summary

void	addFilter(String field, String value) Add a filter.
String	getFilter(String string) Find a particular filter value.
String	getFilterString() The Filter String built from the Query's transformed clauses.

Methods inherited from interface no.sesat.search.mode.command.querybuilder.QueryBuilder

getQueryString

Methods inherited from interface no.sesat.commons.visitor.Visitor

visit

Method Detail

addFilter

void addFilter(String field,
               String value)

Add a filter. Where field is blank an anonymous filter will be added.

Parameters:

field -

value -

getFilterString

String getFilterString()

The Filter String built from the Query's transformed clauses. The filter string consists of key-value pairs usually represented key:value. The Query parser refers to these pairs as fielded clauses. By default will delegate to getQueyString()

Returns:

string built from the Query's transformed clauses, or "".

getFilter

String getFilter(String string)

Find a particular filter value.

Parameters:

string - the filter (or field) name

Returns:

the filter's (or field's) value. space separated if multiple values exist.