com.exalead.mercury.mami.search.v20

Class GeoPrefixHandler

java.lang.Object

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

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

com.exalead.mercury.mami.search.v20.GeoPrefixHandler

All Implemented Interfaces:

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

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

Sets the geographic field for WITHIN and DISTANCE searches

See Also:

Serialized Form

Nested Class Summary

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 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
GeoPrefixHandler()
GeoPrefixHandler(GeoPrefixHandler 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 GeoPrefixHandler.
static GeoPrefixHandler	fromString(java.lang.String s) String representation of this GeoPrefixHandler.
GeoPrefixHandler	makeCopy() Creates and returns a deep copy of this GeoPrefixHandler.
static GeoPrefixHandler	readFrom(java.io.InputStream is) Read this GeoPrefixHandler from an XML fragment.
java.lang.String	toString() String representation of this GeoPrefixHandler.
GeoPrefixHandler	withAliases(java.lang.String aliases)
GeoPrefixHandler	withDataModelClass(java.lang.String dataModelClass)
GeoPrefixHandler	withDataModelProperty(java.lang.String dataModelProperty)
GeoPrefixHandler	withDataModelState(java.lang.String dataModelState)
GeoPrefixHandler	withFromDataModel(QueryPrefixHandler fromDataModel)
GeoPrefixHandler	withIndexField(java.lang.String indexField)
GeoPrefixHandler	withName(java.lang.String name)
GeoPrefixHandler	withPrefixMatch(boolean prefixMatch)
GeoPrefixHandler	withPrefixMatch(java.lang.Boolean prefixMatch)
GeoPrefixHandler	withQueryExpansionConfig(java.lang.String queryExpansionConfig)
void	writeTo(java.io.OutputStream os) Write this GeoPrefixHandler 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

Constructor Detail

GeoPrefixHandler

public GeoPrefixHandler()

GeoPrefixHandler

public GeoPrefixHandler(GeoPrefixHandler o)

Copy constructor

Method Detail

withIndexField

public GeoPrefixHandler withIndexField(java.lang.String indexField)

Overrides:

withIndexField in class IndexFieldPrefixHandler

withName

public GeoPrefixHandler withName(java.lang.String name)

Overrides:

withName in class IndexFieldPrefixHandler

withAliases

public GeoPrefixHandler withAliases(java.lang.String aliases)

Overrides:

withAliases in class IndexFieldPrefixHandler

withQueryExpansionConfig

public GeoPrefixHandler withQueryExpansionConfig(java.lang.String queryExpansionConfig)

Overrides:

withQueryExpansionConfig in class IndexFieldPrefixHandler

withDataModelState

public GeoPrefixHandler withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class IndexFieldPrefixHandler

withFromDataModel

public GeoPrefixHandler withFromDataModel(QueryPrefixHandler fromDataModel)

Overrides:

withFromDataModel in class IndexFieldPrefixHandler

withDataModelClass

public GeoPrefixHandler withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class IndexFieldPrefixHandler

withDataModelProperty

public GeoPrefixHandler withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class IndexFieldPrefixHandler

withPrefixMatch

public GeoPrefixHandler withPrefixMatch(boolean prefixMatch)

Overrides:

withPrefixMatch in class IndexFieldPrefixHandler

withPrefixMatch

public GeoPrefixHandler withPrefixMatch(java.lang.Boolean prefixMatch)

Overrides:

withPrefixMatch in class IndexFieldPrefixHandler

makeCopy

public GeoPrefixHandler makeCopy()

Creates and returns a deep copy of this GeoPrefixHandler.

Overrides:

makeCopy in class IndexFieldPrefixHandler

readFrom

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

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

Overrides:

writeTo in class IndexFieldPrefixHandler

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this GeoPrefixHandler.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this GeoPrefixHandler.

Overrides:

toString in class IndexFieldPrefixHandler

check

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

Checks this GeoPrefixHandler.

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