com.exalead.mercury.mami.search.v20

Class PositionPrefixHandler

java.lang.Object

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

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

com.exalead.mercury.mami.search.v20.PositionPrefixHandler

All Implemented Interfaces:

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

public class PositionPrefixHandler
extends IndexFieldPrefixHandler
implements com.exalead.util.Checkable, java.io.Serializable

Searches in an alphanumerical field using the anchoring position (i.e.
restricting the match to be at a specific position).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PositionPrefixHandler.MatchingMode
static class	PositionPrefixHandler.PositionMatchMode

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

IndexFieldPrefixHandler.Transformer<T>, IndexFieldPrefixHandler.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 java.lang.String	DEFAULT_MATCHING_MODE
static java.lang.String	DEFAULT_POSITION_MATCH_MODE
java.lang.String	matchingMode
java.lang.String	positionMatchMode
java.lang.String	tokenizationConfig

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

Method Summary

Modifier and Type	Method and Description
<T> T	accept(IndexFieldPrefixHandler.Transformer<T> transformer, T[] t)
void	accept(IndexFieldPrefixHandler.Visitor visitor)
<T> T	accept(QueryPrefixHandler.Transformer<T> transformer, T[] t)
void	accept(QueryPrefixHandler.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this PositionPrefixHandler.
static PositionPrefixHandler	fromString(java.lang.String s) String representation of this PositionPrefixHandler.
java.lang.String	getMatchingMode() The matching mode defines how the query words are looked up in the index.
PositionPrefixHandler.MatchingMode	getMatchingModeAsEnum() The matching mode defines how the query words are looked up in the index.
java.lang.String	getPositionMatchMode() Choose between 'exact', 'startsWith' and 'endsWith'
PositionPrefixHandler.PositionMatchMode	getPositionMatchModeAsEnum() Choose between 'exact', 'startsWith' and 'endsWith'
java.lang.String	getTokenizationConfig()
static boolean	isA(java.lang.String str, PositionPrefixHandler.MatchingMode item)
static boolean	isA(java.lang.String str, PositionPrefixHandler.PositionMatchMode item)
static boolean	isOneOf(java.lang.String str, PositionPrefixHandler.MatchingMode... items)
static boolean	isOneOf(java.lang.String str, PositionPrefixHandler.PositionMatchMode... items)
PositionPrefixHandler	makeCopy() Creates and returns a deep copy of this PositionPrefixHandler.
static PositionPrefixHandler	readFrom(java.io.InputStream is) Read this PositionPrefixHandler from an XML fragment.
void	setMatchingMode(PositionPrefixHandler.MatchingMode item) The matching mode defines how the query words are looked up in the index.
void	setMatchingMode(java.lang.String matchingMode) The matching mode defines how the query words are looked up in the index.
void	setPositionMatchMode(PositionPrefixHandler.PositionMatchMode item) Choose between 'exact', 'startsWith' and 'endsWith'
void	setPositionMatchMode(java.lang.String positionMatchMode) Choose between 'exact', 'startsWith' and 'endsWith'
void	setTokenizationConfig(java.lang.String tokenizationConfig)
java.lang.String	toString() String representation of this PositionPrefixHandler.
PositionPrefixHandler	withAliases(java.lang.String aliases)
PositionPrefixHandler	withDataModelClass(java.lang.String dataModelClass)
PositionPrefixHandler	withDataModelProperty(java.lang.String dataModelProperty)
PositionPrefixHandler	withDataModelState(java.lang.String dataModelState)
PositionPrefixHandler	withFromDataModel(QueryPrefixHandler fromDataModel)
PositionPrefixHandler	withIndexField(java.lang.String indexField)
PositionPrefixHandler	withMatchingMode(java.lang.String matchingMode)
PositionPrefixHandler	withName(java.lang.String name)
PositionPrefixHandler	withPositionMatchMode(java.lang.String positionMatchMode)
PositionPrefixHandler	withPrefixMatch(boolean prefixMatch)
PositionPrefixHandler	withPrefixMatch(java.lang.Boolean prefixMatch)
PositionPrefixHandler	withQueryExpansionConfig(java.lang.String queryExpansionConfig)
PositionPrefixHandler	withTokenizationConfig(java.lang.String tokenizationConfig)
void	writeTo(java.io.OutputStream os) Write this PositionPrefixHandler as an XML fragment

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

getIndexField, setIndexField

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

positionMatchMode

public java.lang.String positionMatchMode

DEFAULT_POSITION_MATCH_MODE

public static final java.lang.String DEFAULT_POSITION_MATCH_MODE

See Also:

Constant Field Values

tokenizationConfig

public java.lang.String tokenizationConfig

Constructor Detail

PositionPrefixHandler

public PositionPrefixHandler()

PositionPrefixHandler

public PositionPrefixHandler(PositionPrefixHandler o)

Copy constructor

Method Detail

isA

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

isOneOf

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

setMatchingMode

public void setMatchingMode(PositionPrefixHandler.MatchingMode item)

The matching mode defines how the query words are looked up in the index. Value can be null or one of

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

getMatchingModeAsEnum

public PositionPrefixHandler.MatchingMode getMatchingModeAsEnum()

The matching mode defines how the query words are looked up in the index. Value can be null or one of

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

isA

public static boolean isA(java.lang.String str,
                          PositionPrefixHandler.PositionMatchMode item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              PositionPrefixHandler.PositionMatchMode... items)

setPositionMatchMode

public void setPositionMatchMode(PositionPrefixHandler.PositionMatchMode item)

Choose between 'exact', 'startsWith' and 'endsWith'

getPositionMatchModeAsEnum

public PositionPrefixHandler.PositionMatchMode getPositionMatchModeAsEnum()

Choose between 'exact', 'startsWith' and 'endsWith'

withIndexField

public PositionPrefixHandler withIndexField(java.lang.String indexField)

Overrides:

withIndexField in class IndexFieldPrefixHandler

withName

public PositionPrefixHandler withName(java.lang.String name)

Overrides:

withName in class IndexFieldPrefixHandler

withAliases

public PositionPrefixHandler withAliases(java.lang.String aliases)

Overrides:

withAliases in class IndexFieldPrefixHandler

withQueryExpansionConfig

public PositionPrefixHandler withQueryExpansionConfig(java.lang.String queryExpansionConfig)

Overrides:

withQueryExpansionConfig in class IndexFieldPrefixHandler

withDataModelState

public PositionPrefixHandler withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class IndexFieldPrefixHandler

withFromDataModel

public PositionPrefixHandler withFromDataModel(QueryPrefixHandler fromDataModel)

Overrides:

withFromDataModel in class IndexFieldPrefixHandler

withDataModelClass

public PositionPrefixHandler withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class IndexFieldPrefixHandler

withDataModelProperty

public PositionPrefixHandler withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class IndexFieldPrefixHandler

withPrefixMatch

public PositionPrefixHandler withPrefixMatch(boolean prefixMatch)

Overrides:

withPrefixMatch in class IndexFieldPrefixHandler

withPrefixMatch

public PositionPrefixHandler withPrefixMatch(java.lang.Boolean prefixMatch)

Overrides:

withPrefixMatch in class IndexFieldPrefixHandler

setMatchingMode

public void setMatchingMode(java.lang.String matchingMode)

The matching mode defines how the query words are looked up in the index. Value can be null or one of

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

getMatchingMode

public java.lang.String getMatchingMode()

The matching mode defines how the query words are looked up in the index. Value can be null or one of

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

withMatchingMode

public PositionPrefixHandler withMatchingMode(java.lang.String matchingMode)

setPositionMatchMode

public void setPositionMatchMode(java.lang.String positionMatchMode)

Choose between 'exact', 'startsWith' and 'endsWith'

getPositionMatchMode

public java.lang.String getPositionMatchMode()

Choose between 'exact', 'startsWith' and 'endsWith'

withPositionMatchMode

public PositionPrefixHandler withPositionMatchMode(java.lang.String positionMatchMode)

setTokenizationConfig

public void setTokenizationConfig(java.lang.String tokenizationConfig)

getTokenizationConfig

public java.lang.String getTokenizationConfig()

withTokenizationConfig

public PositionPrefixHandler withTokenizationConfig(java.lang.String tokenizationConfig)

makeCopy

public PositionPrefixHandler makeCopy()

Creates and returns a deep copy of this PositionPrefixHandler.

Overrides:

makeCopy in class IndexFieldPrefixHandler

readFrom

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

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

Overrides:

writeTo in class IndexFieldPrefixHandler

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this PositionPrefixHandler.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this PositionPrefixHandler.

Overrides:

toString in class IndexFieldPrefixHandler

check

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

Checks this PositionPrefixHandler.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class IndexFieldPrefixHandler

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class IndexFieldPrefixHandler

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

Specified by:

accept in class IndexFieldPrefixHandler

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