com.exalead.search.query.prefix

Class PrefixSupervisor

java.lang.Object

com.exalead.search.query.node.NodeVisitor

com.exalead.search.query.prefix.PrefixSupervisor

Direct Known Subclasses:

TemplatePrefixSupervisor

public class PrefixSupervisor
extends NodeVisitor

This visitor applies multiple PrefixHandler to a query node.
Depending on the currently selected "phase" of the visitor, one of the several call-backs of the PrefixHandler will be called.

This class also handles all data which does not actually belong to a prefix, by handling it as if it was belonging to "defaultPrefix".

The template prefix handlers are managed by the subclass TemplatePrefixSupervisor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PrefixSupervisor.MissingPrefixBehaviour

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,PrefixHandler>	handlers
java.util.Set<java.lang.String>	recognizedPrefixes

Constructor Summary

Constructors

Constructor and Description
PrefixSupervisor()

Method Summary

Modifier and Type	Method and Description
void	addHandler(java.lang.String prefix, PrefixHandler handler)
protected Node	addTemporaryDefaultPrefixNode(Node node)
protected Node	doHandle(PrefixNode node)
protected PrefixHandler	findPrefixMatch(java.lang.String prefixToUse)
java.lang.String	getDefaultPrefix()
protected PrefixHandler	getHandler(java.lang.String name)
protected Node	handleErrors(PrefixNode node)
void	onDeinit()
void	onInit(PrefixHandlerContext context)
void	onQuery(QueryContext queryContext)
void	setDefaultPrefix(java.lang.String prefix)
void	setMissingPrefixBehaviour(boolean report, PrefixSupervisor.MissingPrefixBehaviour behaviour)
void	setPhase(PrefixHandler.Phase phase)
Node	visit(PrefixNode node)
Node	visit(RootNode node)
Node	visitRecursive(Node node)

Methods inherited from class com.exalead.search.query.node.NodeVisitor

visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visitNary, visitUnary

Methods inherited from class java.lang.Object

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

Field Detail

handlers

protected java.util.Map<java.lang.String,PrefixHandler> handlers

recognizedPrefixes

public java.util.Set<java.lang.String> recognizedPrefixes

Constructor Detail

PrefixSupervisor

public PrefixSupervisor()

Method Detail

onInit

public void onInit(PrefixHandlerContext context)
            throws java.lang.Exception

Throws:

java.lang.Exception

onQuery

public void onQuery(QueryContext queryContext)
             throws QueryProcessingException

Throws:

QueryProcessingException

onDeinit

public void onDeinit()
              throws java.lang.Exception

Throws:

java.lang.Exception

setPhase

public void setPhase(PrefixHandler.Phase phase)

setMissingPrefixBehaviour

public void setMissingPrefixBehaviour(boolean report,
                                      PrefixSupervisor.MissingPrefixBehaviour behaviour)

addHandler

public void addHandler(java.lang.String prefix,
                       PrefixHandler handler)

setDefaultPrefix

public void setDefaultPrefix(java.lang.String prefix)

getDefaultPrefix

public java.lang.String getDefaultPrefix()

visit

public Node visit(PrefixNode node)
           throws QueryProcessingException

Overrides:

visit in class NodeVisitor

Throws:

QueryProcessingException

getHandler

protected PrefixHandler getHandler(java.lang.String name)

handleErrors

protected Node handleErrors(PrefixNode node)
                     throws QueryProcessingException

Throws:

QueryProcessingException

doHandle

protected Node doHandle(PrefixNode node)
                 throws QueryProcessingException

Throws:

QueryProcessingException

findPrefixMatch

protected PrefixHandler findPrefixMatch(java.lang.String prefixToUse)

visit

public Node visit(RootNode node)
           throws QueryProcessingException

Overrides:

visit in class NodeVisitor

Throws:

QueryProcessingException

visitRecursive

public Node visitRecursive(Node node)
                    throws QueryProcessingException

Throws:

QueryProcessingException

addTemporaryDefaultPrefixNode

protected Node addTemporaryDefaultPrefixNode(Node node)
                                      throws QueryProcessingException

Throws:

QueryProcessingException