com.exalead.search.query.prefix

Interface PrefixHandler

All Known Implementing Classes:

AlphanumPrefix, BaseNumericalPrefix, CategoryPrefix, CustomPrefixHandler, DatePrefix, DynamicDateFieldPrefix, DynamicNumericalFieldPrefix, EnumFacetPrefixHandler, ErrorPrefix, GeoPrefix, KeywordPrefix, NoOpPrefix, NoSpellCheck, NumericalPrefix, PositionPrefix, PrefixHandler.NoHooks, RefinePrefix, SimilarDocumentPrefix, SitePrefix, SplitPrefix, TemplatePrefix, UnitsOfMeasurementPrefix, UnixTimestampPrefix

public interface PrefixHandler

Handle a given prefix within the scope of a NodeVisitor.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PrefixHandler.ErrorBehaviour What to do when the prefix handler cannot work
static class	PrefixHandler.NoHooks
static class	PrefixHandler.Phase Processing phase for the prefix

Method Summary

Modifier and Type	Method and Description
Node	handlePrefix(PrefixHandler.Phase phase, PrefixNode node, NodeVisitor parentVisitor, QueryContext queryContext) Handle a given prefix node.
void	onDeinit() Called when this instance of the prefix handler is deinitialized.
void	onInit(PrefixHandlerContext prefixHandlerContext) Called when this instance of the prefix handler is initialized.
void	onQuery(QueryContext context) Called when a query is about to be processed.
void	setErrorBehaviour(PrefixHandler.ErrorBehaviour behaviour) Choose the error behaviour of the prefix handler.

Method Detail

onInit

void onInit(PrefixHandlerContext prefixHandlerContext)
     throws java.lang.Exception

Called when this instance of the prefix handler is initialized.

Throws:

java.lang.Exception

onDeinit

void onDeinit()
       throws java.lang.Exception

Called when this instance of the prefix handler is deinitialized. This instance will not be reused after this. Cleanup of instance resources should be done here rather than in a finalizer, as it offers a better control on the resource lifecycle.

Throws:

java.lang.Exception

onQuery

void onQuery(QueryContext context)
      throws QueryProcessingException

Called when a query is about to be processed. handlePrefix() will then be called for each prefix matching. Note that onQuery might be called without handlePrefix being called if no prefix in the query matches this prefix handler.

Throws:

QueryProcessingException

handlePrefix

Node handlePrefix(PrefixHandler.Phase phase,
                  PrefixNode node,
                  NodeVisitor parentVisitor,
                  QueryContext queryContext)
           throws QueryProcessingException

Handle a given prefix node.

Parameters:

phase - the "Phase" of the prefix handler, indicating how far in the pipeline we are.In the standard chain, 4 phases are defined: PRE_LINGUISTIC, PRE_TRANSFORM, PRE_MAP, POST_MAP

node - The prefix node to handle

parentVisitor - If your handler is not "terminal", ie, if it supports nesting, it should call this visitor to visit the prefix node's content, additionally to performing its work. Warning: this can be null, in that case, you must not delegate.
For example, a "URL" node handler might be terminal (ie, it will "eat" all its content), whereas a "soundlike" handler will not be. It will only set the correct expansion options and pass control to lower prefixes, to support things like: soundslike:(foo OR bar OR text:coin)

queryContext - access to overridable query-related parameters

Throws:

QueryProcessingException

setErrorBehaviour

void setErrorBehaviour(PrefixHandler.ErrorBehaviour behaviour)

Choose the error behaviour of the prefix handler.