com.exalead.mercury.mami.search.v20

Class DynamicIndexFieldPrefixHandler

java.lang.Object

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

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

com.exalead.mercury.mami.search.v20.DynamicIndexFieldPrefixHandler

All Implemented Interfaces:

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

Direct Known Subclasses:

DynamicDatePrefixHandler, DynamicNumericalPrefixHandler, DynamicTextPrefixHandler

public abstract class DynamicIndexFieldPrefixHandler
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	DynamicIndexFieldPrefixHandler.InvalidValueAction
static interface	DynamicIndexFieldPrefixHandler.Transformer<T>
static interface	DynamicIndexFieldPrefixHandler.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_INVALID_VALUE_ACTION
java.lang.String	invalidValueAction
java.lang.String	meta

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
DynamicIndexFieldPrefixHandler()
DynamicIndexFieldPrefixHandler(DynamicIndexFieldPrefixHandler o) Copy constructor

Method Summary

Modifier and Type	Method and Description
abstract <T> T	accept(DynamicIndexFieldPrefixHandler.Transformer<T> transformer, T[] t)
abstract void	accept(DynamicIndexFieldPrefixHandler.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this DynamicIndexFieldPrefixHandler.
static DynamicIndexFieldPrefixHandler	fromString(java.lang.String s) String representation of this DynamicIndexFieldPrefixHandler.
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
DynamicIndexFieldPrefixHandler.InvalidValueAction	getInvalidValueActionAsEnum() What to do when an invalid numerical value is passed: remove: removes the whole prefix XXX ignore: ? XXX error: fails the query
java.lang.String	getMeta() Meta name to search within. If null, you need to use the syntax prefix:meta:VALUE
static boolean	isA(java.lang.String str, DynamicIndexFieldPrefixHandler.InvalidValueAction item)
static boolean	isOneOf(java.lang.String str, DynamicIndexFieldPrefixHandler.InvalidValueAction... items)
DynamicIndexFieldPrefixHandler	makeCopy()
static DynamicIndexFieldPrefixHandler	readFrom(java.io.InputStream is) Read this DynamicIndexFieldPrefixHandler from an XML fragment.
void	setInvalidValueAction(DynamicIndexFieldPrefixHandler.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	setMeta(java.lang.String meta) Meta name to search within. If null, you need to use the syntax prefix:meta:VALUE
java.lang.String	toString() String representation of this DynamicIndexFieldPrefixHandler.
DynamicIndexFieldPrefixHandler	withAliases(java.lang.String aliases)
DynamicIndexFieldPrefixHandler	withDataModelClass(java.lang.String dataModelClass)
DynamicIndexFieldPrefixHandler	withDataModelProperty(java.lang.String dataModelProperty)
DynamicIndexFieldPrefixHandler	withDataModelState(java.lang.String dataModelState)
DynamicIndexFieldPrefixHandler	withFromDataModel(QueryPrefixHandler fromDataModel)
DynamicIndexFieldPrefixHandler	withIndexField(java.lang.String indexField)
DynamicIndexFieldPrefixHandler	withInvalidValueAction(java.lang.String invalidValueAction)
DynamicIndexFieldPrefixHandler	withMeta(java.lang.String meta)
DynamicIndexFieldPrefixHandler	withName(java.lang.String name)
DynamicIndexFieldPrefixHandler	withPrefixMatch(boolean prefixMatch)
DynamicIndexFieldPrefixHandler	withPrefixMatch(java.lang.Boolean prefixMatch)
DynamicIndexFieldPrefixHandler	withQueryExpansionConfig(java.lang.String queryExpansionConfig)
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

meta

public java.lang.String meta

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

Constructor Detail

DynamicIndexFieldPrefixHandler

public DynamicIndexFieldPrefixHandler()

DynamicIndexFieldPrefixHandler

public DynamicIndexFieldPrefixHandler(DynamicIndexFieldPrefixHandler o)

Copy constructor

Method Detail

isA

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

isOneOf

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

setInvalidValueAction

public void setInvalidValueAction(DynamicIndexFieldPrefixHandler.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 DynamicIndexFieldPrefixHandler.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 DynamicIndexFieldPrefixHandler withIndexField(java.lang.String indexField)

Overrides:

withIndexField in class IndexFieldPrefixHandler

withName

public DynamicIndexFieldPrefixHandler withName(java.lang.String name)

Overrides:

withName in class IndexFieldPrefixHandler

withAliases

public DynamicIndexFieldPrefixHandler withAliases(java.lang.String aliases)

Overrides:

withAliases in class IndexFieldPrefixHandler

withQueryExpansionConfig

public DynamicIndexFieldPrefixHandler withQueryExpansionConfig(java.lang.String queryExpansionConfig)

Overrides:

withQueryExpansionConfig in class IndexFieldPrefixHandler

withDataModelState

public DynamicIndexFieldPrefixHandler withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class IndexFieldPrefixHandler

withFromDataModel

public DynamicIndexFieldPrefixHandler withFromDataModel(QueryPrefixHandler fromDataModel)

Overrides:

withFromDataModel in class IndexFieldPrefixHandler

withDataModelClass

public DynamicIndexFieldPrefixHandler withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class IndexFieldPrefixHandler

withDataModelProperty

public DynamicIndexFieldPrefixHandler withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class IndexFieldPrefixHandler

withPrefixMatch

public DynamicIndexFieldPrefixHandler withPrefixMatch(boolean prefixMatch)

Overrides:

withPrefixMatch in class IndexFieldPrefixHandler

withPrefixMatch

public DynamicIndexFieldPrefixHandler withPrefixMatch(java.lang.Boolean prefixMatch)

Overrides:

withPrefixMatch in class IndexFieldPrefixHandler

setMeta

public void setMeta(java.lang.String meta)

Meta name to search within.
If null, you need to use the syntax prefix:meta:VALUE

getMeta

public java.lang.String getMeta()

Meta name to search within.
If null, you need to use the syntax prefix:meta:VALUE

withMeta

public DynamicIndexFieldPrefixHandler withMeta(java.lang.String meta)

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 DynamicIndexFieldPrefixHandler withInvalidValueAction(java.lang.String invalidValueAction)

makeCopy

public DynamicIndexFieldPrefixHandler makeCopy()

Overrides:

makeCopy in class IndexFieldPrefixHandler

readFrom

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

Read this DynamicIndexFieldPrefixHandler 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 DynamicIndexFieldPrefixHandler fromString(java.lang.String s)
                                                 throws javax.xml.bind.JAXBException,
                                                        java.io.UnsupportedEncodingException

String representation of this DynamicIndexFieldPrefixHandler.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this DynamicIndexFieldPrefixHandler.

Overrides:

toString in class IndexFieldPrefixHandler

check

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

Checks this DynamicIndexFieldPrefixHandler.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class IndexFieldPrefixHandler

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException