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
public abstract class ShapeDocValuesField extends Field
A doc values field forLatLonShapeandXYShapethat usesShapeDocValuesas the underlying binary doc value format.Note that this class cannot be instantiated directly due to different encodings
XYEncodingUtilsandGeoEncodingUtilsConcrete Implementations include:
LatLonShapeDocValuesFieldandXYShapeDocValuesField- 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 Description protected static FieldTypeFIELD_TYPEFieldType for ShapeDocValues fieldprotected org.apache.lucene.document.ShapeDocValuesshapeDocValuesthe binary doc value format for this field-
Fields inherited from class org.apache.lucene.document.Field
fieldsData, name, tokenStream, type
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract doubledecodeX(int encoded)decodes x coordinates from encoded spaceprotected abstract doubledecodeY(int encoded)decodes y coordinates from encoded spaceIndexableFieldTypefieldType()Gets theIndexableFieldTypefor this ShapeDocValue fieldabstract GeometrygetBoundingBox()retrieves the bounding box for the geometryabstract GeometrygetCentroid()retrieves the centroid location for the geometryShapeField.DecodedTriangle.TYPEgetHighestDimensionType()Retrieves the highest dimensional type (POINT, LINE, TRIANGLE) for computing the geometry(s) centroidStringname()The name of the fieldstatic QuerynewGeometryQuery(String field, ShapeField.QueryRelation relation, Object... geometries)Creates a geometry query for shape docvaluesintnumberOfTerms()Returns the number of terms (tessellated triangles) for this shapeStringstringValue()Currently there is no string representation for the ShapeDocValueFieldTokenStreamtokenStream(Analyzer analyzer, TokenStream reuse)TokenStreams are not yet supported-
Methods 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 Detail
-
shapeDocValues
protected final org.apache.lucene.document.ShapeDocValues shapeDocValues
the binary doc value format for this field
-
FIELD_TYPE
protected static final FieldType FIELD_TYPE
FieldType for ShapeDocValues field
-
-
Method Detail
-
name
public String name()
The name of the field- Specified by:
namein interfaceIndexableField- Overrides:
namein classField
-
fieldType
public IndexableFieldType fieldType()
Gets theIndexableFieldTypefor this ShapeDocValue field- Specified by:
fieldTypein interfaceIndexableField- Overrides:
fieldTypein classField
-
stringValue
public String stringValue()
Currently there is no string representation for the ShapeDocValueField- Specified by:
stringValuein interfaceIndexableField- Overrides:
stringValuein classField
-
tokenStream
public TokenStream tokenStream(Analyzer analyzer, TokenStream reuse)
TokenStreams are not yet supported- Specified by:
tokenStreamin interfaceIndexableField- Overrides:
tokenStreamin 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
public abstract Geometry getCentroid()
retrieves the centroid location for the geometry
-
getBoundingBox
public abstract Geometry getBoundingBox()
retrieves the bounding box for the geometry
-
getHighestDimensionType
public ShapeField.DecodedTriangle.TYPE 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
-
-