Package org.apache.lucene.document
Class ShapeDocValuesField
java.lang.Object
org.apache.lucene.document.Field
org.apache.lucene.document.ShapeDocValuesField
- All Implemented Interfaces:
IndexableField
- Direct Known Subclasses:
LatLonShapeDocValuesField
,XYShapeDocValuesField
A doc values field for
LatLonShape
and XYShape
that uses ShapeDocValues
as the underlying binary doc value format.
Note that this class cannot be instantiated directly due to different encodings XYEncodingUtils
and GeoEncodingUtils
Concrete Implementations include: LatLonShapeDocValuesField
and XYShapeDocValuesField
- 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
Modifier and TypeFieldDescriptionprotected static final FieldType
FieldType for ShapeDocValues fieldprotected final org.apache.lucene.document.ShapeDocValues
the binary doc value format for this fieldFields inherited from class org.apache.lucene.document.Field
fieldsData, name, tokenStream, type
-
Method Summary
Modifier and TypeMethodDescriptionprotected abstract double
decodeX
(int encoded) decodes x coordinates from encoded spaceprotected abstract double
decodeY
(int encoded) decodes y coordinates from encoded spaceGets theIndexableFieldType
for this ShapeDocValue fieldabstract Geometry
retrieves the bounding box for the geometryabstract Geometry
retrieves the centroid location for the geometryRetrieves the highest dimensional type (POINT, LINE, TRIANGLE) for computing the geometry(s) centroidname()
The name of the fieldstatic Query
newGeometryQuery
(String field, ShapeField.QueryRelation relation, Object... geometries) Creates a geometry query for shape docvaluesint
Returns the number of terms (tessellated triangles) for this shapeCurrently there is no string representation for the ShapeDocValueFieldtokenStream
(Analyzer analyzer, TokenStream reuse) TokenStreams are not yet supportedMethods 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
-
Field Details
-
shapeDocValues
protected final org.apache.lucene.document.ShapeDocValues shapeDocValuesthe binary doc value format for this field -
FIELD_TYPE
FieldType for ShapeDocValues field
-
-
Method Details
-
name
The name of the field- Specified by:
name
in interfaceIndexableField
- Overrides:
name
in classField
-
fieldType
Gets theIndexableFieldType
for this ShapeDocValue field- Specified by:
fieldType
in interfaceIndexableField
- Overrides:
fieldType
in classField
-
stringValue
Currently there is no string representation for the ShapeDocValueField- Specified by:
stringValue
in interfaceIndexableField
- Overrides:
stringValue
in classField
-
tokenStream
TokenStreams are not yet supported- Specified by:
tokenStream
in interfaceIndexableField
- Overrides:
tokenStream
in classField
- Parameters:
analyzer
- Analyzer that should be used to create the TokenStreams fromreuse
- TokenStream for a previous instance of this field name. This allows custom field types (like StringField and NumericField) that do not use the analyzer to still have good performance. Note: the passed-in type may be inappropriate, for example if you mix up different types of Fields for the same field name. So it's the responsibility of the implementation to check.- Returns:
- TokenStream value for indexing the document. Should always return a non-null value if the field is to be indexed
-
numberOfTerms
public int numberOfTerms()Returns the number of terms (tessellated triangles) for this shape -
newGeometryQuery
public static Query newGeometryQuery(String field, ShapeField.QueryRelation relation, Object... geometries) Creates a geometry query for shape docvalues -
getCentroid
retrieves the centroid location for the geometry -
getBoundingBox
retrieves the bounding box for the geometry -
getHighestDimensionType
Retrieves the highest dimensional type (POINT, LINE, TRIANGLE) for computing the geometry(s) centroid -
decodeX
protected abstract double decodeX(int encoded) decodes x coordinates from encoded space -
decodeY
protected abstract double decodeY(int encoded) decodes y coordinates from encoded space
-