Package org.apache.lucene.document
Class XYShapeDocValuesField
java.lang.Object
org.apache.lucene.document.Field
org.apache.lucene.document.ShapeDocValuesField
org.apache.lucene.document.XYShapeDocValuesField
- All Implemented Interfaces:
IndexableField
Concrete implementation of a
ShapeDocValuesField for cartesian geometries.
This field should be instantiated through XYShape.createDocValueField(String, XYLine)
XYShape.createDocValueField(String, XYPolygon)for indexing a cartesian polygon doc value field.XYShape.createDocValueField(String, XYLine)for indexing a cartesian linestring doc value.XYShape.createDocValueField(String, float, float)for indexing a x, y cartesian point doc value.XYShape.createDocValueField(String, List)for indexing a cartesian doc value from a precomputed tessellation.XYShape.createDocValueField(String, BytesRef)for indexing a cartesian doc value from existing encoding.
LatLonPoint, vertex values are indexed with some loss of precision
from the original double values.- See Also:
- 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 inherited from class org.apache.lucene.document.ShapeDocValuesField
FIELD_TYPE, shapeDocValuesFields inherited from class org.apache.lucene.document.Field
fieldsData, name, type -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedXYShapeDocValuesField(String name, List<ShapeField.DecodedTriangle> tessellation) constructs aXYShapeDocValueFieldfrom a pre-tessellated geometryprotectedXYShapeDocValuesField(String name, BytesRef binaryValue) Creates aXYShapeDocValueFieldfrom a given serialized value -
Method Summary
Methods inherited from class org.apache.lucene.document.ShapeDocValuesField
fieldType, getHighestDimensionType, name, newGeometryQuery, numberOfTerms, stringValue, tokenStreamMethods inherited from class org.apache.lucene.document.Field
binaryValue, getCharSequenceValue, invertableType, numericValue, readerValue, setBytesValue, setBytesValue, setByteValue, setDoubleValue, setFloatValue, setIntValue, setLongValue, setReaderValue, setShortValue, setStringValue, setTokenStream, storedValue, tokenStreamValue, toString
-
Constructor Details
-
XYShapeDocValuesField
constructs aXYShapeDocValueFieldfrom a pre-tessellated geometry -
XYShapeDocValuesField
Creates aXYShapeDocValueFieldfrom a given serialized value
-
-
Method Details
-
getCentroid
retrieves the centroid location for the geometry- Specified by:
getCentroidin classShapeDocValuesField
-
getBoundingBox
Description copied from class:ShapeDocValuesFieldretrieves the bounding box for the geometry- Specified by:
getBoundingBoxin classShapeDocValuesField
-
decodeX
protected double decodeX(int encoded) Description copied from class:ShapeDocValuesFielddecodes x coordinates from encoded space- Specified by:
decodeXin classShapeDocValuesField
-
decodeY
protected double decodeY(int encoded) Description copied from class:ShapeDocValuesFielddecodes y coordinates from encoded space- Specified by:
decodeYin classShapeDocValuesField
-