com.exalead.mercury.mami.search.v20

Class RefinePrefixHandler

java.lang.Object

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

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

com.exalead.mercury.mami.search.v20.RefinePrefixHandler

All Implemented Interfaces:

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

public class RefinePrefixHandler
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/interfaces inherited from class com.exalead.mercury.mami.search.v20.IndexFieldPrefixHandler

IndexFieldPrefixHandler.Transformer<T>, 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
static boolean	DEFAULT_EXCLUDED
boolean	excluded

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

Method Summary

Modifier and Type	Method and Description
<T> T	accept(IndexFieldPrefixHandler.Transformer<T> transformer, T[] t)
void	accept(IndexFieldPrefixHandler.Visitor visitor)
<T> T	accept(QueryPrefixHandler.Transformer<T> transformer, T[] t)
void	accept(QueryPrefixHandler.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this RefinePrefixHandler.
static RefinePrefixHandler	fromString(java.lang.String s) String representation of this RefinePrefixHandler.
boolean	isExcluded() Specifies whether the category must be included or excluded.
RefinePrefixHandler	makeCopy() Creates and returns a deep copy of this RefinePrefixHandler.
static RefinePrefixHandler	readFrom(java.io.InputStream is) Read this RefinePrefixHandler from an XML fragment.
void	setExcluded(boolean excluded) Specifies whether the category must be included or excluded.
java.lang.String	toString() String representation of this RefinePrefixHandler.
RefinePrefixHandler	withAliases(java.lang.String aliases)
RefinePrefixHandler	withDataModelClass(java.lang.String dataModelClass)
RefinePrefixHandler	withDataModelProperty(java.lang.String dataModelProperty)
RefinePrefixHandler	withDataModelState(java.lang.String dataModelState)
RefinePrefixHandler	withExcluded(boolean excluded)
RefinePrefixHandler	withExcluded(java.lang.Boolean excluded)
RefinePrefixHandler	withFromDataModel(QueryPrefixHandler fromDataModel)
RefinePrefixHandler	withIndexField(java.lang.String indexField)
RefinePrefixHandler	withName(java.lang.String name)
RefinePrefixHandler	withPrefixMatch(boolean prefixMatch)
RefinePrefixHandler	withPrefixMatch(java.lang.Boolean prefixMatch)
RefinePrefixHandler	withQueryExpansionConfig(java.lang.String queryExpansionConfig)
void	writeTo(java.io.OutputStream os) Write this RefinePrefixHandler as an XML fragment

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

getIndexField, setIndexField

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

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

excluded

public boolean excluded

DEFAULT_EXCLUDED

public static final boolean DEFAULT_EXCLUDED

See Also:

Constant Field Values

Constructor Detail

RefinePrefixHandler

public RefinePrefixHandler()

RefinePrefixHandler

public RefinePrefixHandler(RefinePrefixHandler o)

Copy constructor

Method Detail

withIndexField

public RefinePrefixHandler withIndexField(java.lang.String indexField)

Overrides:

withIndexField in class IndexFieldPrefixHandler

withName

public RefinePrefixHandler withName(java.lang.String name)

Overrides:

withName in class IndexFieldPrefixHandler

withAliases

public RefinePrefixHandler withAliases(java.lang.String aliases)

Overrides:

withAliases in class IndexFieldPrefixHandler

withQueryExpansionConfig

public RefinePrefixHandler withQueryExpansionConfig(java.lang.String queryExpansionConfig)

Overrides:

withQueryExpansionConfig in class IndexFieldPrefixHandler

withDataModelState

public RefinePrefixHandler withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class IndexFieldPrefixHandler

withFromDataModel

public RefinePrefixHandler withFromDataModel(QueryPrefixHandler fromDataModel)

Overrides:

withFromDataModel in class IndexFieldPrefixHandler

withDataModelClass

public RefinePrefixHandler withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class IndexFieldPrefixHandler

withDataModelProperty

public RefinePrefixHandler withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class IndexFieldPrefixHandler

withPrefixMatch

public RefinePrefixHandler withPrefixMatch(boolean prefixMatch)

Overrides:

withPrefixMatch in class IndexFieldPrefixHandler

withPrefixMatch

public RefinePrefixHandler withPrefixMatch(java.lang.Boolean prefixMatch)

Overrides:

withPrefixMatch in class IndexFieldPrefixHandler

setExcluded

public void setExcluded(boolean excluded)

Specifies whether the category must be included or excluded.

isExcluded

public boolean isExcluded()

Specifies whether the category must be included or excluded.

withExcluded

public RefinePrefixHandler withExcluded(boolean excluded)

withExcluded

public RefinePrefixHandler withExcluded(java.lang.Boolean excluded)

makeCopy

public RefinePrefixHandler makeCopy()

Creates and returns a deep copy of this RefinePrefixHandler.

Overrides:

makeCopy in class IndexFieldPrefixHandler

readFrom

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

Read this RefinePrefixHandler 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

Write this RefinePrefixHandler as an XML fragment

Overrides:

writeTo in class IndexFieldPrefixHandler

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this RefinePrefixHandler.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this RefinePrefixHandler.

Overrides:

toString in class IndexFieldPrefixHandler

check

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

Checks this RefinePrefixHandler.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class IndexFieldPrefixHandler

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class IndexFieldPrefixHandler

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class QueryPrefixHandler

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class IndexFieldPrefixHandler

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class QueryPrefixHandler

Throws:

com.exalead.util.TypedException