Package-level declarations
Types
Field that stores a per-document BytesRef value.
An indexed binary field for fast range filters. If you also need to store the value, you should add a separate StoredField instance.
A binary representation of a range that wraps a BinaryDocValues field
Documents are the unit of indexing and search.
A StoredFieldVisitor that creates a Document from stored fields.
Syntactic sugar for encoding doubles as NumericDocValues via Double.doubleToRawLongBits.
Field that stores a per-document double value for scoring, sorting or value retrieval and index the field for fast range filters. If you need more fine-grained control you can use DoublePoint, DoubleDocValuesField and StoredField.
An indexed double field for fast range filters. If you also need to store the value, you should add a separate StoredField instance.
An indexed Double Range field.
DocValues field for DoubleRange. This is a single valued field i.e. can have only one value per document due to being an extension of BinaryDocValuesField.
Field that can be used to store static scoring factors into documents. This is mostly inspired from the work from Nick Craswell, Stephen Robertson, Hugo Zaragoza and Michael Taylor. Relevance weighting for query independent evidence. Proceedings of the 28th annual international ACM SIGIR conference on Research and development in information retrieval. August 15-19, 2005, Salvador, Brazil.
Expert: directly create a field for a document. Most users should use one of the sugar subclasses:
Describes the properties of a field.
Syntactic sugar for encoding floats as NumericDocValues via Float.floatToRawIntBits.
Field that stores a per-document float value for scoring, sorting or value retrieval and index the field for fast range filters. If you need more fine-grained control you can use FloatPoint, FloatDocValuesField and StoredField.
An indexed float field for fast range filters. If you also need to store the value, you should add a separate StoredField instance.
An indexed Float Range field.
DocValues field for FloatRange. This is a single valued field per document due to being an extension of BinaryDocValuesField.
An indexed 128-bit InetAddress field.
Create a new InetAddressRange from min/max value
Field that stores a per-document int value for scoring, sorting or value retrieval and index the field for fast range filters. If you need more fine-grained control you can use IntPoint, NumericDocValuesField or SortedNumericDocValuesField, and StoredField.
DocValues field for IntRange. This is a single valued field per document due to being an extension of BinaryDocValuesField.
Describes how an IndexableField should be inverted for indexing terms and postings.
Field that indexes a per-document String or BytesRef into an inverted index for fast filtering, stores values in a columnar fashion using DocValuesType.SORTED_SET doc values for sorting and faceting, and optionally stores values as stored fields for top-hits retrieval. This field does not support scoring: queries produce constant scores. If you need more fine-grained control you can use StringField, SortedDocValuesField or [ ], and StoredField.
A field that contains a single byte numeric vector (or none) for each document. Vectors are dense
A field that contains a single floating-point numeric vector (or none) for each document. Vectors are dense - that is, every dimension of a vector contains an explicit value, stored packed into an array (of type float[]) whose length is the vector dimension. Values can be retrieved using FloatVectorValues, which is a forward-only docID-based iterator and also offers random-access by dense ordinal (not docId). VectorSimilarityFunction may be used to compare vectors at query time (for example as part of result ranking). A [ ] may be associated with a search similarity function defining the metric used for nearest-neighbor search among vectors of that field.
An per-document location field.
An indexed location field.
A geo shape utility class for indexing and searching GIS geometries whose vertices are latitude, longitude values (in decimal degrees).
A concrete implementation of ShapeDocValues for storing binary doc value representation of LatLonShape geometries in a LatLonShapeDocValuesField.
Concrete implementation of a ShapeDocValuesField for geographic geometries.
Field that stores a per-document long value for scoring, sorting or value retrieval and index the field for fast range filters. If you need more fine-grained control you can use LongPoint, NumericDocValuesField or SortedNumericDocValuesField, and StoredField.
DocValues field for LongRange. This is a single valued field per document due to being an extension of BinaryDocValuesField.
Field that stores a per-document long value for scoring, sorting or value retrieval. Here's an example usage:
Query class for searching RangeField types by a defined Relation.
A binary doc values format representation for LatLonShape and XYShape.
A doc values field for LatLonShape and XYShape that uses ShapeDocValues as the underlying binary doc value format.
A base shape utility class used for both LatLon (spherical) and XY (cartesian) shape fields.
Field that stores a per-document BytesRef value, indexed for sorting. Here's an example usage:
Field that stores a per-document long values for scoring, sorting or value retrieval. Here's an example usage:
Field that stores a set of per-document BytesRef values, indexed for faceting,grouping,joining. Here's an example usage:
A field whose value is stored so that IndexSearcher.storedFields and IndexReader.storedFields will return the field and its value.
Abstraction around a stored value.
A field that is indexed but not tokenized, indexing the entire string as a single token. This is a simplified port of Lucene's StringField.
An per-document location field.
XYGeometry query for XYDocValuesField.
An indexed XY position field.
A concrete implementation of ShapeDocValues for storing binary doc value representation of XYShape geometries in a XYShapeDocValuesField
Concrete implementation of a ShapeDocValuesField for cartesian geometries.