com.exalead.mercury.mami.indexing.v10

Class PointFieldConfig

java.lang.Object

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

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

com.exalead.mercury.mami.indexing.v10.PointFieldConfig

All Implemented Interfaces:

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

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

This type of field is used to store geographical points using either GPS coordinates (WGS84) or planar X,Y coordinates (Meter).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PointFieldConfig.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
int	blockSize
static int	DEFAULT_BLOCK_SIZE
static boolean	DEFAULT_EXACT
static java.lang.String	DEFAULT_GEO_TYPE
boolean	exact Deprecated.
java.lang.String	geoType

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
PointFieldConfig()
PointFieldConfig(PointFieldConfig 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 PointFieldConfig.
static PointFieldConfig	fromString(java.lang.String s) String representation of this PointFieldConfig.
int	getBlockSize()
java.lang.String	getGeoType() Value can be one of WGS84 Meter
PointFieldConfig.GeoType	getGeoTypeAsEnum() Value can be one of WGS84 Meter
static boolean	isA(java.lang.String str, PointFieldConfig.GeoType item)
boolean	isExact() Deprecated.
static boolean	isOneOf(java.lang.String str, PointFieldConfig.GeoType... items)
PointFieldConfig	makeCopy() Creates and returns a deep copy of this PointFieldConfig.
static PointFieldConfig	readFrom(java.io.InputStream is) Read this PointFieldConfig from an XML fragment.
void	setBlockSize(int blockSize)
void	setExact(boolean exact) Deprecated.
void	setGeoType(PointFieldConfig.GeoType item) Value can be one of WGS84 Meter
void	setGeoType(java.lang.String geoType) Value can be one of WGS84 Meter
java.lang.String	toString() String representation of this PointFieldConfig.
PointFieldConfig	withBlockSize(int blockSize)
PointFieldConfig	withBlockSize(java.lang.Integer blockSize)
PointFieldConfig	withDataModelClass(java.lang.String dataModelClass)
PointFieldConfig	withDataModelProperty(java.lang.String dataModelProperty)
PointFieldConfig	withDataModelState(java.lang.String dataModelState)
PointFieldConfig	withExact(boolean exact) Deprecated.
PointFieldConfig	withExact(java.lang.Boolean exact) Deprecated.
PointFieldConfig	withFieldName(java.lang.String fieldName)
PointFieldConfig	withFromDataModel(FieldConfig fromDataModel)
PointFieldConfig	withGeoType(java.lang.String geoType)
PointFieldConfig	withListsEncoderConfig(ListsEncoderConfig listsEncoderConfig)
PointFieldConfig	withMultiContext(boolean multiContext)
PointFieldConfig	withMultiContext(java.lang.Boolean multiContext)
PointFieldConfig	withMultivalued(boolean multivalued)
PointFieldConfig	withMultivalued(java.lang.Boolean multivalued)
PointFieldConfig	withRamBased(boolean ramBased)
PointFieldConfig	withRamBased(java.lang.Boolean ramBased)
PointFieldConfig	withRetrievable(boolean retrievable)
PointFieldConfig	withRetrievable(java.lang.Boolean retrievable)
PointFieldConfig	withSearchable(boolean searchable)
PointFieldConfig	withSearchable(java.lang.Boolean searchable)
PointFieldConfig	withVersion(int version)
PointFieldConfig	withVersion(java.lang.Integer version)
void	writeTo(java.io.OutputStream os) Write this PointFieldConfig 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

blockSize

public int blockSize

DEFAULT_BLOCK_SIZE

public static final int DEFAULT_BLOCK_SIZE

See Also:

Constant Field Values

exact

@Deprecated
public boolean exact

Deprecated.

DEFAULT_EXACT

public static final boolean DEFAULT_EXACT

See Also:

Constant Field Values

Constructor Detail

PointFieldConfig

public PointFieldConfig()

PointFieldConfig

public PointFieldConfig(PointFieldConfig o)

Copy constructor

Method Detail

isA

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

isOneOf

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

setGeoType

public void setGeoType(PointFieldConfig.GeoType item)

Value can be one of

• WGS84
• Meter

getGeoTypeAsEnum

public PointFieldConfig.GeoType getGeoTypeAsEnum()

Value can be one of

• WGS84
• Meter

withRamBased

public PointFieldConfig withRamBased(boolean ramBased)

Overrides:

withRamBased in class StandardFieldConfig

withRamBased

public PointFieldConfig withRamBased(java.lang.Boolean ramBased)

Overrides:

withRamBased in class StandardFieldConfig

withMultiContext

public PointFieldConfig withMultiContext(boolean multiContext)

Overrides:

withMultiContext in class StandardFieldConfig

withMultiContext

public PointFieldConfig withMultiContext(java.lang.Boolean multiContext)

Overrides:

withMultiContext in class StandardFieldConfig

withFieldName

public PointFieldConfig withFieldName(java.lang.String fieldName)

Overrides:

withFieldName in class StandardFieldConfig

withSearchable

public PointFieldConfig withSearchable(boolean searchable)

Overrides:

withSearchable in class StandardFieldConfig

withSearchable

public PointFieldConfig withSearchable(java.lang.Boolean searchable)

Overrides:

withSearchable in class StandardFieldConfig

withRetrievable

public PointFieldConfig withRetrievable(boolean retrievable)

Overrides:

withRetrievable in class StandardFieldConfig

withRetrievable

public PointFieldConfig withRetrievable(java.lang.Boolean retrievable)

Overrides:

withRetrievable in class StandardFieldConfig

withDataModelState

public PointFieldConfig withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class StandardFieldConfig

withFromDataModel

public PointFieldConfig withFromDataModel(FieldConfig fromDataModel)

Overrides:

withFromDataModel in class StandardFieldConfig

withDataModelClass

public PointFieldConfig withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class StandardFieldConfig

withDataModelProperty

public PointFieldConfig withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class StandardFieldConfig

withMultivalued

public PointFieldConfig withMultivalued(boolean multivalued)

Overrides:

withMultivalued in class StandardFieldConfig

withMultivalued

public PointFieldConfig withMultivalued(java.lang.Boolean multivalued)

Overrides:

withMultivalued in class StandardFieldConfig

withVersion

public PointFieldConfig withVersion(int version)

Overrides:

withVersion in class StandardFieldConfig

withVersion

public PointFieldConfig withVersion(java.lang.Integer version)

Overrides:

withVersion in class StandardFieldConfig

withListsEncoderConfig

public PointFieldConfig withListsEncoderConfig(ListsEncoderConfig listsEncoderConfig)

Overrides:

withListsEncoderConfig in class StandardFieldConfig

setGeoType

public void setGeoType(java.lang.String geoType)

Value can be one of

• WGS84
• Meter

getGeoType

public java.lang.String getGeoType()

Value can be one of

• WGS84
• Meter

withGeoType

public PointFieldConfig withGeoType(java.lang.String geoType)

setBlockSize

public void setBlockSize(int blockSize)

getBlockSize

public int getBlockSize()

withBlockSize

public PointFieldConfig withBlockSize(int blockSize)

withBlockSize

public PointFieldConfig withBlockSize(java.lang.Integer blockSize)

setExact

@Deprecated
public void setExact(boolean exact)

Deprecated.

isExact

@Deprecated
public boolean isExact()

Deprecated.

withExact

@Deprecated
public PointFieldConfig withExact(boolean exact)

Deprecated.

withExact

@Deprecated
public PointFieldConfig withExact(java.lang.Boolean exact)

Deprecated.

makeCopy

public PointFieldConfig makeCopy()

Creates and returns a deep copy of this PointFieldConfig.

Overrides:

makeCopy in class StandardFieldConfig

readFrom

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

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

Overrides:

writeTo in class StandardFieldConfig

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this PointFieldConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this PointFieldConfig.

Overrides:

toString in class StandardFieldConfig

check

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

Checks this PointFieldConfig.

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