com.exalead.mercury.mami.search.v20

Class IndexFieldPrefixHandler

java.lang.Object

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

BaseNumericalPrefixHandler, CategoryPrefixHandler, DynamicIndexFieldPrefixHandler, GeoPrefixHandler, PositionPrefixHandler, RefinePrefixHandler, SitePrefixHandler

public abstract class IndexFieldPrefixHandler
extends QueryPrefixHandler
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 interface	IndexFieldPrefixHandler.Transformer<T>
static interface	IndexFieldPrefixHandler.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
java.lang.String	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
IndexFieldPrefixHandler()
IndexFieldPrefixHandler(IndexFieldPrefixHandler o) Copy constructor

Method Summary

Modifier and Type	Method and Description
abstract <T> T	accept(IndexFieldPrefixHandler.Transformer<T> transformer, T[] t)
abstract void	accept(IndexFieldPrefixHandler.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this IndexFieldPrefixHandler.
static IndexFieldPrefixHandler	fromString(java.lang.String s) String representation of this IndexFieldPrefixHandler.
java.lang.String	getIndexField() Index field to be targeted by this prefix.
IndexFieldPrefixHandler	makeCopy()
static IndexFieldPrefixHandler	readFrom(java.io.InputStream is) Read this IndexFieldPrefixHandler from an XML fragment.
void	setIndexField(java.lang.String indexField) Index field to be targeted by this prefix.
java.lang.String	toString() String representation of this IndexFieldPrefixHandler.
IndexFieldPrefixHandler	withAliases(java.lang.String aliases)
IndexFieldPrefixHandler	withDataModelClass(java.lang.String dataModelClass)
IndexFieldPrefixHandler	withDataModelProperty(java.lang.String dataModelProperty)
IndexFieldPrefixHandler	withDataModelState(java.lang.String dataModelState)
IndexFieldPrefixHandler	withFromDataModel(QueryPrefixHandler fromDataModel)
IndexFieldPrefixHandler	withIndexField(java.lang.String indexField)
IndexFieldPrefixHandler	withName(java.lang.String name)
IndexFieldPrefixHandler	withPrefixMatch(boolean prefixMatch)
IndexFieldPrefixHandler	withPrefixMatch(java.lang.Boolean prefixMatch)
IndexFieldPrefixHandler	withQueryExpansionConfig(java.lang.String queryExpansionConfig)
void	writeTo(java.io.OutputStream os)

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

indexField

public java.lang.String indexField

Constructor Detail

IndexFieldPrefixHandler

public IndexFieldPrefixHandler()

IndexFieldPrefixHandler

public IndexFieldPrefixHandler(IndexFieldPrefixHandler o)

Copy constructor

Method Detail

withName

public IndexFieldPrefixHandler withName(java.lang.String name)

Overrides:

withName in class QueryPrefixHandler

withAliases

public IndexFieldPrefixHandler withAliases(java.lang.String aliases)

Overrides:

withAliases in class QueryPrefixHandler

withQueryExpansionConfig

public IndexFieldPrefixHandler withQueryExpansionConfig(java.lang.String queryExpansionConfig)

Overrides:

withQueryExpansionConfig in class QueryPrefixHandler

withDataModelState

public IndexFieldPrefixHandler withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class QueryPrefixHandler

withFromDataModel

public IndexFieldPrefixHandler withFromDataModel(QueryPrefixHandler fromDataModel)

withDataModelClass

public IndexFieldPrefixHandler withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class QueryPrefixHandler

withDataModelProperty

public IndexFieldPrefixHandler withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class QueryPrefixHandler

withPrefixMatch

public IndexFieldPrefixHandler withPrefixMatch(boolean prefixMatch)

Overrides:

withPrefixMatch in class QueryPrefixHandler

withPrefixMatch

public IndexFieldPrefixHandler withPrefixMatch(java.lang.Boolean prefixMatch)

Overrides:

withPrefixMatch in class QueryPrefixHandler

setIndexField

public void setIndexField(java.lang.String indexField)

Index field to be targeted by this prefix.

getIndexField

public java.lang.String getIndexField()

Index field to be targeted by this prefix.

withIndexField

public IndexFieldPrefixHandler withIndexField(java.lang.String indexField)

makeCopy

public IndexFieldPrefixHandler makeCopy()

Overrides:

makeCopy in class QueryPrefixHandler

readFrom

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

Read this IndexFieldPrefixHandler 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 QueryPrefixHandler

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this IndexFieldPrefixHandler.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this IndexFieldPrefixHandler.

Overrides:

toString in class QueryPrefixHandler

check

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

Checks this IndexFieldPrefixHandler.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class QueryPrefixHandler

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException