com.exalead.mercury.mami.search.v20

Class BaseNumericalPrefixHandler

java.lang.Object

com.exalead.mercury.mami.search.v20.QueryPrefixHandler

com.exalead.mercury.mami.search.v20.IndexFieldPrefixHandler

com.exalead.mercury.mami.search.v20.BaseNumericalPrefixHandler

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

Direct Known Subclasses:

DatePrefixHandler, NumericalPrefixHandler, UnixTimestampPrefixHandler

public abstract class BaseNumericalPrefixHandler
extends IndexFieldPrefixHandler
implements com.exalead.util.Checkable, java.io.Serializable

Base class to configure a prefix handler targeting an index field.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseNumericalPrefixHandler.DefaultOperator
static class	BaseNumericalPrefixHandler.InvalidValueAction
static interface	BaseNumericalPrefixHandler.Transformer<T>
static interface	BaseNumericalPrefixHandler.Visitor

Nested classes/interfaces inherited from class com.exalead.mercury.mami.search.v20.QueryPrefixHandler

QueryPrefixHandler.FromDataModel

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_DEFAULT_OPERATOR
static java.lang.String	DEFAULT_INVALID_VALUE_ACTION
static int	DEFAULT_LSB
static int	DEFAULT_MSB
static boolean	DEFAULT_USE_RETRIEVED
java.lang.String	defaultOperator
java.lang.String	invalidValueAction
int	lsb
int	msb
boolean	useRetrieved

Fields inherited from class com.exalead.mercury.mami.search.v20.IndexFieldPrefixHandler

indexField

Fields inherited from class com.exalead.mercury.mami.search.v20.QueryPrefixHandler

aliases, dataModelClass, dataModelProperty, dataModelState, DEFAULT_PREFIX_MATCH, fromDataModel, name, prefixMatch, queryExpansionConfig

Constructor Summary

Constructors

Constructor and Description
BaseNumericalPrefixHandler()
BaseNumericalPrefixHandler(BaseNumericalPrefixHandler o) Copy constructor

Method Summary

Modifier and Type	Method and Description
abstract <T> T	accept(BaseNumericalPrefixHandler.Transformer<T> transformer, T[] t)
abstract void	accept(BaseNumericalPrefixHandler.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this BaseNumericalPrefixHandler.
static BaseNumericalPrefixHandler	fromString(java.lang.String s) String representation of this BaseNumericalPrefixHandler.
java.lang.String	getDefaultOperator() Default numerical operator to use if the field is given with ':'
BaseNumericalPrefixHandler.DefaultOperator	getDefaultOperatorAsEnum() Default numerical operator to use if the field is given with ':'
java.lang.String	getInvalidValueAction() What to do when an invalid numerical value is passed: remove: removes the whole prefix XXX ignore: ? XXX error: fails the query
BaseNumericalPrefixHandler.InvalidValueAction	getInvalidValueActionAsEnum() What to do when an invalid numerical value is passed: remove: removes the whole prefix XXX ignore: ? XXX error: fails the query
int	getLsb() Least significant bit to search in (only if using retrieved)
int	getMsb() Most significant bit to search in (only if using retrieved)
static boolean	isA(java.lang.String str, BaseNumericalPrefixHandler.DefaultOperator item)
static boolean	isA(java.lang.String str, BaseNumericalPrefixHandler.InvalidValueAction item)
static boolean	isOneOf(java.lang.String str, BaseNumericalPrefixHandler.DefaultOperator... items)
static boolean	isOneOf(java.lang.String str, BaseNumericalPrefixHandler.InvalidValueAction... items)
boolean	isUseRetrieved() Search using the "retrieved" part of the index. Searching in the retrieved part of a numerical field is faster when this condition is not very restrictive (i.e.
BaseNumericalPrefixHandler	makeCopy()
static BaseNumericalPrefixHandler	readFrom(java.io.InputStream is) Read this BaseNumericalPrefixHandler from an XML fragment.
void	setDefaultOperator(BaseNumericalPrefixHandler.DefaultOperator item) Default numerical operator to use if the field is given with ':'
void	setDefaultOperator(java.lang.String defaultOperator) Default numerical operator to use if the field is given with ':'
void	setInvalidValueAction(BaseNumericalPrefixHandler.InvalidValueAction item) What to do when an invalid numerical value is passed: remove: removes the whole prefix XXX ignore: ? XXX error: fails the query
void	setInvalidValueAction(java.lang.String invalidValueAction) What to do when an invalid numerical value is passed: remove: removes the whole prefix XXX ignore: ? XXX error: fails the query
void	setLsb(int lsb) Least significant bit to search in (only if using retrieved)
void	setMsb(int msb) Most significant bit to search in (only if using retrieved)
void	setUseRetrieved(boolean useRetrieved) Search using the "retrieved" part of the index. Searching in the retrieved part of a numerical field is faster when this condition is not very restrictive (i.e.
java.lang.String	toString() String representation of this BaseNumericalPrefixHandler.
BaseNumericalPrefixHandler	withAliases(java.lang.String aliases)
BaseNumericalPrefixHandler	withDataModelClass(java.lang.String dataModelClass)
BaseNumericalPrefixHandler	withDataModelProperty(java.lang.String dataModelProperty)
BaseNumericalPrefixHandler	withDataModelState(java.lang.String dataModelState)
BaseNumericalPrefixHandler	withDefaultOperator(java.lang.String defaultOperator)
BaseNumericalPrefixHandler	withFromDataModel(QueryPrefixHandler fromDataModel)
BaseNumericalPrefixHandler	withIndexField(java.lang.String indexField)
BaseNumericalPrefixHandler	withInvalidValueAction(java.lang.String invalidValueAction)
BaseNumericalPrefixHandler	withLsb(int lsb)
BaseNumericalPrefixHandler	withLsb(java.lang.Integer lsb)
BaseNumericalPrefixHandler	withMsb(int msb)
BaseNumericalPrefixHandler	withMsb(java.lang.Integer msb)
BaseNumericalPrefixHandler	withName(java.lang.String name)
BaseNumericalPrefixHandler	withPrefixMatch(boolean prefixMatch)
BaseNumericalPrefixHandler	withPrefixMatch(java.lang.Boolean prefixMatch)
BaseNumericalPrefixHandler	withQueryExpansionConfig(java.lang.String queryExpansionConfig)
BaseNumericalPrefixHandler	withUseRetrieved(boolean useRetrieved)
BaseNumericalPrefixHandler	withUseRetrieved(java.lang.Boolean useRetrieved)
void	writeTo(java.io.OutputStream os)

Methods inherited from class com.exalead.mercury.mami.search.v20.IndexFieldPrefixHandler

accept, accept, getIndexField, setIndexField

Methods inherited from class com.exalead.mercury.mami.search.v20.QueryPrefixHandler

accept, accept, getAliases, getDataModelClass, getDataModelProperty, getDataModelState, getFromDataModel, getName, getQueryExpansionConfig, isPrefixMatch, setAliases, setDataModelClass, setDataModelProperty, setDataModelState, setFromDataModel, setName, setPrefixMatch, setQueryExpansionConfig

Methods inherited from class java.lang.Object

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

Field Detail

defaultOperator

public java.lang.String defaultOperator

DEFAULT_DEFAULT_OPERATOR

public static final java.lang.String DEFAULT_DEFAULT_OPERATOR

See Also:

Constant Field Values

invalidValueAction

public java.lang.String invalidValueAction

DEFAULT_INVALID_VALUE_ACTION

public static final java.lang.String DEFAULT_INVALID_VALUE_ACTION

See Also:

Constant Field Values

useRetrieved

public boolean useRetrieved

DEFAULT_USE_RETRIEVED

public static final boolean DEFAULT_USE_RETRIEVED

See Also:

Constant Field Values

lsb

public int lsb

DEFAULT_LSB

public static final int DEFAULT_LSB

See Also:

Constant Field Values

msb

public int msb

DEFAULT_MSB

public static final int DEFAULT_MSB

See Also:

Constant Field Values

Constructor Detail

BaseNumericalPrefixHandler

public BaseNumericalPrefixHandler()

BaseNumericalPrefixHandler

public BaseNumericalPrefixHandler(BaseNumericalPrefixHandler o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          BaseNumericalPrefixHandler.DefaultOperator item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              BaseNumericalPrefixHandler.DefaultOperator... items)

setDefaultOperator

public void setDefaultOperator(BaseNumericalPrefixHandler.DefaultOperator item)

Default numerical operator to use if the field is given with ':'

getDefaultOperatorAsEnum

public BaseNumericalPrefixHandler.DefaultOperator getDefaultOperatorAsEnum()

Default numerical operator to use if the field is given with ':'

isA

public static boolean isA(java.lang.String str,
                          BaseNumericalPrefixHandler.InvalidValueAction item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              BaseNumericalPrefixHandler.InvalidValueAction... items)

setInvalidValueAction

public void setInvalidValueAction(BaseNumericalPrefixHandler.InvalidValueAction item)

What to do when an invalid numerical value is passed:

• remove: removes the whole prefix XXX
• ignore: ? XXX
• error: fails the query

getInvalidValueActionAsEnum

public BaseNumericalPrefixHandler.InvalidValueAction getInvalidValueActionAsEnum()

What to do when an invalid numerical value is passed:

• remove: removes the whole prefix XXX
• ignore: ? XXX
• error: fails the query

withIndexField

public BaseNumericalPrefixHandler withIndexField(java.lang.String indexField)

Overrides:

withIndexField in class IndexFieldPrefixHandler

withName

public BaseNumericalPrefixHandler withName(java.lang.String name)

Overrides:

withName in class IndexFieldPrefixHandler

withAliases

public BaseNumericalPrefixHandler withAliases(java.lang.String aliases)

Overrides:

withAliases in class IndexFieldPrefixHandler

withQueryExpansionConfig

public BaseNumericalPrefixHandler withQueryExpansionConfig(java.lang.String queryExpansionConfig)

Overrides:

withQueryExpansionConfig in class IndexFieldPrefixHandler

withDataModelState

public BaseNumericalPrefixHandler withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class IndexFieldPrefixHandler

withFromDataModel

public BaseNumericalPrefixHandler withFromDataModel(QueryPrefixHandler fromDataModel)

Overrides:

withFromDataModel in class IndexFieldPrefixHandler

withDataModelClass

public BaseNumericalPrefixHandler withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class IndexFieldPrefixHandler

withDataModelProperty

public BaseNumericalPrefixHandler withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class IndexFieldPrefixHandler

withPrefixMatch

public BaseNumericalPrefixHandler withPrefixMatch(boolean prefixMatch)

Overrides:

withPrefixMatch in class IndexFieldPrefixHandler

withPrefixMatch

public BaseNumericalPrefixHandler withPrefixMatch(java.lang.Boolean prefixMatch)

Overrides:

withPrefixMatch in class IndexFieldPrefixHandler

setDefaultOperator

public void setDefaultOperator(java.lang.String defaultOperator)

Default numerical operator to use if the field is given with ':'

getDefaultOperator

public java.lang.String getDefaultOperator()

Default numerical operator to use if the field is given with ':'

withDefaultOperator

public BaseNumericalPrefixHandler withDefaultOperator(java.lang.String defaultOperator)

setInvalidValueAction

public void setInvalidValueAction(java.lang.String invalidValueAction)

What to do when an invalid numerical value is passed:

• remove: removes the whole prefix XXX
• ignore: ? XXX
• error: fails the query

getInvalidValueAction

public java.lang.String getInvalidValueAction()

What to do when an invalid numerical value is passed:

• remove: removes the whole prefix XXX
• ignore: ? XXX
• error: fails the query

withInvalidValueAction

public BaseNumericalPrefixHandler withInvalidValueAction(java.lang.String invalidValueAction)

setUseRetrieved

public void setUseRetrieved(boolean useRetrieved)

Search using the "retrieved" part of the index.
Searching in the retrieved part of a numerical field is faster when this condition is not very restrictive (i.e. when it does not divide the result set by more than 5).
It also provides the ability to restrict search to a range of bits in the numerical field.
However, it can only be used on retrievable fields.
Note that using this prefix handler is the only way to search in virtual fields.

isUseRetrieved

public boolean isUseRetrieved()

Search using the "retrieved" part of the index.
Searching in the retrieved part of a numerical field is faster when this condition is not very restrictive (i.e. when it does not divide the result set by more than 5).
It also provides the ability to restrict search to a range of bits in the numerical field.
However, it can only be used on retrievable fields.
Note that using this prefix handler is the only way to search in virtual fields.

withUseRetrieved

public BaseNumericalPrefixHandler withUseRetrieved(boolean useRetrieved)

withUseRetrieved

public BaseNumericalPrefixHandler withUseRetrieved(java.lang.Boolean useRetrieved)

setLsb

public void setLsb(int lsb)

Least significant bit to search in (only if using retrieved)

getLsb

public int getLsb()

Least significant bit to search in (only if using retrieved)

withLsb

public BaseNumericalPrefixHandler withLsb(int lsb)

withLsb

public BaseNumericalPrefixHandler withLsb(java.lang.Integer lsb)

setMsb

public void setMsb(int msb)

Most significant bit to search in (only if using retrieved)

getMsb

public int getMsb()

Most significant bit to search in (only if using retrieved)

withMsb

public BaseNumericalPrefixHandler withMsb(int msb)

withMsb

public BaseNumericalPrefixHandler withMsb(java.lang.Integer msb)

makeCopy

public BaseNumericalPrefixHandler makeCopy()

Overrides:

makeCopy in class IndexFieldPrefixHandler

readFrom

public static BaseNumericalPrefixHandler readFrom(java.io.InputStream is)
                                           throws javax.xml.bind.JAXBException

Read this BaseNumericalPrefixHandler from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Overrides:

writeTo in class IndexFieldPrefixHandler

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static BaseNumericalPrefixHandler fromString(java.lang.String s)
                                             throws javax.xml.bind.JAXBException,
                                                    java.io.UnsupportedEncodingException

String representation of this BaseNumericalPrefixHandler.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this BaseNumericalPrefixHandler.

Overrides:

toString in class IndexFieldPrefixHandler

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this BaseNumericalPrefixHandler.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class IndexFieldPrefixHandler

Throws:

com.exalead.util.TypedException

accept

public abstract void accept(BaseNumericalPrefixHandler.Visitor visitor)
                     throws com.exalead.util.TypedException

Throws:

com.exalead.util.TypedException

accept

public abstract <T> T accept(BaseNumericalPrefixHandler.Transformer<T> transformer,
                             T[] t)
                      throws com.exalead.util.TypedException

Throws:

com.exalead.util.TypedException