com.exalead.mercury.mami.search.v20

Class TemplatePrefixHandler

java.lang.Object

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

com.exalead.mercury.mami.search.v20.TemplatePrefixHandler

All Implemented Interfaces:

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

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

Replaces its content with the expansion of its template attribute, in which
the __QUERY__ placeholder has itself been replaced by the content.
This prefix handler can be used as default prefix handler with some limitations (not compatible with linguistic prefix handlers like spellslike:).

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	template

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
TemplatePrefixHandler()
TemplatePrefixHandler(TemplatePrefixHandler 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 TemplatePrefixHandler.
static TemplatePrefixHandler	fromString(java.lang.String s) String representation of this TemplatePrefixHandler.
java.lang.String	getTemplate() Template to use to replace the content of this prefix handler. Occurrences of __QUERY__ inside of this template are replaced by the content itself.
TemplatePrefixHandler	makeCopy() Creates and returns a deep copy of this TemplatePrefixHandler.
static TemplatePrefixHandler	readFrom(java.io.InputStream is) Read this TemplatePrefixHandler from an XML fragment.
void	setTemplate(java.lang.String template) Template to use to replace the content of this prefix handler. Occurrences of __QUERY__ inside of this template are replaced by the content itself.
java.lang.String	toString() String representation of this TemplatePrefixHandler.
TemplatePrefixHandler	withAliases(java.lang.String aliases)
TemplatePrefixHandler	withDataModelClass(java.lang.String dataModelClass)
TemplatePrefixHandler	withDataModelProperty(java.lang.String dataModelProperty)
TemplatePrefixHandler	withDataModelState(java.lang.String dataModelState)
TemplatePrefixHandler	withFromDataModel(QueryPrefixHandler fromDataModel)
TemplatePrefixHandler	withName(java.lang.String name)
TemplatePrefixHandler	withPrefixMatch(boolean prefixMatch)
TemplatePrefixHandler	withPrefixMatch(java.lang.Boolean prefixMatch)
TemplatePrefixHandler	withQueryExpansionConfig(java.lang.String queryExpansionConfig)
TemplatePrefixHandler	withTemplate(java.lang.String template)
void	writeTo(java.io.OutputStream os) Write this TemplatePrefixHandler 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

template

public java.lang.String template

Constructor Detail

TemplatePrefixHandler

public TemplatePrefixHandler()

TemplatePrefixHandler

public TemplatePrefixHandler(TemplatePrefixHandler o)

Copy constructor

Method Detail

withName

public TemplatePrefixHandler withName(java.lang.String name)

Overrides:

withName in class QueryPrefixHandler

withAliases

public TemplatePrefixHandler withAliases(java.lang.String aliases)

Overrides:

withAliases in class QueryPrefixHandler

withQueryExpansionConfig

public TemplatePrefixHandler withQueryExpansionConfig(java.lang.String queryExpansionConfig)

Overrides:

withQueryExpansionConfig in class QueryPrefixHandler

withDataModelState

public TemplatePrefixHandler withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class QueryPrefixHandler

withFromDataModel

public TemplatePrefixHandler withFromDataModel(QueryPrefixHandler fromDataModel)

withDataModelClass

public TemplatePrefixHandler withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class QueryPrefixHandler

withDataModelProperty

public TemplatePrefixHandler withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class QueryPrefixHandler

withPrefixMatch

public TemplatePrefixHandler withPrefixMatch(boolean prefixMatch)

Overrides:

withPrefixMatch in class QueryPrefixHandler

withPrefixMatch

public TemplatePrefixHandler withPrefixMatch(java.lang.Boolean prefixMatch)

Overrides:

withPrefixMatch in class QueryPrefixHandler

setTemplate

public void setTemplate(java.lang.String template)

Template to use to replace the content of this prefix handler.
Occurrences of __QUERY__ inside of this template are replaced by the content itself.

getTemplate

public java.lang.String getTemplate()

Template to use to replace the content of this prefix handler.
Occurrences of __QUERY__ inside of this template are replaced by the content itself.

withTemplate

public TemplatePrefixHandler withTemplate(java.lang.String template)

makeCopy

public TemplatePrefixHandler makeCopy()

Creates and returns a deep copy of this TemplatePrefixHandler.

Overrides:

makeCopy in class QueryPrefixHandler

readFrom

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

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

Overrides:

writeTo in class QueryPrefixHandler

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this TemplatePrefixHandler.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this TemplatePrefixHandler.

Overrides:

toString in class QueryPrefixHandler

check

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

Checks this TemplatePrefixHandler.

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