com.exalead.mercury.mami.search.v20

Class CustomPrefixHandler

java.lang.Object

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

com.exalead.mercury.mami.search.v20.CustomPrefixHandler

All Implemented Interfaces:

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

public class CustomPrefixHandler
extends QueryPrefixHandler
implements com.exalead.util.Checkable, java.io.Serializable

Prefix handler implemented using custom Java code.

See Also:

Serialized Form

Nested Class Summary

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

QueryPrefixHandler.FromDataModel, QueryPrefixHandler.Transformer<T>, QueryPrefixHandler.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	classId
java.util.List<KeyValue>	keyValue

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

Method Summary

Modifier and Type	Method and Description
<T> T	accept(QueryPrefixHandler.Transformer<T> transformer, T[] t)
void	accept(QueryPrefixHandler.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this CustomPrefixHandler.
static CustomPrefixHandler	fromString(java.lang.String s) String representation of this CustomPrefixHandler.
java.lang.String	getClassId() Reference of the Java class that implements the query prefix handler. This class must implement the interface com.exalead.search.query.prefix.CustomPrefixHandler
java.util.List<KeyValue>	getKeyValue()
CustomPrefixHandler	makeCopy() Creates and returns a deep copy of this CustomPrefixHandler.
static CustomPrefixHandler	readFrom(java.io.InputStream is) Read this CustomPrefixHandler from an XML fragment.
void	setClassId(java.lang.String classId) Reference of the Java class that implements the query prefix handler. This class must implement the interface com.exalead.search.query.prefix.CustomPrefixHandler
java.lang.String	toString() String representation of this CustomPrefixHandler.
CustomPrefixHandler	withAliases(java.lang.String aliases)
CustomPrefixHandler	withClassId(java.lang.String classId)
CustomPrefixHandler	withDataModelClass(java.lang.String dataModelClass)
CustomPrefixHandler	withDataModelProperty(java.lang.String dataModelProperty)
CustomPrefixHandler	withDataModelState(java.lang.String dataModelState)
CustomPrefixHandler	withFromDataModel(QueryPrefixHandler fromDataModel)
CustomPrefixHandler	withKeyValue(java.util.Collection<KeyValue> __values)
CustomPrefixHandler	withKeyValue(KeyValue... __values)
CustomPrefixHandler	withName(java.lang.String name)
CustomPrefixHandler	withPrefixMatch(boolean prefixMatch)
CustomPrefixHandler	withPrefixMatch(java.lang.Boolean prefixMatch)
CustomPrefixHandler	withQueryExpansionConfig(java.lang.String queryExpansionConfig)
void	writeTo(java.io.OutputStream os) Write this CustomPrefixHandler as an XML fragment

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

keyValue

public java.util.List<KeyValue> keyValue

classId

public java.lang.String classId

Constructor Detail

CustomPrefixHandler

public CustomPrefixHandler()

CustomPrefixHandler

public CustomPrefixHandler(CustomPrefixHandler o)

Copy constructor

Method Detail

withName

public CustomPrefixHandler withName(java.lang.String name)

Overrides:

withName in class QueryPrefixHandler

withAliases

public CustomPrefixHandler withAliases(java.lang.String aliases)

Overrides:

withAliases in class QueryPrefixHandler

withQueryExpansionConfig

public CustomPrefixHandler withQueryExpansionConfig(java.lang.String queryExpansionConfig)

Overrides:

withQueryExpansionConfig in class QueryPrefixHandler

withDataModelState

public CustomPrefixHandler withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class QueryPrefixHandler

withFromDataModel

public CustomPrefixHandler withFromDataModel(QueryPrefixHandler fromDataModel)

withDataModelClass

public CustomPrefixHandler withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class QueryPrefixHandler

withDataModelProperty

public CustomPrefixHandler withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class QueryPrefixHandler

withPrefixMatch

public CustomPrefixHandler withPrefixMatch(boolean prefixMatch)

Overrides:

withPrefixMatch in class QueryPrefixHandler

withPrefixMatch

public CustomPrefixHandler withPrefixMatch(java.lang.Boolean prefixMatch)

Overrides:

withPrefixMatch in class QueryPrefixHandler

getKeyValue

public java.util.List<KeyValue> getKeyValue()

withKeyValue

public CustomPrefixHandler withKeyValue(KeyValue... __values)

withKeyValue

public CustomPrefixHandler withKeyValue(java.util.Collection<KeyValue> __values)

setClassId

public void setClassId(java.lang.String classId)

Reference of the Java class that implements the query prefix handler.
This class must implement the interface com.exalead.search.query.prefix.CustomPrefixHandler

getClassId

public java.lang.String getClassId()

Reference of the Java class that implements the query prefix handler.
This class must implement the interface com.exalead.search.query.prefix.CustomPrefixHandler

withClassId

public CustomPrefixHandler withClassId(java.lang.String classId)

makeCopy

public CustomPrefixHandler makeCopy()

Creates and returns a deep copy of this CustomPrefixHandler.

Overrides:

makeCopy in class QueryPrefixHandler

readFrom

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

Read this CustomPrefixHandler 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 CustomPrefixHandler as an XML fragment

Overrides:

writeTo in class QueryPrefixHandler

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this CustomPrefixHandler.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this CustomPrefixHandler.

Overrides:

toString in class QueryPrefixHandler

check

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

Checks this CustomPrefixHandler.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class QueryPrefixHandler

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(QueryPrefixHandler.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class QueryPrefixHandler

Throws:

com.exalead.util.TypedException