com.exalead.mercury.mami.search.v20

Class DynamicTextPrefixHandler

java.lang.Object

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

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

com.exalead.mercury.mami.search.v20.DynamicIndexFieldPrefixHandler

com.exalead.mercury.mami.search.v20.DynamicTextPrefixHandler

All Implemented Interfaces:

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

Direct Known Subclasses:

DynamicFullTextPrefixHandler, DynamicRawTextPrefixHandler

public abstract class DynamicTextPrefixHandler
extends DynamicIndexFieldPrefixHandler
implements com.exalead.util.Checkable, java.io.Serializable

Root class for prefix handlers searching for alphanumerical values in a dynamic field.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DynamicTextPrefixHandler.Transformer<T>
static interface	DynamicTextPrefixHandler.Visitor

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

DynamicIndexFieldPrefixHandler.InvalidValueAction

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 int	DEFAULT_PATTERN_MAX_MATCHES
static boolean	DEFAULT_PERFORM_M_A_X
static boolean	DEFAULT_SEMANTIC_CONTENT
java.lang.String	indexFields
int	patternMaxMatches
boolean	performMAX
boolean	semanticContent
java.lang.String	tokenizationConfig

Fields inherited from class com.exalead.mercury.mami.search.v20.DynamicIndexFieldPrefixHandler

DEFAULT_INVALID_VALUE_ACTION, invalidValueAction, meta

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

Method Summary

Modifier and Type	Method and Description
abstract <T> T	accept(DynamicTextPrefixHandler.Transformer<T> transformer, T[] t)
abstract void	accept(DynamicTextPrefixHandler.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this DynamicTextPrefixHandler.
static DynamicTextPrefixHandler	fromString(java.lang.String s) String representation of this DynamicTextPrefixHandler.
java.lang.String	getIndexFields() Comma-separated list of index fields to be targeted by this prefix handler.
int	getPatternMaxMatches() Max number of matches for the patterns under this prefix handler.
java.lang.String	getTokenizationConfig() Tokenization Config to use.
boolean	isPerformMAX() Should we perform a MAX-like query rather than simple OR when targeting multiple fields?
boolean	isSemanticContent() Is the content of this prefix "semantic"? If false, the content will not be tokenized nor passed through the linguistic expansion phase.
DynamicTextPrefixHandler	makeCopy()
static DynamicTextPrefixHandler	readFrom(java.io.InputStream is) Read this DynamicTextPrefixHandler from an XML fragment.
void	setIndexFields(java.lang.String indexFields) Comma-separated list of index fields to be targeted by this prefix handler.
void	setPatternMaxMatches(int patternMaxMatches) Max number of matches for the patterns under this prefix handler.
void	setPerformMAX(boolean performMAX) Should we perform a MAX-like query rather than simple OR when targeting multiple fields?
void	setSemanticContent(boolean semanticContent) Is the content of this prefix "semantic"? If false, the content will not be tokenized nor passed through the linguistic expansion phase.
void	setTokenizationConfig(java.lang.String tokenizationConfig) Tokenization Config to use.
java.lang.String	toString() String representation of this DynamicTextPrefixHandler.
DynamicTextPrefixHandler	withAliases(java.lang.String aliases)
DynamicTextPrefixHandler	withDataModelClass(java.lang.String dataModelClass)
DynamicTextPrefixHandler	withDataModelProperty(java.lang.String dataModelProperty)
DynamicTextPrefixHandler	withDataModelState(java.lang.String dataModelState)
DynamicTextPrefixHandler	withFromDataModel(QueryPrefixHandler fromDataModel)
DynamicTextPrefixHandler	withIndexField(java.lang.String indexField)
DynamicTextPrefixHandler	withIndexFields(java.lang.String indexFields)
DynamicTextPrefixHandler	withInvalidValueAction(java.lang.String invalidValueAction)
DynamicTextPrefixHandler	withMeta(java.lang.String meta)
DynamicTextPrefixHandler	withName(java.lang.String name)
DynamicTextPrefixHandler	withPatternMaxMatches(int patternMaxMatches)
DynamicTextPrefixHandler	withPatternMaxMatches(java.lang.Integer patternMaxMatches)
DynamicTextPrefixHandler	withPerformMAX(boolean performMAX)
DynamicTextPrefixHandler	withPerformMAX(java.lang.Boolean performMAX)
DynamicTextPrefixHandler	withPrefixMatch(boolean prefixMatch)
DynamicTextPrefixHandler	withPrefixMatch(java.lang.Boolean prefixMatch)
DynamicTextPrefixHandler	withQueryExpansionConfig(java.lang.String queryExpansionConfig)
DynamicTextPrefixHandler	withSemanticContent(boolean semanticContent)
DynamicTextPrefixHandler	withSemanticContent(java.lang.Boolean semanticContent)
DynamicTextPrefixHandler	withTokenizationConfig(java.lang.String tokenizationConfig)
void	writeTo(java.io.OutputStream os)

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

accept, accept, getInvalidValueAction, getInvalidValueActionAsEnum, getMeta, isA, isOneOf, setInvalidValueAction, setInvalidValueAction, setMeta

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

accept, accept, getIndexField, setIndexField

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

semanticContent

public boolean semanticContent

DEFAULT_SEMANTIC_CONTENT

public static final boolean DEFAULT_SEMANTIC_CONTENT

See Also:

Constant Field Values

indexFields

public java.lang.String indexFields

performMAX

public boolean performMAX

DEFAULT_PERFORM_M_A_X

public static final boolean DEFAULT_PERFORM_M_A_X

See Also:

Constant Field Values

patternMaxMatches

public int patternMaxMatches

DEFAULT_PATTERN_MAX_MATCHES

public static final int DEFAULT_PATTERN_MAX_MATCHES

See Also:

Constant Field Values

tokenizationConfig

public java.lang.String tokenizationConfig

Constructor Detail

DynamicTextPrefixHandler

public DynamicTextPrefixHandler()

DynamicTextPrefixHandler

public DynamicTextPrefixHandler(DynamicTextPrefixHandler o)

Copy constructor

Method Detail

withMeta

public DynamicTextPrefixHandler withMeta(java.lang.String meta)

Overrides:

withMeta in class DynamicIndexFieldPrefixHandler

withInvalidValueAction

public DynamicTextPrefixHandler withInvalidValueAction(java.lang.String invalidValueAction)

Overrides:

withInvalidValueAction in class DynamicIndexFieldPrefixHandler

withIndexField

public DynamicTextPrefixHandler withIndexField(java.lang.String indexField)

Overrides:

withIndexField in class DynamicIndexFieldPrefixHandler

withName

public DynamicTextPrefixHandler withName(java.lang.String name)

Overrides:

withName in class DynamicIndexFieldPrefixHandler

withAliases

public DynamicTextPrefixHandler withAliases(java.lang.String aliases)

Overrides:

withAliases in class DynamicIndexFieldPrefixHandler

withQueryExpansionConfig

public DynamicTextPrefixHandler withQueryExpansionConfig(java.lang.String queryExpansionConfig)

Overrides:

withQueryExpansionConfig in class DynamicIndexFieldPrefixHandler

withDataModelState

public DynamicTextPrefixHandler withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class DynamicIndexFieldPrefixHandler

withFromDataModel

public DynamicTextPrefixHandler withFromDataModel(QueryPrefixHandler fromDataModel)

Overrides:

withFromDataModel in class DynamicIndexFieldPrefixHandler

withDataModelClass

public DynamicTextPrefixHandler withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class DynamicIndexFieldPrefixHandler

withDataModelProperty

public DynamicTextPrefixHandler withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class DynamicIndexFieldPrefixHandler

withPrefixMatch

public DynamicTextPrefixHandler withPrefixMatch(boolean prefixMatch)

Overrides:

withPrefixMatch in class DynamicIndexFieldPrefixHandler

withPrefixMatch

public DynamicTextPrefixHandler withPrefixMatch(java.lang.Boolean prefixMatch)

Overrides:

withPrefixMatch in class DynamicIndexFieldPrefixHandler

setSemanticContent

public void setSemanticContent(boolean semanticContent)

Is the content of this prefix "semantic"?
If false, the content will not be tokenized nor passed through the linguistic expansion phase.

isSemanticContent

public boolean isSemanticContent()

Is the content of this prefix "semantic"?
If false, the content will not be tokenized nor passed through the linguistic expansion phase.

withSemanticContent

public DynamicTextPrefixHandler withSemanticContent(boolean semanticContent)

withSemanticContent

public DynamicTextPrefixHandler withSemanticContent(java.lang.Boolean semanticContent)

setIndexFields

public void setIndexFields(java.lang.String indexFields)

Comma-separated list of index fields to be targeted by this prefix handler.

getIndexFields

public java.lang.String getIndexFields()

Comma-separated list of index fields to be targeted by this prefix handler.

withIndexFields

public DynamicTextPrefixHandler withIndexFields(java.lang.String indexFields)

setPerformMAX

public void setPerformMAX(boolean performMAX)

Should we perform a MAX-like query rather than simple OR when targeting multiple fields?

isPerformMAX

public boolean isPerformMAX()

Should we perform a MAX-like query rather than simple OR when targeting multiple fields?

withPerformMAX

public DynamicTextPrefixHandler withPerformMAX(boolean performMAX)

withPerformMAX

public DynamicTextPrefixHandler withPerformMAX(java.lang.Boolean performMAX)

setPatternMaxMatches

public void setPatternMaxMatches(int patternMaxMatches)

Max number of matches for the patterns under this prefix handler.

getPatternMaxMatches

public int getPatternMaxMatches()

Max number of matches for the patterns under this prefix handler.

withPatternMaxMatches

public DynamicTextPrefixHandler withPatternMaxMatches(int patternMaxMatches)

withPatternMaxMatches

public DynamicTextPrefixHandler withPatternMaxMatches(java.lang.Integer patternMaxMatches)

setTokenizationConfig

public void setTokenizationConfig(java.lang.String tokenizationConfig)

Tokenization Config to use.

getTokenizationConfig

public java.lang.String getTokenizationConfig()

Tokenization Config to use.

withTokenizationConfig

public DynamicTextPrefixHandler withTokenizationConfig(java.lang.String tokenizationConfig)

makeCopy

public DynamicTextPrefixHandler makeCopy()

Overrides:

makeCopy in class DynamicIndexFieldPrefixHandler

readFrom

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

Read this DynamicTextPrefixHandler 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 DynamicIndexFieldPrefixHandler

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this DynamicTextPrefixHandler.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this DynamicTextPrefixHandler.

Overrides:

toString in class DynamicIndexFieldPrefixHandler

check

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

Checks this DynamicTextPrefixHandler.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class DynamicIndexFieldPrefixHandler

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException