com.exalead.mercury.mami.indexing.v10

Class GeoFieldConfig

java.lang.Object

com.exalead.mercury.mami.indexing.v10.FieldConfig

com.exalead.mercury.mami.indexing.v10.StandardFieldConfig

com.exalead.mercury.mami.indexing.v10.GeoFieldConfig

All Implemented Interfaces:

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

public class GeoFieldConfig
extends StandardFieldConfig
implements com.exalead.util.Checkable, java.io.Serializable

This type of field is used to store 2D geometries using either planar X,Y coordinates (Meter).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GeoFieldConfig.GeoType

Nested classes/interfaces inherited from class com.exalead.mercury.mami.indexing.v10.StandardFieldConfig

StandardFieldConfig.Transformer<T>, StandardFieldConfig.Visitor

Nested classes/interfaces inherited from class com.exalead.mercury.mami.indexing.v10.FieldConfig

FieldConfig.FromDataModel

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	bboxFieldName
static java.lang.String	DEFAULT_GEO_TYPE
static int	DEFAULT_MAX_BLOCK_SIZE
static int	DEFAULT_PRECISION
java.lang.String	geoType
int	maxBlockSize
int	precision

Fields inherited from class com.exalead.mercury.mami.indexing.v10.StandardFieldConfig

DEFAULT_MULTI_CONTEXT, DEFAULT_RAM_BASED, multiContext, ramBased

Fields inherited from class com.exalead.mercury.mami.indexing.v10.FieldConfig

dataModelClass, dataModelProperty, dataModelState, DEFAULT_MULTIVALUED, DEFAULT_RETRIEVABLE, DEFAULT_SEARCHABLE, DEFAULT_VERSION, fieldName, fromDataModel, listsEncoderConfig, multivalued, retrievable, searchable, version

Constructor Summary

Constructors

Constructor and Description
GeoFieldConfig()
GeoFieldConfig(GeoFieldConfig o) Copy constructor

Method Summary

Modifier and Type	Method and Description
<T> T	accept(FieldConfig.Transformer<T> transformer, T[] t)
void	accept(FieldConfig.Visitor visitor)
<T> T	accept(StandardFieldConfig.Transformer<T> transformer, T[] t)
void	accept(StandardFieldConfig.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this GeoFieldConfig.
static GeoFieldConfig	fromString(java.lang.String s) String representation of this GeoFieldConfig.
java.lang.String	getBboxFieldName()
java.lang.String	getGeoType() Value can be one of Meter
GeoFieldConfig.GeoType	getGeoTypeAsEnum() Value can be one of Meter
int	getMaxBlockSize()
int	getPrecision()
static boolean	isA(java.lang.String str, GeoFieldConfig.GeoType item)
static boolean	isOneOf(java.lang.String str, GeoFieldConfig.GeoType... items)
GeoFieldConfig	makeCopy() Creates and returns a deep copy of this GeoFieldConfig.
static GeoFieldConfig	readFrom(java.io.InputStream is) Read this GeoFieldConfig from an XML fragment.
void	setBboxFieldName(java.lang.String bboxFieldName)
void	setGeoType(GeoFieldConfig.GeoType item) Value can be one of Meter
void	setGeoType(java.lang.String geoType) Value can be one of Meter
void	setMaxBlockSize(int maxBlockSize)
void	setPrecision(int precision)
java.lang.String	toString() String representation of this GeoFieldConfig.
GeoFieldConfig	withBboxFieldName(java.lang.String bboxFieldName)
GeoFieldConfig	withDataModelClass(java.lang.String dataModelClass)
GeoFieldConfig	withDataModelProperty(java.lang.String dataModelProperty)
GeoFieldConfig	withDataModelState(java.lang.String dataModelState)
GeoFieldConfig	withFieldName(java.lang.String fieldName)
GeoFieldConfig	withFromDataModel(FieldConfig fromDataModel)
GeoFieldConfig	withGeoType(java.lang.String geoType)
GeoFieldConfig	withListsEncoderConfig(ListsEncoderConfig listsEncoderConfig)
GeoFieldConfig	withMaxBlockSize(int maxBlockSize)
GeoFieldConfig	withMaxBlockSize(java.lang.Integer maxBlockSize)
GeoFieldConfig	withMultiContext(boolean multiContext)
GeoFieldConfig	withMultiContext(java.lang.Boolean multiContext)
GeoFieldConfig	withMultivalued(boolean multivalued)
GeoFieldConfig	withMultivalued(java.lang.Boolean multivalued)
GeoFieldConfig	withPrecision(int precision)
GeoFieldConfig	withPrecision(java.lang.Integer precision)
GeoFieldConfig	withRamBased(boolean ramBased)
GeoFieldConfig	withRamBased(java.lang.Boolean ramBased)
GeoFieldConfig	withRetrievable(boolean retrievable)
GeoFieldConfig	withRetrievable(java.lang.Boolean retrievable)
GeoFieldConfig	withSearchable(boolean searchable)
GeoFieldConfig	withSearchable(java.lang.Boolean searchable)
GeoFieldConfig	withVersion(int version)
GeoFieldConfig	withVersion(java.lang.Integer version)
void	writeTo(java.io.OutputStream os) Write this GeoFieldConfig as an XML fragment

Methods inherited from class com.exalead.mercury.mami.indexing.v10.StandardFieldConfig

isMultiContext, isRamBased, setMultiContext, setRamBased

Methods inherited from class com.exalead.mercury.mami.indexing.v10.FieldConfig

getDataModelClass, getDataModelProperty, getDataModelState, getFieldName, getFromDataModel, getListsEncoderConfig, getVersion, isMultivalued, isRetrievable, isSearchable, setDataModelClass, setDataModelProperty, setDataModelState, setFieldName, setFromDataModel, setListsEncoderConfig, setMultivalued, setRetrievable, setSearchable, setVersion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

geoType

public java.lang.String geoType

DEFAULT_GEO_TYPE

public static final java.lang.String DEFAULT_GEO_TYPE

See Also:

Constant Field Values

maxBlockSize

public int maxBlockSize

DEFAULT_MAX_BLOCK_SIZE

public static final int DEFAULT_MAX_BLOCK_SIZE

See Also:

Constant Field Values

precision

public int precision

DEFAULT_PRECISION

public static final int DEFAULT_PRECISION

See Also:

Constant Field Values

bboxFieldName

public java.lang.String bboxFieldName

Constructor Detail

GeoFieldConfig

public GeoFieldConfig()

GeoFieldConfig

public GeoFieldConfig(GeoFieldConfig o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          GeoFieldConfig.GeoType item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              GeoFieldConfig.GeoType... items)

setGeoType

public void setGeoType(GeoFieldConfig.GeoType item)

Value can be one of

• Meter

getGeoTypeAsEnum

public GeoFieldConfig.GeoType getGeoTypeAsEnum()

Value can be one of

• Meter

withRamBased

public GeoFieldConfig withRamBased(boolean ramBased)

Overrides:

withRamBased in class StandardFieldConfig

withRamBased

public GeoFieldConfig withRamBased(java.lang.Boolean ramBased)

Overrides:

withRamBased in class StandardFieldConfig

withMultiContext

public GeoFieldConfig withMultiContext(boolean multiContext)

Overrides:

withMultiContext in class StandardFieldConfig

withMultiContext

public GeoFieldConfig withMultiContext(java.lang.Boolean multiContext)

Overrides:

withMultiContext in class StandardFieldConfig

withFieldName

public GeoFieldConfig withFieldName(java.lang.String fieldName)

Overrides:

withFieldName in class StandardFieldConfig

withSearchable

public GeoFieldConfig withSearchable(boolean searchable)

Overrides:

withSearchable in class StandardFieldConfig

withSearchable

public GeoFieldConfig withSearchable(java.lang.Boolean searchable)

Overrides:

withSearchable in class StandardFieldConfig

withRetrievable

public GeoFieldConfig withRetrievable(boolean retrievable)

Overrides:

withRetrievable in class StandardFieldConfig

withRetrievable

public GeoFieldConfig withRetrievable(java.lang.Boolean retrievable)

Overrides:

withRetrievable in class StandardFieldConfig

withDataModelState

public GeoFieldConfig withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class StandardFieldConfig

withFromDataModel

public GeoFieldConfig withFromDataModel(FieldConfig fromDataModel)

Overrides:

withFromDataModel in class StandardFieldConfig

withDataModelClass

public GeoFieldConfig withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class StandardFieldConfig

withDataModelProperty

public GeoFieldConfig withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class StandardFieldConfig

withMultivalued

public GeoFieldConfig withMultivalued(boolean multivalued)

Overrides:

withMultivalued in class StandardFieldConfig

withMultivalued

public GeoFieldConfig withMultivalued(java.lang.Boolean multivalued)

Overrides:

withMultivalued in class StandardFieldConfig

withVersion

public GeoFieldConfig withVersion(int version)

Overrides:

withVersion in class StandardFieldConfig

withVersion

public GeoFieldConfig withVersion(java.lang.Integer version)

Overrides:

withVersion in class StandardFieldConfig

withListsEncoderConfig

public GeoFieldConfig withListsEncoderConfig(ListsEncoderConfig listsEncoderConfig)

Overrides:

withListsEncoderConfig in class StandardFieldConfig

setGeoType

public void setGeoType(java.lang.String geoType)

Value can be one of

• Meter

getGeoType

public java.lang.String getGeoType()

Value can be one of

• Meter

withGeoType

public GeoFieldConfig withGeoType(java.lang.String geoType)

setMaxBlockSize

public void setMaxBlockSize(int maxBlockSize)

getMaxBlockSize

public int getMaxBlockSize()

withMaxBlockSize

public GeoFieldConfig withMaxBlockSize(int maxBlockSize)

withMaxBlockSize

public GeoFieldConfig withMaxBlockSize(java.lang.Integer maxBlockSize)

setPrecision

public void setPrecision(int precision)

getPrecision

public int getPrecision()

withPrecision

public GeoFieldConfig withPrecision(int precision)

withPrecision

public GeoFieldConfig withPrecision(java.lang.Integer precision)

setBboxFieldName

public void setBboxFieldName(java.lang.String bboxFieldName)

getBboxFieldName

public java.lang.String getBboxFieldName()

withBboxFieldName

public GeoFieldConfig withBboxFieldName(java.lang.String bboxFieldName)

makeCopy

public GeoFieldConfig makeCopy()

Creates and returns a deep copy of this GeoFieldConfig.

Overrides:

makeCopy in class StandardFieldConfig

readFrom

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

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

Overrides:

writeTo in class StandardFieldConfig

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this GeoFieldConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this GeoFieldConfig.

Overrides:

toString in class StandardFieldConfig

check

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

Checks this GeoFieldConfig.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class StandardFieldConfig

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class StandardFieldConfig

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class FieldConfig

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class StandardFieldConfig

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class FieldConfig

Throws:

com.exalead.util.TypedException