com.exalead.mercury.mami.search.v20

Class FullTextPrefixHandler

java.lang.Object

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

com.exalead.mercury.mami.search.v20.TextPrefixHandler

com.exalead.mercury.mami.search.v20.FullTextPrefixHandler

All Implemented Interfaces:

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

public class FullTextPrefixHandler
extends TextPrefixHandler
implements com.exalead.util.Checkable, java.io.Serializable

Searches in alphanumerical fields (both static and dynamic ones).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FullTextPrefixHandler.MatchingMode

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

TextPrefixHandler.Transformer<T>, TextPrefixHandler.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
int	customKind
static java.lang.String	DEFAULT_MATCHING_MODE
static boolean	DEFAULT_USE_NESTED_PREFIX_AS_DYNAMIC_META_NAME
java.lang.String	dictionaryName
java.lang.String	forcedDynamicMetaName
java.lang.String	matchingMode
boolean	useNestedPrefixAsDynamicMetaName

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

DEFAULT_PATTERN_MAX_MATCHES, DEFAULT_PATTERN_SEARCH, DEFAULT_PERFORM_M_A_X, DEFAULT_SEMANTIC_CONTENT, DEFAULT_USE_PREFIXED_MAPPINGS, indexFields, indexFieldWeights, patternMaxMatches, patternSearch, performMAX, semanticContent, tokenizationConfig, usePrefixedMappings

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
FullTextPrefixHandler()
FullTextPrefixHandler(FullTextPrefixHandler 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)
<T> T	accept(TextPrefixHandler.Transformer<T> transformer, T[] t)
void	accept(TextPrefixHandler.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this FullTextPrefixHandler.
static FullTextPrefixHandler	fromString(java.lang.String s) String representation of this FullTextPrefixHandler.
int	getCustomKind() Custom indexing kind for lookup of the words associated with this prefix handler. This requires the matching mode to be set to 'custom'. Custom kinds must be used together with custom content targets at indexing time.
java.lang.String	getDictionaryName() Dictionary to target
java.lang.String	getForcedDynamicMetaName() Dynamic meta to search when targeting a dynamic alphanumerical field. Use this to restrict the search in a dynamic field to text that appears within this meta. This requires the Store meta names option to be enabled on the dynamic field.
java.lang.String	getMatchingMode() Normalization level for lookup of the words associated with this prefix handler. Using the 'custom' matching mode requires the custom kind to be set. Value can be null or one of exact lowercase normalized exact_lowercase exact_lowercase_normalized lowercase_normalized custom
FullTextPrefixHandler.MatchingMode	getMatchingModeAsEnum() Normalization level for lookup of the words associated with this prefix handler. Using the 'custom' matching mode requires the custom kind to be set. Value can be null or one of exact lowercase normalized exact_lowercase exact_lowercase_normalized lowercase_normalized custom
static boolean	isA(java.lang.String str, FullTextPrefixHandler.MatchingMode item)
static boolean	isOneOf(java.lang.String str, FullTextPrefixHandler.MatchingMode... items)
boolean	isUseNestedPrefixAsDynamicMetaName() Uses a nested prefix handler as dynamic meta name to search within a dynamic alphanumerical field. This requires the Store meta names option to be enabled on the dynamic field. This is incompatible with the "forcedDynamicMetaName" option. For example, on a prefix handler named "myprefix" configured to target a "mydynfield" index field, a "myprefix:mymeta:myvalue" query will search for "myvalue" into the "mymeta" meta of "mydynfield". Note that a "myprefix:myvalue" query will not lookup into any meta, and will not find anything.
FullTextPrefixHandler	makeCopy() Creates and returns a deep copy of this FullTextPrefixHandler.
static FullTextPrefixHandler	readFrom(java.io.InputStream is) Read this FullTextPrefixHandler from an XML fragment.
void	setCustomKind(int customKind) Custom indexing kind for lookup of the words associated with this prefix handler. This requires the matching mode to be set to 'custom'. Custom kinds must be used together with custom content targets at indexing time.
void	setDictionaryName(java.lang.String dictionaryName) Dictionary to target
void	setForcedDynamicMetaName(java.lang.String forcedDynamicMetaName) Dynamic meta to search when targeting a dynamic alphanumerical field. Use this to restrict the search in a dynamic field to text that appears within this meta. This requires the Store meta names option to be enabled on the dynamic field.
void	setMatchingMode(FullTextPrefixHandler.MatchingMode item) Normalization level for lookup of the words associated with this prefix handler. Using the 'custom' matching mode requires the custom kind to be set. Value can be null or one of exact lowercase normalized exact_lowercase exact_lowercase_normalized lowercase_normalized custom
void	setMatchingMode(java.lang.String matchingMode) Normalization level for lookup of the words associated with this prefix handler. Using the 'custom' matching mode requires the custom kind to be set. Value can be null or one of exact lowercase normalized exact_lowercase exact_lowercase_normalized lowercase_normalized custom
void	setUseNestedPrefixAsDynamicMetaName(boolean useNestedPrefixAsDynamicMetaName) Uses a nested prefix handler as dynamic meta name to search within a dynamic alphanumerical field. This requires the Store meta names option to be enabled on the dynamic field. This is incompatible with the "forcedDynamicMetaName" option. For example, on a prefix handler named "myprefix" configured to target a "mydynfield" index field, a "myprefix:mymeta:myvalue" query will search for "myvalue" into the "mymeta" meta of "mydynfield". Note that a "myprefix:myvalue" query will not lookup into any meta, and will not find anything.
java.lang.String	toString() String representation of this FullTextPrefixHandler.
FullTextPrefixHandler	withAliases(java.lang.String aliases)
FullTextPrefixHandler	withCustomKind(int customKind)
FullTextPrefixHandler	withCustomKind(java.lang.Integer customKind)
FullTextPrefixHandler	withDataModelClass(java.lang.String dataModelClass)
FullTextPrefixHandler	withDataModelProperty(java.lang.String dataModelProperty)
FullTextPrefixHandler	withDataModelState(java.lang.String dataModelState)
FullTextPrefixHandler	withDictionaryName(java.lang.String dictionaryName)
FullTextPrefixHandler	withForcedDynamicMetaName(java.lang.String forcedDynamicMetaName)
FullTextPrefixHandler	withFromDataModel(QueryPrefixHandler fromDataModel)
FullTextPrefixHandler	withIndexFields(java.lang.String indexFields)
FullTextPrefixHandler	withIndexFieldWeights(java.lang.String indexFieldWeights)
FullTextPrefixHandler	withMatchingMode(java.lang.String matchingMode)
FullTextPrefixHandler	withName(java.lang.String name)
FullTextPrefixHandler	withPatternMaxMatches(int patternMaxMatches)
FullTextPrefixHandler	withPatternMaxMatches(java.lang.Integer patternMaxMatches)
FullTextPrefixHandler	withPatternSearch(boolean patternSearch)
FullTextPrefixHandler	withPatternSearch(java.lang.Boolean patternSearch)
FullTextPrefixHandler	withPerformMAX(boolean performMAX)
FullTextPrefixHandler	withPerformMAX(java.lang.Boolean performMAX)
FullTextPrefixHandler	withPrefixMatch(boolean prefixMatch)
FullTextPrefixHandler	withPrefixMatch(java.lang.Boolean prefixMatch)
FullTextPrefixHandler	withQueryExpansionConfig(java.lang.String queryExpansionConfig)
FullTextPrefixHandler	withSemanticContent(boolean semanticContent)
FullTextPrefixHandler	withSemanticContent(java.lang.Boolean semanticContent)
FullTextPrefixHandler	withTokenizationConfig(java.lang.String tokenizationConfig)
FullTextPrefixHandler	withUseNestedPrefixAsDynamicMetaName(boolean useNestedPrefixAsDynamicMetaName)
FullTextPrefixHandler	withUseNestedPrefixAsDynamicMetaName(java.lang.Boolean useNestedPrefixAsDynamicMetaName)
FullTextPrefixHandler	withUsePrefixedMappings(boolean usePrefixedMappings)
FullTextPrefixHandler	withUsePrefixedMappings(java.lang.Boolean usePrefixedMappings)
void	writeTo(java.io.OutputStream os) Write this FullTextPrefixHandler as an XML fragment

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

getIndexFields, getIndexFieldWeights, getPatternMaxMatches, getTokenizationConfig, isPatternSearch, isPerformMAX, isSemanticContent, isUsePrefixedMappings, setIndexFields, setIndexFieldWeights, setPatternMaxMatches, setPatternSearch, setPerformMAX, setSemanticContent, setTokenizationConfig, setUsePrefixedMappings

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

matchingMode

public java.lang.String matchingMode

DEFAULT_MATCHING_MODE

public static final java.lang.String DEFAULT_MATCHING_MODE

See Also:

Constant Field Values

customKind

public int customKind

useNestedPrefixAsDynamicMetaName

public boolean useNestedPrefixAsDynamicMetaName

DEFAULT_USE_NESTED_PREFIX_AS_DYNAMIC_META_NAME

public static final boolean DEFAULT_USE_NESTED_PREFIX_AS_DYNAMIC_META_NAME

See Also:

Constant Field Values

forcedDynamicMetaName

public java.lang.String forcedDynamicMetaName

dictionaryName

public java.lang.String dictionaryName

Constructor Detail

FullTextPrefixHandler

public FullTextPrefixHandler()

FullTextPrefixHandler

public FullTextPrefixHandler(FullTextPrefixHandler o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          FullTextPrefixHandler.MatchingMode item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              FullTextPrefixHandler.MatchingMode... items)

setMatchingMode

public void setMatchingMode(FullTextPrefixHandler.MatchingMode item)

Normalization level for lookup of the words associated with this prefix handler.
Using the 'custom' matching mode requires the custom kind to be set.
Value can be null or one of

• exact
• lowercase
• normalized
• exact_lowercase
• exact_lowercase_normalized
• lowercase_normalized
• custom

getMatchingModeAsEnum

public FullTextPrefixHandler.MatchingMode getMatchingModeAsEnum()

Normalization level for lookup of the words associated with this prefix handler.
Using the 'custom' matching mode requires the custom kind to be set.
Value can be null or one of

• exact
• lowercase
• normalized
• exact_lowercase
• exact_lowercase_normalized
• lowercase_normalized
• custom

withSemanticContent

public FullTextPrefixHandler withSemanticContent(boolean semanticContent)

Overrides:

withSemanticContent in class TextPrefixHandler

withSemanticContent

public FullTextPrefixHandler withSemanticContent(java.lang.Boolean semanticContent)

Overrides:

withSemanticContent in class TextPrefixHandler

withIndexFields

public FullTextPrefixHandler withIndexFields(java.lang.String indexFields)

Overrides:

withIndexFields in class TextPrefixHandler

withIndexFieldWeights

public FullTextPrefixHandler withIndexFieldWeights(java.lang.String indexFieldWeights)

Overrides:

withIndexFieldWeights in class TextPrefixHandler

withPerformMAX

public FullTextPrefixHandler withPerformMAX(boolean performMAX)

Overrides:

withPerformMAX in class TextPrefixHandler

withPerformMAX

public FullTextPrefixHandler withPerformMAX(java.lang.Boolean performMAX)

Overrides:

withPerformMAX in class TextPrefixHandler

withPatternMaxMatches

public FullTextPrefixHandler withPatternMaxMatches(int patternMaxMatches)

Overrides:

withPatternMaxMatches in class TextPrefixHandler

withPatternMaxMatches

public FullTextPrefixHandler withPatternMaxMatches(java.lang.Integer patternMaxMatches)

Overrides:

withPatternMaxMatches in class TextPrefixHandler

withUsePrefixedMappings

public FullTextPrefixHandler withUsePrefixedMappings(boolean usePrefixedMappings)

Overrides:

withUsePrefixedMappings in class TextPrefixHandler

withUsePrefixedMappings

public FullTextPrefixHandler withUsePrefixedMappings(java.lang.Boolean usePrefixedMappings)

Overrides:

withUsePrefixedMappings in class TextPrefixHandler

withPatternSearch

public FullTextPrefixHandler withPatternSearch(boolean patternSearch)

Overrides:

withPatternSearch in class TextPrefixHandler

withPatternSearch

public FullTextPrefixHandler withPatternSearch(java.lang.Boolean patternSearch)

Overrides:

withPatternSearch in class TextPrefixHandler

withTokenizationConfig

public FullTextPrefixHandler withTokenizationConfig(java.lang.String tokenizationConfig)

Overrides:

withTokenizationConfig in class TextPrefixHandler

withName

public FullTextPrefixHandler withName(java.lang.String name)

Overrides:

withName in class TextPrefixHandler

withAliases

public FullTextPrefixHandler withAliases(java.lang.String aliases)

Overrides:

withAliases in class TextPrefixHandler

withQueryExpansionConfig

public FullTextPrefixHandler withQueryExpansionConfig(java.lang.String queryExpansionConfig)

Overrides:

withQueryExpansionConfig in class TextPrefixHandler

withDataModelState

public FullTextPrefixHandler withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class TextPrefixHandler

withFromDataModel

public FullTextPrefixHandler withFromDataModel(QueryPrefixHandler fromDataModel)

Overrides:

withFromDataModel in class TextPrefixHandler

withDataModelClass

public FullTextPrefixHandler withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class TextPrefixHandler

withDataModelProperty

public FullTextPrefixHandler withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class TextPrefixHandler

withPrefixMatch

public FullTextPrefixHandler withPrefixMatch(boolean prefixMatch)

Overrides:

withPrefixMatch in class TextPrefixHandler

withPrefixMatch

public FullTextPrefixHandler withPrefixMatch(java.lang.Boolean prefixMatch)

Overrides:

withPrefixMatch in class TextPrefixHandler

setMatchingMode

public void setMatchingMode(java.lang.String matchingMode)

Normalization level for lookup of the words associated with this prefix handler.
Using the 'custom' matching mode requires the custom kind to be set.
Value can be null or one of

• exact
• lowercase
• normalized
• exact_lowercase
• exact_lowercase_normalized
• lowercase_normalized
• custom

getMatchingMode

public java.lang.String getMatchingMode()

Normalization level for lookup of the words associated with this prefix handler.
Using the 'custom' matching mode requires the custom kind to be set.
Value can be null or one of

• exact
• lowercase
• normalized
• exact_lowercase
• exact_lowercase_normalized
• lowercase_normalized
• custom

withMatchingMode

public FullTextPrefixHandler withMatchingMode(java.lang.String matchingMode)

setCustomKind

public void setCustomKind(int customKind)

Custom indexing kind for lookup of the words associated with this prefix handler.
This requires the matching mode to be set to 'custom'.
Custom kinds must be used together with custom content targets at indexing time.

getCustomKind

public int getCustomKind()

Custom indexing kind for lookup of the words associated with this prefix handler.
This requires the matching mode to be set to 'custom'.
Custom kinds must be used together with custom content targets at indexing time.

withCustomKind

public FullTextPrefixHandler withCustomKind(int customKind)

withCustomKind

public FullTextPrefixHandler withCustomKind(java.lang.Integer customKind)

setUseNestedPrefixAsDynamicMetaName

public void setUseNestedPrefixAsDynamicMetaName(boolean useNestedPrefixAsDynamicMetaName)

Uses a nested prefix handler as dynamic meta name to search within a dynamic alphanumerical field.
This requires the Store meta names option to be enabled on the dynamic field.
This is incompatible with the "forcedDynamicMetaName" option.

For example, on a prefix handler named "myprefix" configured to target a "mydynfield" index field, a "myprefix:mymeta:myvalue" query will search for "myvalue" into the "mymeta" meta of "mydynfield".
Note that a "myprefix:myvalue" query will not lookup into any meta, and will not find anything.

isUseNestedPrefixAsDynamicMetaName

public boolean isUseNestedPrefixAsDynamicMetaName()

Uses a nested prefix handler as dynamic meta name to search within a dynamic alphanumerical field.
This requires the Store meta names option to be enabled on the dynamic field.
This is incompatible with the "forcedDynamicMetaName" option.

For example, on a prefix handler named "myprefix" configured to target a "mydynfield" index field, a "myprefix:mymeta:myvalue" query will search for "myvalue" into the "mymeta" meta of "mydynfield".
Note that a "myprefix:myvalue" query will not lookup into any meta, and will not find anything.

withUseNestedPrefixAsDynamicMetaName

public FullTextPrefixHandler withUseNestedPrefixAsDynamicMetaName(boolean useNestedPrefixAsDynamicMetaName)

withUseNestedPrefixAsDynamicMetaName

public FullTextPrefixHandler withUseNestedPrefixAsDynamicMetaName(java.lang.Boolean useNestedPrefixAsDynamicMetaName)

setForcedDynamicMetaName

public void setForcedDynamicMetaName(java.lang.String forcedDynamicMetaName)

Dynamic meta to search when targeting a dynamic alphanumerical field.
Use this to restrict the search in a dynamic field to text that appears within this meta.

This requires the Store meta names option to be enabled on the dynamic field. This is incompatible with the Use nested prefix as dyn. meta option.

For example, with this option set to "mymeta", on a prefix handler named "myprefix" configured to target index field "mydynfield", a query "myprefix:myvalue" will search for "myvalue" into the "mymeta" meta of "mydynfield".
It is possible to set a list of meta separated by ',' to mimic the behavior of a list of index fields (OR on the different metas)

getForcedDynamicMetaName

public java.lang.String getForcedDynamicMetaName()

Dynamic meta to search when targeting a dynamic alphanumerical field.
Use this to restrict the search in a dynamic field to text that appears within this meta.

This requires the Store meta names option to be enabled on the dynamic field. This is incompatible with the Use nested prefix as dyn. meta option.

For example, with this option set to "mymeta", on a prefix handler named "myprefix" configured to target index field "mydynfield", a query "myprefix:myvalue" will search for "myvalue" into the "mymeta" meta of "mydynfield".
It is possible to set a list of meta separated by ',' to mimic the behavior of a list of index fields (OR on the different metas)

withForcedDynamicMetaName

public FullTextPrefixHandler withForcedDynamicMetaName(java.lang.String forcedDynamicMetaName)

setDictionaryName

public void setDictionaryName(java.lang.String dictionaryName)

Dictionary to target

getDictionaryName

public java.lang.String getDictionaryName()

Dictionary to target

withDictionaryName

public FullTextPrefixHandler withDictionaryName(java.lang.String dictionaryName)

makeCopy

public FullTextPrefixHandler makeCopy()

Creates and returns a deep copy of this FullTextPrefixHandler.

Overrides:

makeCopy in class TextPrefixHandler

readFrom

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

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

Overrides:

writeTo in class TextPrefixHandler

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this FullTextPrefixHandler.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this FullTextPrefixHandler.

Overrides:

toString in class TextPrefixHandler

check

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

Checks this FullTextPrefixHandler.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class TextPrefixHandler

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class TextPrefixHandler

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

Specified by:

accept in class TextPrefixHandler

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