Package org.apache.lucene.document
Document
for indexing and
searching.
The document package provides the user level logical representation of content to be indexed
and searched. The package also provides utilities for working with Document
s and IndexableField
s.
Document and IndexableField
A Document
is a collection of IndexableField
s. A IndexableField
is a
logical representation of a user's content that needs to be indexed or stored. IndexableField
s have a number of properties that tell Lucene how to
treat the content (like indexed, tokenized, stored, etc.) See the Field
implementation of IndexableField
for specifics on these properties.
Note: it is common to refer to Document
s having Field
s, even though technically they have IndexableField
s.
Working with Documents
First and foremost, a Document
is something created by the
user application. It is your job to create Documents based on the content of the files you are
working with in your application (Word, txt, PDF, Excel or any other format.) How this is done is
completely up to you. That being said, there are many tools available in other projects that can
make the process of taking a file and converting it into a Lucene Document
.
The DateTools
is a utility class to make dates and times
searchable. IntPoint
, LongPoint
, FloatPoint
and DoublePoint
enable indexing of numeric values (and also dates) for
fast range queries using PointRangeQuery
-
ClassDescriptionBase query class for ShapeDocValues queries.Field that stores a per-document
BytesRef
value.An indexed binary field for fast range filters.A binary representation of a range that wraps a BinaryDocValues fieldProvides support for converting dates to strings and vice-versa.Specifies the time granularity.Documents are the unit of indexing and search.AStoredFieldVisitor
that creates aDocument
from stored fields.Set of longs, optimized for docvalues usageSyntactic sugar for encoding doubles as NumericDocValues viaDouble.doubleToRawLongBits(double)
.Field that stores a per-documentdouble
value for scoring, sorting or value retrieval and index the field for fast range filters.An indexeddouble
field for fast range filters.An indexed Double Range field.DocValues field for DoubleRange.ADoubleValuesSource
instance which can be used to read the values of a feature from aFeatureField
for documents.Field
that can be used to store static scoring factors into documents.Sorts using the value of a specified feature name from aFeatureField
.Expert: directly create a field for a document.Specifies whether and how a field should be stored.Describes the properties of a field.Syntactic sugar for encoding floats as NumericDocValues viaFloat.floatToRawIntBits(float)
.Field that stores a per-documentfloat
value for scoring, sorting or value retrieval and index the field for fast range filters.An indexedfloat
field for fast range filters.An indexed Float Range field.DocValues field for FloatRange.An indexed 128-bitInetAddress
field.An indexed InetAddress Range FieldField that stores a per-documentint
value for scoring, sorting or value retrieval and index the field for fast range filters.An indexedint
field for fast range filters.An indexed Integer Range field.DocValues field for IntRange.Describes how anIndexableField
should be inverted for indexing terms and postings.Field that indexes a per-document String orBytesRef
into an inverted index for fast filtering, stores values in a columnar fashion usingDocValuesType.SORTED_SET
doc values for sorting and faceting, and optionally stores values as stored fields for top-hits retrieval.A field that contains a single byte numeric vector (or none) for each document.A field that contains a single floating-point numeric vector (or none) for each document.Distance query forLatLonDocValuesField
.An per-document location field.Finds all previously indexed geo points that comply the givenShapeField.QueryRelation
with the specified array ofLatLonGeometry
.An indexed location field.Compares documents by distance from an origin pointDistance query forLatLonPoint
.Finds all previously indexed geo points that comply the givenShapeField.QueryRelation
with the specified array ofLatLonGeometry
.Sorts by distance from an origin location.An geo shape utility class for indexing and searching gis geometries whose vertices are latitude, longitude values (in decimal degrees).Finds all previously indexed geo shapes that intersect the specified bounding box.Holds spatial logic for a bounding box that works in the encoded spaceA concrete implementation ofShapeDocValues
for storing binary doc value representation ofLatLonShape
geometries in aLatLonShapeDocValuesField
Concrete implementation of aShapeDocValuesField
for geographic geometries.Bounding Box query forShapeDocValuesField
representingXYShape
Finds all previously indexed geo shapes that comply the givenShapeField.QueryRelation
with the specified array ofLatLonGeometry
.Field that stores a per-documentlong
value for scoring, sorting or value retrieval and index the field for fast range filters.An indexedlong
field for fast range filters.An indexed Long Range field.DocValues field for LongRange.KNN search on top of 2D lat/lon indexed points.Field that stores a per-documentlong
value for scoring, sorting or value retrieval.Query class for searchingRangeField
types by a definedPointValues.Relation
.Used byRangeFieldQuery
to check how each internal or leaf node relates to the query.A binary doc values format representation forLatLonShape
andXYShape
A doc values field forLatLonShape
andXYShape
that usesShapeDocValues
as the underlying binary doc value format.A base shape utility class used for both LatLon (spherical) and XY (cartesian) shape fields.Represents a encoded triangle usingShapeField.decodeTriangle(byte[], DecodedTriangle)
.type of triangleQuery Relation Types *polygons are decomposed into tessellated triangles usingTessellator
these triangles are encoded and inserted as separate indexed POINT fieldsField that stores a per-documentBytesRef
value, indexed for sorting.Field that stores a per-documentlong
values for scoring, sorting or value retrieval.Similar to SortedNumericDocValuesRangeQuery but for a setField that stores a set of per-documentBytesRef
values, indexed for faceting,grouping,joining.Holds spatial logic for a bounding box that works in the encoded spaceutility class for implementing constant score logic specific to INTERSECT, WITHIN, and DISJOINTVisitor used for walking the BKD tree.A field whose value is stored so thatIndexSearcher.storedFields()
andIndexReader.storedFields()
will return the field and its value.Abstraction around a stored value.Type of aStoredValue
.A field that is indexed but not tokenized: the entire String value is indexed as a single token.A field that is indexed and tokenized, without term vectors.An per-document location field.XYGeometry query forXYDocValuesField
.Compares documents by distance from an origin pointAn indexed XY position field.Finds all previously indexed points that fall within the specified XY geometries.Sorts by distance from an origin location.A cartesian shape utility class for indexing and searching geometries whose vertices are unitless x, y values.A concrete implementation ofShapeDocValues
for storing binary doc value representation ofXYShape
geometries in aXYShapeDocValuesField
Concrete implementation of aShapeDocValuesField
for cartesian geometries.Bounding Box query forShapeDocValuesField
representingXYShape
Finds all previously indexed cartesian shapes that comply the givenShapeField.QueryRelation
with the specified array ofXYGeometry
.