com.exalead.mercury.mami.search.v20

Class UnitsOfMeasurementPrefixHandler

java.lang.Object

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

com.exalead.mercury.mami.search.v20.UnitsOfMeasurementPrefixHandler

All Implemented Interfaces:

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

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

Searches for documents by resolving and converting values in the required unit of measurement

See Also:

Serialized Form

Nested Class Summary

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
java.lang.String	defaultUnitSymbol
java.lang.String	indexFieldTarget
java.lang.String	indexFieldUnitSymbol

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
UnitsOfMeasurementPrefixHandler()
UnitsOfMeasurementPrefixHandler(UnitsOfMeasurementPrefixHandler 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 UnitsOfMeasurementPrefixHandler.
static UnitsOfMeasurementPrefixHandler	fromString(java.lang.String s) String representation of this UnitsOfMeasurementPrefixHandler.
java.lang.String	getDefaultUnitSymbol() (Optional) A default unit symbol
java.lang.String	getIndexFieldTarget() The index field
java.lang.String	getIndexFieldUnitSymbol() The output unit symbol
UnitsOfMeasurementPrefixHandler	makeCopy() Creates and returns a deep copy of this UnitsOfMeasurementPrefixHandler.
static UnitsOfMeasurementPrefixHandler	readFrom(java.io.InputStream is) Read this UnitsOfMeasurementPrefixHandler from an XML fragment.
void	setDefaultUnitSymbol(java.lang.String defaultUnitSymbol) (Optional) A default unit symbol
void	setIndexFieldTarget(java.lang.String indexFieldTarget) The index field
void	setIndexFieldUnitSymbol(java.lang.String indexFieldUnitSymbol) The output unit symbol
java.lang.String	toString() String representation of this UnitsOfMeasurementPrefixHandler.
UnitsOfMeasurementPrefixHandler	withAliases(java.lang.String aliases)
UnitsOfMeasurementPrefixHandler	withDataModelClass(java.lang.String dataModelClass)
UnitsOfMeasurementPrefixHandler	withDataModelProperty(java.lang.String dataModelProperty)
UnitsOfMeasurementPrefixHandler	withDataModelState(java.lang.String dataModelState)
UnitsOfMeasurementPrefixHandler	withDefaultUnitSymbol(java.lang.String defaultUnitSymbol)
UnitsOfMeasurementPrefixHandler	withFromDataModel(QueryPrefixHandler fromDataModel)
UnitsOfMeasurementPrefixHandler	withIndexFieldTarget(java.lang.String indexFieldTarget)
UnitsOfMeasurementPrefixHandler	withIndexFieldUnitSymbol(java.lang.String indexFieldUnitSymbol)
UnitsOfMeasurementPrefixHandler	withName(java.lang.String name)
UnitsOfMeasurementPrefixHandler	withPrefixMatch(boolean prefixMatch)
UnitsOfMeasurementPrefixHandler	withPrefixMatch(java.lang.Boolean prefixMatch)
UnitsOfMeasurementPrefixHandler	withQueryExpansionConfig(java.lang.String queryExpansionConfig)
void	writeTo(java.io.OutputStream os) Write this UnitsOfMeasurementPrefixHandler 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

indexFieldTarget

public java.lang.String indexFieldTarget

indexFieldUnitSymbol

public java.lang.String indexFieldUnitSymbol

defaultUnitSymbol

public java.lang.String defaultUnitSymbol

Constructor Detail

UnitsOfMeasurementPrefixHandler

public UnitsOfMeasurementPrefixHandler()

UnitsOfMeasurementPrefixHandler

public UnitsOfMeasurementPrefixHandler(UnitsOfMeasurementPrefixHandler o)

Copy constructor

Method Detail

withName

public UnitsOfMeasurementPrefixHandler withName(java.lang.String name)

Overrides:

withName in class QueryPrefixHandler

withAliases

public UnitsOfMeasurementPrefixHandler withAliases(java.lang.String aliases)

Overrides:

withAliases in class QueryPrefixHandler

withQueryExpansionConfig

public UnitsOfMeasurementPrefixHandler withQueryExpansionConfig(java.lang.String queryExpansionConfig)

Overrides:

withQueryExpansionConfig in class QueryPrefixHandler

withDataModelState

public UnitsOfMeasurementPrefixHandler withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class QueryPrefixHandler

withFromDataModel

public UnitsOfMeasurementPrefixHandler withFromDataModel(QueryPrefixHandler fromDataModel)

withDataModelClass

public UnitsOfMeasurementPrefixHandler withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class QueryPrefixHandler

withDataModelProperty

public UnitsOfMeasurementPrefixHandler withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class QueryPrefixHandler

withPrefixMatch

public UnitsOfMeasurementPrefixHandler withPrefixMatch(boolean prefixMatch)

Overrides:

withPrefixMatch in class QueryPrefixHandler

withPrefixMatch

public UnitsOfMeasurementPrefixHandler withPrefixMatch(java.lang.Boolean prefixMatch)

Overrides:

withPrefixMatch in class QueryPrefixHandler

setIndexFieldTarget

public void setIndexFieldTarget(java.lang.String indexFieldTarget)

The index field

getIndexFieldTarget

public java.lang.String getIndexFieldTarget()

The index field

withIndexFieldTarget

public UnitsOfMeasurementPrefixHandler withIndexFieldTarget(java.lang.String indexFieldTarget)

setIndexFieldUnitSymbol

public void setIndexFieldUnitSymbol(java.lang.String indexFieldUnitSymbol)

The output unit symbol

getIndexFieldUnitSymbol

public java.lang.String getIndexFieldUnitSymbol()

The output unit symbol

withIndexFieldUnitSymbol

public UnitsOfMeasurementPrefixHandler withIndexFieldUnitSymbol(java.lang.String indexFieldUnitSymbol)

setDefaultUnitSymbol

public void setDefaultUnitSymbol(java.lang.String defaultUnitSymbol)

(Optional) A default unit symbol

getDefaultUnitSymbol

public java.lang.String getDefaultUnitSymbol()

(Optional) A default unit symbol

withDefaultUnitSymbol

public UnitsOfMeasurementPrefixHandler withDefaultUnitSymbol(java.lang.String defaultUnitSymbol)

makeCopy

public UnitsOfMeasurementPrefixHandler makeCopy()

Creates and returns a deep copy of this UnitsOfMeasurementPrefixHandler.

Overrides:

makeCopy in class QueryPrefixHandler

readFrom

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

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

Overrides:

writeTo in class QueryPrefixHandler

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this UnitsOfMeasurementPrefixHandler.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this UnitsOfMeasurementPrefixHandler.

Overrides:

toString in class QueryPrefixHandler

check

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

Checks this UnitsOfMeasurementPrefixHandler.

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