com.exalead.mercury.mami.search.v20

Class EnumFacetPrefixHandler

java.lang.Object

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

com.exalead.mercury.mami.search.v20.EnumFacetPrefixHandler

All Implemented Interfaces:

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

public class EnumFacetPrefixHandler
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 class	EnumFacetPrefixHandler.InvalidValueAction
static class	EnumFacetPrefixHandler.Mode

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_INVALID_VALUE_ACTION
static java.lang.String	DEFAULT_MODE
java.lang.String	enumFacetId
java.lang.String	invalidValueAction
java.lang.String	mode

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
EnumFacetPrefixHandler()
EnumFacetPrefixHandler(EnumFacetPrefixHandler 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 EnumFacetPrefixHandler.
static EnumFacetPrefixHandler	fromString(java.lang.String s) String representation of this EnumFacetPrefixHandler.
java.lang.String	getEnumFacetId() The EnumFacet id this prefix handler refers to.
java.lang.String	getInvalidValueAction() What to do when an invalid value is passed: remove: removes the whole prefix XXX ignore: ? XXX error: fails the query
EnumFacetPrefixHandler.InvalidValueAction	getInvalidValueActionAsEnum() What to do when an invalid value is passed: remove: removes the whole prefix XXX ignore: ? XXX error: fails the query
java.lang.String	getMode() What to do with the prefix handler value: "exact": Does nothing "tolower": Converts the value to lower case "toupper": Converts the value to upper case { @code enum ("exact", "tolower", "toupper")}
EnumFacetPrefixHandler.Mode	getModeAsEnum() What to do with the prefix handler value: "exact": Does nothing "tolower": Converts the value to lower case "toupper": Converts the value to upper case { @code enum ("exact", "tolower", "toupper")}
static boolean	isA(java.lang.String str, EnumFacetPrefixHandler.InvalidValueAction item)
static boolean	isA(java.lang.String str, EnumFacetPrefixHandler.Mode item)
static boolean	isOneOf(java.lang.String str, EnumFacetPrefixHandler.InvalidValueAction... items)
static boolean	isOneOf(java.lang.String str, EnumFacetPrefixHandler.Mode... items)
EnumFacetPrefixHandler	makeCopy() Creates and returns a deep copy of this EnumFacetPrefixHandler.
static EnumFacetPrefixHandler	readFrom(java.io.InputStream is) Read this EnumFacetPrefixHandler from an XML fragment.
void	setEnumFacetId(java.lang.String enumFacetId) The EnumFacet id this prefix handler refers to.
void	setInvalidValueAction(EnumFacetPrefixHandler.InvalidValueAction item) What to do when an invalid value is passed: remove: removes the whole prefix XXX ignore: ? XXX error: fails the query
void	setInvalidValueAction(java.lang.String invalidValueAction) What to do when an invalid value is passed: remove: removes the whole prefix XXX ignore: ? XXX error: fails the query
void	setMode(EnumFacetPrefixHandler.Mode item) What to do with the prefix handler value: "exact": Does nothing "tolower": Converts the value to lower case "toupper": Converts the value to upper case { @code enum ("exact", "tolower", "toupper")}
void	setMode(java.lang.String mode) What to do with the prefix handler value: "exact": Does nothing "tolower": Converts the value to lower case "toupper": Converts the value to upper case { @code enum ("exact", "tolower", "toupper")}
java.lang.String	toString() String representation of this EnumFacetPrefixHandler.
EnumFacetPrefixHandler	withAliases(java.lang.String aliases)
EnumFacetPrefixHandler	withDataModelClass(java.lang.String dataModelClass)
EnumFacetPrefixHandler	withDataModelProperty(java.lang.String dataModelProperty)
EnumFacetPrefixHandler	withDataModelState(java.lang.String dataModelState)
EnumFacetPrefixHandler	withEnumFacetId(java.lang.String enumFacetId)
EnumFacetPrefixHandler	withFromDataModel(QueryPrefixHandler fromDataModel)
EnumFacetPrefixHandler	withInvalidValueAction(java.lang.String invalidValueAction)
EnumFacetPrefixHandler	withMode(java.lang.String mode)
EnumFacetPrefixHandler	withName(java.lang.String name)
EnumFacetPrefixHandler	withPrefixMatch(boolean prefixMatch)
EnumFacetPrefixHandler	withPrefixMatch(java.lang.Boolean prefixMatch)
EnumFacetPrefixHandler	withQueryExpansionConfig(java.lang.String queryExpansionConfig)
void	writeTo(java.io.OutputStream os) Write this EnumFacetPrefixHandler 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

enumFacetId

public java.lang.String enumFacetId

mode

public java.lang.String mode

DEFAULT_MODE

public static final java.lang.String DEFAULT_MODE

See Also:

Constant Field Values

invalidValueAction

public java.lang.String invalidValueAction

DEFAULT_INVALID_VALUE_ACTION

public static final java.lang.String DEFAULT_INVALID_VALUE_ACTION

See Also:

Constant Field Values

Constructor Detail

EnumFacetPrefixHandler

public EnumFacetPrefixHandler()

EnumFacetPrefixHandler

public EnumFacetPrefixHandler(EnumFacetPrefixHandler o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          EnumFacetPrefixHandler.Mode item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              EnumFacetPrefixHandler.Mode... items)

setMode

public void setMode(EnumFacetPrefixHandler.Mode item)

What to do with the prefix handler value:

• "exact": Does nothing
• "tolower": Converts the value to lower case
• "toupper": Converts the value to upper case

{ @code enum ("exact", "tolower", "toupper")}

getModeAsEnum

public EnumFacetPrefixHandler.Mode getModeAsEnum()

What to do with the prefix handler value:

• "exact": Does nothing
• "tolower": Converts the value to lower case
• "toupper": Converts the value to upper case

{ @code enum ("exact", "tolower", "toupper")}

isA

public static boolean isA(java.lang.String str,
                          EnumFacetPrefixHandler.InvalidValueAction item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              EnumFacetPrefixHandler.InvalidValueAction... items)

setInvalidValueAction

public void setInvalidValueAction(EnumFacetPrefixHandler.InvalidValueAction item)

What to do when an invalid value is passed:

• remove: removes the whole prefix XXX
• ignore: ? XXX
• error: fails the query

getInvalidValueActionAsEnum

public EnumFacetPrefixHandler.InvalidValueAction getInvalidValueActionAsEnum()

What to do when an invalid value is passed:

• remove: removes the whole prefix XXX
• ignore: ? XXX
• error: fails the query

withName

public EnumFacetPrefixHandler withName(java.lang.String name)

Overrides:

withName in class QueryPrefixHandler

withAliases

public EnumFacetPrefixHandler withAliases(java.lang.String aliases)

Overrides:

withAliases in class QueryPrefixHandler

withQueryExpansionConfig

public EnumFacetPrefixHandler withQueryExpansionConfig(java.lang.String queryExpansionConfig)

Overrides:

withQueryExpansionConfig in class QueryPrefixHandler

withDataModelState

public EnumFacetPrefixHandler withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class QueryPrefixHandler

withFromDataModel

public EnumFacetPrefixHandler withFromDataModel(QueryPrefixHandler fromDataModel)

withDataModelClass

public EnumFacetPrefixHandler withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class QueryPrefixHandler

withDataModelProperty

public EnumFacetPrefixHandler withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class QueryPrefixHandler

withPrefixMatch

public EnumFacetPrefixHandler withPrefixMatch(boolean prefixMatch)

Overrides:

withPrefixMatch in class QueryPrefixHandler

withPrefixMatch

public EnumFacetPrefixHandler withPrefixMatch(java.lang.Boolean prefixMatch)

Overrides:

withPrefixMatch in class QueryPrefixHandler

setEnumFacetId

public void setEnumFacetId(java.lang.String enumFacetId)

The EnumFacet id this prefix handler refers to.

Value must be any non-empty string

getEnumFacetId

public java.lang.String getEnumFacetId()

The EnumFacet id this prefix handler refers to.

Value must be any non-empty string

withEnumFacetId

public EnumFacetPrefixHandler withEnumFacetId(java.lang.String enumFacetId)

setMode

public void setMode(java.lang.String mode)

What to do with the prefix handler value:

• "exact": Does nothing
• "tolower": Converts the value to lower case
• "toupper": Converts the value to upper case

{ @code enum ("exact", "tolower", "toupper")}

getMode

public java.lang.String getMode()

What to do with the prefix handler value:

• "exact": Does nothing
• "tolower": Converts the value to lower case
• "toupper": Converts the value to upper case

{ @code enum ("exact", "tolower", "toupper")}

withMode

public EnumFacetPrefixHandler withMode(java.lang.String mode)

setInvalidValueAction

public void setInvalidValueAction(java.lang.String invalidValueAction)

What to do when an invalid value is passed:

• remove: removes the whole prefix XXX
• ignore: ? XXX
• error: fails the query

getInvalidValueAction

public java.lang.String getInvalidValueAction()

What to do when an invalid value is passed:

• remove: removes the whole prefix XXX
• ignore: ? XXX
• error: fails the query

withInvalidValueAction

public EnumFacetPrefixHandler withInvalidValueAction(java.lang.String invalidValueAction)

makeCopy

public EnumFacetPrefixHandler makeCopy()

Creates and returns a deep copy of this EnumFacetPrefixHandler.

Overrides:

makeCopy in class QueryPrefixHandler

readFrom

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

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

Overrides:

writeTo in class QueryPrefixHandler

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this EnumFacetPrefixHandler.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this EnumFacetPrefixHandler.

Overrides:

toString in class QueryPrefixHandler

check

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

Checks this EnumFacetPrefixHandler.

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