com.exalead.search.query.prefix

Class AlphanumPrefix

java.lang.Object

com.exalead.search.query.node.NodeVisitor

com.exalead.search.query.prefix.AlphanumPrefix

All Implemented Interfaces:

PrefixHandler

public class AlphanumPrefix
extends NodeVisitor
implements PrefixHandler

Sets multiple index fields on all alphanum below the prefix.
This handler can perform either a OR or MAX expansion.
This handler removes the PrefixNode.
This handler also handles the autoWildcard option during the post parse phase

Nested Class Summary

Nested classes/interfaces inherited from interface com.exalead.search.query.prefix.PrefixHandler

PrefixHandler.ErrorBehaviour, PrefixHandler.NoHooks, PrefixHandler.Phase

Field Summary

Fields

Modifier and Type	Field and Description
PrefixHandler.ErrorBehaviour	errorBehaviour
java.lang.String[]	forcedDynamicMetaNames
int	minPrefixSize
boolean	patternSearch
int	patternSearchMaxNbLists
boolean	performMAX
java.lang.String[]	targetIndexFields
int[]	targetIndexFieldWeights
boolean	useNestedPrefixAsDynamicMeta
boolean	usePrefixNameAsDynamicMeta

Constructor Summary

Constructors

Constructor and Description
AlphanumPrefix(java.lang.String[] targetIndexFields, int[] targetIndexFieldWeights, boolean performMAX)
AlphanumPrefix(java.lang.String[] targetIndexFields, int[] targetIndexFieldWeights, boolean performMAX, boolean patternSearch, int minPrefixSize)
AlphanumPrefix(java.lang.String[] targetIndexFields, int[] targetIndexFieldWeights, boolean performMAX, boolean patternSearch, int patternSearchMaxNbLists, int minPrefixSize)
AlphanumPrefix(java.lang.String[] targetIndexFields, int[] targetIndexFieldWeights, boolean performMAX, int minPrefixSize)

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 context) 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.
Node	visit(AlphanumValue node)
Node	visit(Sequence node)
Node	visit(UserQueryChunk node)
Node	visit(UserQueryRegexp 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, visitNary, visitUnary

Methods inherited from class java.lang.Object

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

Field Detail

usePrefixNameAsDynamicMeta

public boolean usePrefixNameAsDynamicMeta

useNestedPrefixAsDynamicMeta

public boolean useNestedPrefixAsDynamicMeta

forcedDynamicMetaNames

public java.lang.String[] forcedDynamicMetaNames

performMAX

public boolean performMAX

minPrefixSize

public int minPrefixSize

patternSearch

public final boolean patternSearch

patternSearchMaxNbLists

public final int patternSearchMaxNbLists

targetIndexFields

public java.lang.String[] targetIndexFields

targetIndexFieldWeights

public int[] targetIndexFieldWeights

errorBehaviour

public PrefixHandler.ErrorBehaviour errorBehaviour

Constructor Detail

AlphanumPrefix

public AlphanumPrefix(java.lang.String[] targetIndexFields,
                      int[] targetIndexFieldWeights,
                      boolean performMAX,
                      boolean patternSearch,
                      int patternSearchMaxNbLists,
                      int minPrefixSize)

AlphanumPrefix

public AlphanumPrefix(java.lang.String[] targetIndexFields,
                      int[] targetIndexFieldWeights,
                      boolean performMAX,
                      boolean patternSearch,
                      int minPrefixSize)

AlphanumPrefix

public AlphanumPrefix(java.lang.String[] targetIndexFields,
                      int[] targetIndexFieldWeights,
                      boolean performMAX)

AlphanumPrefix

public AlphanumPrefix(java.lang.String[] targetIndexFields,
                      int[] targetIndexFieldWeights,
                      boolean performMAX,
                      int minPrefixSize)

Method Detail

handlePrefix

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

Description copied from interface: PrefixHandler

Handle a given prefix node.

Specified by:

handlePrefix in interface PrefixHandler

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

public void setErrorBehaviour(PrefixHandler.ErrorBehaviour behaviour)

Description copied from interface: PrefixHandler

Choose the error behaviour of the prefix handler.

Specified by:

setErrorBehaviour in interface PrefixHandler

visit

public Node visit(UserQueryRegexp node)

Overrides:

visit in class NodeVisitor

visit

public Node visit(Sequence node)
           throws QueryProcessingException

Overrides:

visit in class NodeVisitor

Throws:

QueryProcessingException

visit

public Node visit(AlphanumValue node)
           throws QueryProcessingException

Overrides:

visit in class NodeVisitor

Throws:

QueryProcessingException

visit

public Node visit(UserQueryChunk node)
           throws QueryProcessingException

Overrides:

visit in class NodeVisitor

Throws:

QueryProcessingException

onInit

public void onInit(PrefixHandlerContext context)

Description copied from interface: PrefixHandler

Called when this instance of the prefix handler is initialized.

Specified by:

onInit in interface PrefixHandler

onDeinit

public void onDeinit()

Description copied from interface: PrefixHandler

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.

Specified by:

onDeinit in interface PrefixHandler

onQuery

public void onQuery(QueryContext context)
             throws QueryProcessingException

Description copied from interface: PrefixHandler

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.

Specified by:

onQuery in interface PrefixHandler

Throws:

QueryProcessingException