com.exalead.mercury.mami.search.v20

Class KeywordPrefixHandler

java.lang.Object

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

com.exalead.mercury.mami.search.v20.KeywordPrefixHandler

All Implemented Interfaces:

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

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

Searches for a specific Related Term resolving its indexed identifier (internal) by querying the dictionary.

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
static java.lang.String	DEFAULT_KEYWORD_FIELD
java.lang.String	keywordField

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
KeywordPrefixHandler()
KeywordPrefixHandler(KeywordPrefixHandler 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 KeywordPrefixHandler.
static KeywordPrefixHandler	fromString(java.lang.String s) String representation of this KeywordPrefixHandler.
java.lang.String	getKeywordField() Name of the value-field where keywords are indexed.
KeywordPrefixHandler	makeCopy() Creates and returns a deep copy of this KeywordPrefixHandler.
static KeywordPrefixHandler	readFrom(java.io.InputStream is) Read this KeywordPrefixHandler from an XML fragment.
void	setKeywordField(java.lang.String keywordField) Name of the value-field where keywords are indexed.
java.lang.String	toString() String representation of this KeywordPrefixHandler.
KeywordPrefixHandler	withAliases(java.lang.String aliases)
KeywordPrefixHandler	withDataModelClass(java.lang.String dataModelClass)
KeywordPrefixHandler	withDataModelProperty(java.lang.String dataModelProperty)
KeywordPrefixHandler	withDataModelState(java.lang.String dataModelState)
KeywordPrefixHandler	withFromDataModel(QueryPrefixHandler fromDataModel)
KeywordPrefixHandler	withKeywordField(java.lang.String keywordField)
KeywordPrefixHandler	withName(java.lang.String name)
KeywordPrefixHandler	withPrefixMatch(boolean prefixMatch)
KeywordPrefixHandler	withPrefixMatch(java.lang.Boolean prefixMatch)
KeywordPrefixHandler	withQueryExpansionConfig(java.lang.String queryExpansionConfig)
void	writeTo(java.io.OutputStream os) Write this KeywordPrefixHandler 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

keywordField

public java.lang.String keywordField

DEFAULT_KEYWORD_FIELD

public static final java.lang.String DEFAULT_KEYWORD_FIELD

See Also:

Constant Field Values

Constructor Detail

KeywordPrefixHandler

public KeywordPrefixHandler()

KeywordPrefixHandler

public KeywordPrefixHandler(KeywordPrefixHandler o)

Copy constructor

Method Detail

withName

public KeywordPrefixHandler withName(java.lang.String name)

Overrides:

withName in class QueryPrefixHandler

withAliases

public KeywordPrefixHandler withAliases(java.lang.String aliases)

Overrides:

withAliases in class QueryPrefixHandler

withQueryExpansionConfig

public KeywordPrefixHandler withQueryExpansionConfig(java.lang.String queryExpansionConfig)

Overrides:

withQueryExpansionConfig in class QueryPrefixHandler

withDataModelState

public KeywordPrefixHandler withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class QueryPrefixHandler

withFromDataModel

public KeywordPrefixHandler withFromDataModel(QueryPrefixHandler fromDataModel)

withDataModelClass

public KeywordPrefixHandler withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class QueryPrefixHandler

withDataModelProperty

public KeywordPrefixHandler withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class QueryPrefixHandler

withPrefixMatch

public KeywordPrefixHandler withPrefixMatch(boolean prefixMatch)

Overrides:

withPrefixMatch in class QueryPrefixHandler

withPrefixMatch

public KeywordPrefixHandler withPrefixMatch(java.lang.Boolean prefixMatch)

Overrides:

withPrefixMatch in class QueryPrefixHandler

setKeywordField

public void setKeywordField(java.lang.String keywordField)

Name of the value-field where keywords are indexed.

getKeywordField

public java.lang.String getKeywordField()

Name of the value-field where keywords are indexed.

withKeywordField

public KeywordPrefixHandler withKeywordField(java.lang.String keywordField)

makeCopy

public KeywordPrefixHandler makeCopy()

Creates and returns a deep copy of this KeywordPrefixHandler.

Overrides:

makeCopy in class QueryPrefixHandler

readFrom

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

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

Overrides:

writeTo in class QueryPrefixHandler

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this KeywordPrefixHandler.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this KeywordPrefixHandler.

Overrides:

toString in class QueryPrefixHandler

check

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

Checks this KeywordPrefixHandler.

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