org.apache.lucene.spatial3d

Class Geo3DPoint

java.lang.Object

org.apache.lucene.document.Field

org.apache.lucene.spatial3d.Geo3DPoint

All Implemented Interfaces:

IndexableField

public final class Geo3DPoint
extends Field

Add this to a document to index lat/lon or x/y/z point, indexed as a 3D point. Multiple values are allowed: just add multiple Geo3DPoint to the document with the same field name.

This field defines static factory methods for creating a shape query:

• newShapeQuery() for matching all points inside a specified shape

See Also:

PointValues

WARNING: This API is experimental and might change in incompatible ways in the next release.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.document.Field

Field.Store

Field Summary

Fields

Modifier and Type	Field and Description
static FieldType	TYPE Indexing FieldType.

Fields inherited from class org.apache.lucene.document.Field

boost, fieldsData, name, tokenStream, type

Constructor Summary

Constructors

Constructor and Description
Geo3DPoint(String name, double lat, double lon) Creates a new Geo3DPoint field with the specified lat, lon (in radians).
Geo3DPoint(String name, double x, double y, double z) Creates a new Geo3DPoint field with the specified x,y,z.

Method Summary

Modifier and Type	Method and Description
static double	decodeDimension(byte[] value, int offset) Decode single dimension
static void	encodeDimension(double value, byte[] bytes, int offset) Encode single dimension
static Query	newShapeQuery(String field, GeoShape shape) Returns a query matching all points inside the provided shape.
String	toString()

Methods inherited from class org.apache.lucene.document.Field

binaryValue, boost, fieldType, name, numericValue, readerValue, setBoost, setBytesValue, setBytesValue, setByteValue, setDoubleValue, setFloatValue, setIntValue, setLongValue, setReaderValue, setShortValue, setStringValue, setTokenStream, stringValue, tokenStream, tokenStreamValue

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final FieldType TYPE

Indexing FieldType.

Constructor Detail

Geo3DPoint

public Geo3DPoint(String name,
                  double lat,
                  double lon)

Creates a new Geo3DPoint field with the specified lat, lon (in radians).

Throws:

IllegalArgumentException - if the field name is null or lat or lon are out of bounds

Geo3DPoint

public Geo3DPoint(String name,
                  double x,
                  double y,
                  double z)

Creates a new Geo3DPoint field with the specified x,y,z.

Throws:

IllegalArgumentException - if the field name is null or lat or lon are out of bounds

Method Detail

encodeDimension

public static void encodeDimension(double value,
                                   byte[] bytes,
                                   int offset)

Encode single dimension

decodeDimension

public static double decodeDimension(byte[] value,
                                     int offset)

Decode single dimension

newShapeQuery

public static Query newShapeQuery(String field,
                                  GeoShape shape)

Returns a query matching all points inside the provided shape.

Parameters:

field - field name. must not be null.

shape - Which GeoShape to match

toString

public String toString()

Overrides:

toString in class Field