com.attivio.util.query

Class QueryTraverser

java.lang.Object

com.attivio.util.query.QueryTraverser

All Implemented Interfaces:

LocaleAware

public abstract class QueryTraverser
extends Object
implements LocaleAware

Abstract base class for a query traverser that maintains tree state during traversal.

NOTE: This class is not thread safe.

Constructor Summary

Constructors

Constructor and Description
QueryTraverser()

Method Summary

Modifier and Type	Method and Description
protected Locale	getDefaultLocale() Get the default locale to return for getLocale().
Locale	getLocale() Gets the local associated with this object or null if not set.
Object	getParameter(String name) Gets a named property from the query.
boolean	getParameter(String name, boolean defaultValue) Gets the boolean property for this QueryStack.
double	getParameter(String name, double defaultValue) Gets a named double property for this QueryStack.
float	getParameter(String name, float defaultValue) Gets a named float property for this QueryStack.
int	getParameter(String name, int defaultValue) Gets a named integer property for this QueryStack.
Locale	getParameter(String name, Locale defaultValue) Gets a named Locale property for this QueryStack.
Object	getParameter(String name, Object defaultValue) Gets a parameter for this QueryStack.
String	getParameter(String name, String defaultValue) Gets a named String property for this QueryStack.
boolean	isExcluded() Returns true if the number of containing NOT operators is odd.
void	rewrite(FieldExpression... fields) Recursively rewrite any queries in fields.
void	rewrite(FieldExpression field) Recursively rewrite any queries in field.
void	rewrite(List<Query> queries)
Query	rewrite(Query query) Recursively rewrite query.
void	rewriteAll(QueryRequest request) Recursively rewrite all queries in request using this traverser.
protected Query	rewriteChildren(Query query, QueryHandler defaultHandler) Called to recursively rewrite children of query.
void	rewriteFacets(Collection<FacetRequest> facets) Rewrite any embedded queries in facets using handler.
void	rewriteFilters(QueryRequest request) Recursively rewrite all filter queries in request using this traverser.
protected Query	rewriteQuery(Query query) Callback method called prior to traversing the children of query.
protected Query	rewriteTree(Query query, QueryHandler defaultHandler) Called to recursively rewrite a top level query.
void	setLocale(Locale locale) Sets the local associated with this object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QueryTraverser

public QueryTraverser()

Method Detail

isExcluded

public boolean isExcluded()

Returns true if the number of containing NOT operators is odd.

getParameter

public Object getParameter(String name)

Gets a named property from the query.

getParameter

public String getParameter(String name,
                           String defaultValue)

Gets a named String property for this QueryStack.

Parameters:

name - the parameter

defaultValue - the default value

Returns:

the parameter or the defaultValue if not found

getParameter

public float getParameter(String name,
                          float defaultValue)

Gets a named float property for this QueryStack.

Parameters:

name - the parameter

defaultValue - the default value

Returns:

the parameter or the defaultValue if not found

getParameter

public Locale getParameter(String name,
                           Locale defaultValue)

Gets a named Locale property for this QueryStack.

Parameters:

name - the parameter

defaultValue - the default value

Returns:

the parameter or the defaultValue if not found/cannot parse

getParameter

public double getParameter(String name,
                           double defaultValue)

Gets a named double property for this QueryStack.

Parameters:

name - the parameter

defaultValue - the default value

Returns:

the parameter or the defaultValue if not found

getParameter

public int getParameter(String name,
                        int defaultValue)

Gets a named integer property for this QueryStack.

Parameters:

name - the parameter

defaultValue - the default value

Returns:

the parameter or the defaultValue if not found

getParameter

public boolean getParameter(String name,
                            boolean defaultValue)

Gets the boolean property for this QueryStack.

Parameters:

name - the parameter

defaultValue - the default value

Returns:

the parameter or the defaultValue if not found

getParameter

public Object getParameter(String name,
                           Object defaultValue)

Gets a parameter for this QueryStack.

Parameters:

name - the parameter

defaultValue - the default value

Returns:

the parameter or default value if not found

getLocale

public Locale getLocale()

Gets the local associated with this object or null if not set.

Specified by:

getLocale in interface LocaleAware

getDefaultLocale

protected Locale getDefaultLocale()

Get the default locale to return for getLocale().

setLocale

public void setLocale(Locale locale)

Sets the local associated with this object.

Specified by:

setLocale in interface LocaleAware

rewrite

public final Query rewrite(Query query)

Recursively rewrite query.

rewrite

public final void rewrite(FieldExpression field)

Recursively rewrite any queries in field.

rewriteAll

public final void rewriteAll(QueryRequest request)

Recursively rewrite all queries in request using this traverser.

WARNING: do not use this method unless you are sure you want to modify absolutely all queries in request.

This method rewrites all queries in: QueryRequest.getQuery(), QueryRequest.getBoostQueries(), QueryRequest.getFilters(), QueryRequest.getFields(), QueryRequest.getFacets().

rewriteFilters

public final void rewriteFilters(QueryRequest request)

Recursively rewrite all filter queries in request using this traverser.

This method rewrites all queries in: QueryRequest.getFilters(), QueryRequest.getFacets().

rewrite

public final void rewrite(List<Query> queries)

rewrite

public final void rewrite(FieldExpression... fields)

Recursively rewrite any queries in fields.

rewriteFacets

public final void rewriteFacets(Collection<FacetRequest> facets)

Rewrite any embedded queries in facets using handler.

rewriteQuery

protected Query rewriteQuery(Query query)

Callback method called prior to traversing the children of query.

rewriteTree

protected Query rewriteTree(Query query,
                            QueryHandler defaultHandler)

Called to recursively rewrite a top level query.

rewriteChildren

protected Query rewriteChildren(Query query,
                                QueryHandler defaultHandler)

Called to recursively rewrite children of query.

Override this method to provide custom traversal of children.