com.exalead.mercury.mami.search.v20

Class TextPrefixHandler

java.lang.Object

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

FullTextPrefixHandler, RawTextPrefixHandler

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

No documentation for this element.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TextPrefixHandler.Transformer<T>
static interface	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
static int	DEFAULT_PATTERN_MAX_MATCHES
static boolean	DEFAULT_PATTERN_SEARCH
static boolean	DEFAULT_PERFORM_M_A_X
static boolean	DEFAULT_SEMANTIC_CONTENT
static boolean	DEFAULT_USE_PREFIXED_MAPPINGS
java.lang.String	indexFields
java.lang.String	indexFieldWeights
int	patternMaxMatches
boolean	patternSearch
boolean	performMAX
boolean	semanticContent
java.lang.String	tokenizationConfig
boolean	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
TextPrefixHandler()
TextPrefixHandler(TextPrefixHandler o) Copy constructor

Method Summary

Modifier and Type	Method and Description
abstract <T> T	accept(TextPrefixHandler.Transformer<T> transformer, T[] t)
abstract void	accept(TextPrefixHandler.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this TextPrefixHandler.
static TextPrefixHandler	fromString(java.lang.String s) String representation of this TextPrefixHandler.
java.lang.String	getIndexFields() Comma-separated list of index fields targeted by this prefix handler.
java.lang.String	getIndexFieldWeights() Optional comma-separated list of weights applied to each index field targeted by this prefix handler.
int	getPatternMaxMatches() Max number of matches for the patterns under this prefix handler.
java.lang.String	getTokenizationConfig()
boolean	isPatternSearch() Uses index field dictionaries for pattern expansion rather than linguistic dictionaries.
boolean	isPerformMAX() Should we perform a MAX-like query rather than a simple OR when targeting multiple fields?
boolean	isSemanticContent() Is the content of this prefix handler "semantic"? If false, the content will neither be tokenized nor passed through the linguistic expansion phase.
boolean	isUsePrefixedMappings() Prefixes the value with the prefix and #. This must be used with the "prefixWithContext" option of analysis mappings. For example: will transform: stuff_number1:test into: everything:stuff_number1#test
TextPrefixHandler	makeCopy()
static TextPrefixHandler	readFrom(java.io.InputStream is) Read this TextPrefixHandler from an XML fragment.
void	setIndexFields(java.lang.String indexFields) Comma-separated list of index fields targeted by this prefix handler.
void	setIndexFieldWeights(java.lang.String indexFieldWeights) Optional comma-separated list of weights applied to each index field targeted by this prefix handler.
void	setPatternMaxMatches(int patternMaxMatches) Max number of matches for the patterns under this prefix handler.
void	setPatternSearch(boolean patternSearch) Uses index field dictionaries for pattern expansion rather than linguistic dictionaries.
void	setPerformMAX(boolean performMAX) Should we perform a MAX-like query rather than a simple OR when targeting multiple fields?
void	setSemanticContent(boolean semanticContent) Is the content of this prefix handler "semantic"? If false, the content will neither be tokenized nor passed through the linguistic expansion phase.
void	setTokenizationConfig(java.lang.String tokenizationConfig)
void	setUsePrefixedMappings(boolean usePrefixedMappings) Prefixes the value with the prefix and #. This must be used with the "prefixWithContext" option of analysis mappings. For example: will transform: stuff_number1:test into: everything:stuff_number1#test
java.lang.String	toString() String representation of this TextPrefixHandler.
TextPrefixHandler	withAliases(java.lang.String aliases)
TextPrefixHandler	withDataModelClass(java.lang.String dataModelClass)
TextPrefixHandler	withDataModelProperty(java.lang.String dataModelProperty)
TextPrefixHandler	withDataModelState(java.lang.String dataModelState)
TextPrefixHandler	withFromDataModel(QueryPrefixHandler fromDataModel)
TextPrefixHandler	withIndexFields(java.lang.String indexFields)
TextPrefixHandler	withIndexFieldWeights(java.lang.String indexFieldWeights)
TextPrefixHandler	withName(java.lang.String name)
TextPrefixHandler	withPatternMaxMatches(int patternMaxMatches)
TextPrefixHandler	withPatternMaxMatches(java.lang.Integer patternMaxMatches)
TextPrefixHandler	withPatternSearch(boolean patternSearch)
TextPrefixHandler	withPatternSearch(java.lang.Boolean patternSearch)
TextPrefixHandler	withPerformMAX(boolean performMAX)
TextPrefixHandler	withPerformMAX(java.lang.Boolean performMAX)
TextPrefixHandler	withPrefixMatch(boolean prefixMatch)
TextPrefixHandler	withPrefixMatch(java.lang.Boolean prefixMatch)
TextPrefixHandler	withQueryExpansionConfig(java.lang.String queryExpansionConfig)
TextPrefixHandler	withSemanticContent(boolean semanticContent)
TextPrefixHandler	withSemanticContent(java.lang.Boolean semanticContent)
TextPrefixHandler	withTokenizationConfig(java.lang.String tokenizationConfig)
TextPrefixHandler	withUsePrefixedMappings(boolean usePrefixedMappings)
TextPrefixHandler	withUsePrefixedMappings(java.lang.Boolean usePrefixedMappings)
void	writeTo(java.io.OutputStream os)

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

indexFieldWeights

public java.lang.String indexFieldWeights

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

usePrefixedMappings

public boolean usePrefixedMappings

DEFAULT_USE_PREFIXED_MAPPINGS

public static final boolean DEFAULT_USE_PREFIXED_MAPPINGS

See Also:

Constant Field Values

patternSearch

public boolean patternSearch

DEFAULT_PATTERN_SEARCH

public static final boolean DEFAULT_PATTERN_SEARCH

See Also:

Constant Field Values

tokenizationConfig

public java.lang.String tokenizationConfig

Constructor Detail

TextPrefixHandler

public TextPrefixHandler()

TextPrefixHandler

public TextPrefixHandler(TextPrefixHandler o)

Copy constructor

Method Detail

withName

public TextPrefixHandler withName(java.lang.String name)

Overrides:

withName in class QueryPrefixHandler

withAliases

public TextPrefixHandler withAliases(java.lang.String aliases)

Overrides:

withAliases in class QueryPrefixHandler

withQueryExpansionConfig

public TextPrefixHandler withQueryExpansionConfig(java.lang.String queryExpansionConfig)

Overrides:

withQueryExpansionConfig in class QueryPrefixHandler

withDataModelState

public TextPrefixHandler withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class QueryPrefixHandler

withFromDataModel

public TextPrefixHandler withFromDataModel(QueryPrefixHandler fromDataModel)

withDataModelClass

public TextPrefixHandler withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class QueryPrefixHandler

withDataModelProperty

public TextPrefixHandler withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class QueryPrefixHandler

withPrefixMatch

public TextPrefixHandler withPrefixMatch(boolean prefixMatch)

Overrides:

withPrefixMatch in class QueryPrefixHandler

withPrefixMatch

public TextPrefixHandler withPrefixMatch(java.lang.Boolean prefixMatch)

Overrides:

withPrefixMatch in class QueryPrefixHandler

setSemanticContent

public void setSemanticContent(boolean semanticContent)

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

isSemanticContent

public boolean isSemanticContent()

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

withSemanticContent

public TextPrefixHandler withSemanticContent(boolean semanticContent)

withSemanticContent

public TextPrefixHandler withSemanticContent(java.lang.Boolean semanticContent)

setIndexFields

public void setIndexFields(java.lang.String indexFields)

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

getIndexFields

public java.lang.String getIndexFields()

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

withIndexFields

public TextPrefixHandler withIndexFields(java.lang.String indexFields)

setIndexFieldWeights

public void setIndexFieldWeights(java.lang.String indexFieldWeights)

Optional comma-separated list of weights applied to each index field targeted by this prefix handler.

getIndexFieldWeights

public java.lang.String getIndexFieldWeights()

Optional comma-separated list of weights applied to each index field targeted by this prefix handler.

withIndexFieldWeights

public TextPrefixHandler withIndexFieldWeights(java.lang.String indexFieldWeights)

setPerformMAX

public void setPerformMAX(boolean performMAX)

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

isPerformMAX

public boolean isPerformMAX()

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

withPerformMAX

public TextPrefixHandler withPerformMAX(boolean performMAX)

withPerformMAX

public TextPrefixHandler 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 TextPrefixHandler withPatternMaxMatches(int patternMaxMatches)

withPatternMaxMatches

public TextPrefixHandler withPatternMaxMatches(java.lang.Integer patternMaxMatches)

setUsePrefixedMappings

public void setUsePrefixedMappings(boolean usePrefixedMappings)

Prefixes the value with the prefix and #.
This must be used with the "prefixWithContext" option of analysis mappings.
For example: will transform: stuff_number1:test into: everything:stuff_number1#test

isUsePrefixedMappings

public boolean isUsePrefixedMappings()

Prefixes the value with the prefix and #.
This must be used with the "prefixWithContext" option of analysis mappings.
For example: will transform: stuff_number1:test into: everything:stuff_number1#test

withUsePrefixedMappings

public TextPrefixHandler withUsePrefixedMappings(boolean usePrefixedMappings)

withUsePrefixedMappings

public TextPrefixHandler withUsePrefixedMappings(java.lang.Boolean usePrefixedMappings)

setPatternSearch

public void setPatternSearch(boolean patternSearch)

Uses index field dictionaries for pattern expansion rather than linguistic dictionaries.

isPatternSearch

public boolean isPatternSearch()

Uses index field dictionaries for pattern expansion rather than linguistic dictionaries.

withPatternSearch

public TextPrefixHandler withPatternSearch(boolean patternSearch)

withPatternSearch

public TextPrefixHandler withPatternSearch(java.lang.Boolean patternSearch)

setTokenizationConfig

public void setTokenizationConfig(java.lang.String tokenizationConfig)

getTokenizationConfig

public java.lang.String getTokenizationConfig()

withTokenizationConfig

public TextPrefixHandler withTokenizationConfig(java.lang.String tokenizationConfig)

makeCopy

public TextPrefixHandler makeCopy()

Overrides:

makeCopy in class QueryPrefixHandler

readFrom

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

Read this TextPrefixHandler 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 QueryPrefixHandler

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this TextPrefixHandler.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this TextPrefixHandler.

Overrides:

toString in class QueryPrefixHandler

check

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

Checks this TextPrefixHandler.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class QueryPrefixHandler

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException