com.exalead.search.query.processors

Interface QueryProcessor

All Known Implementing Classes:

ContentRestrictionHandler, CustomQueryProcessor, GeneralizationHandler, LanguagePropagationProcessor, QueryProcessor.NoHooks, SecurityHandler, SemanticQueryAnalyzerProcessor, SpellCheckHandler, StandardRefinementHandler, StopWordsRemover

public interface QueryProcessor

Processor for a Query. These processors are designed to be used by a SearchLogicRunner, in the standard CloudView searchserver, either as a custom hook, or in a custom SearchLogicRunner. A QueryProcessor is a thread-specific object. Several instances of the QueryProcessor will be created, as needed, by the search-api pipeline. If the processor must reference persistent thread-safe resources, it is recommended to implement a refcounting mechanism and a single instance of the resource. Don't forget that not all processors of the same class work on the same configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	QueryProcessor.NoHooks

Method Summary

Modifier and Type	Method and Description
void	onDeinit(boolean allInstances) Called when this instance of the processor is deinitialized.
void	onInit(QueryProcessorContext processorContext) Called when this instance of processor is initialized for the first time.
void	process(QueryContext context) Called to process a query with this processor.

Method Detail

onInit

void onInit(QueryProcessorContext processorContext)
     throws java.lang.Exception

Called when this instance of processor is initialized for the first time. If the processor holds persistent resources, they should be initialized here.

Parameters:

logic - the search logic for which this processor will be applied

Throws:

java.lang.Exception

onDeinit

void onDeinit(boolean allInstances)
       throws java.lang.Exception

Called when this instance of the processor 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.

Parameters:

allInstances - Hint indicating whether all instances of the processor are going to be deinitialized, or only this one.

Throws:

java.lang.Exception

process

void process(QueryContext context)
      throws QueryProcessingException

Called to process a query with this processor.

Throws:

QueryProcessingException