Document
for indexing and searching.See: Description
Class | Description |
---|---|
BigIntegerPoint |
An indexed 128-bit
BigInteger field. |
BinaryDocValuesField |
Field that stores a per-document
BytesRef value. |
BinaryPoint |
An indexed binary field for fast range filters.
|
DateTools |
Provides support for converting dates to strings and vice-versa.
|
Document |
Documents are the unit of indexing and search.
|
DocumentStoredFieldVisitor |
A
StoredFieldVisitor that creates a Document from stored fields. |
DoubleDocValuesField |
Syntactic sugar for encoding doubles as NumericDocValues
via
Double.doubleToRawLongBits(double) . |
DoublePoint |
An indexed
double field for fast range filters. |
DoubleRange |
An indexed Double Range field.
|
FeatureField |
Field that can be used to store static scoring factors into
documents. |
FeatureField.FeatureFunction | |
FeatureField.FeatureTokenStream | |
FeatureField.LogFunction | |
FeatureField.SaturationFunction | |
FeatureField.SigmoidFunction | |
FeatureQuery | |
Field |
Expert: directly create a field for a document.
|
Field.BinaryTokenStream | |
Field.StringTokenStream | |
FieldType |
Describes the properties of a field.
|
FloatDocValuesField |
Syntactic sugar for encoding floats as NumericDocValues
via
Float.floatToRawIntBits(float) . |
FloatPoint |
An indexed
float field for fast range filters. |
FloatPointNearestNeighbor |
KNN search on top of N dimensional indexed float points.
|
FloatPointNearestNeighbor.Cell | |
FloatPointNearestNeighbor.NearestHit | |
FloatPointNearestNeighbor.NearestVisitor | |
FloatRange |
An indexed Float Range field.
|
HalfFloatPoint |
An indexed
half-float field for fast range filters. |
InetAddressPoint |
An indexed 128-bit
InetAddress field. |
InetAddressRange |
An indexed InetAddress Range Field
|
IntPoint |
An indexed
int field for fast range filters. |
IntRange |
An indexed Integer Range field.
|
LatLonBoundingBox |
An indexed 2-Dimension Bounding Box field for the Geospatial Lat/Lon Coordinate system
|
LatLonDocValuesBoxQuery |
Distance query for
LatLonDocValuesField . |
LatLonDocValuesDistanceQuery |
Distance query for
LatLonDocValuesField . |
LatLonDocValuesField |
An per-document location field.
|
LatLonPoint |
An indexed location field.
|
LatLonPointDistanceComparator |
Compares documents by distance from an origin point
|
LatLonPointDistanceFeatureQuery | |
LatLonPointDistanceQuery |
Distance query for
LatLonPoint . |
LatLonPointInPolygonQuery |
Finds all previously indexed points that fall within the specified polygons.
|
LatLonPointSortField |
Sorts by distance from an origin location.
|
LatLonShape |
An indexed shape utility class.
|
LatLonShape.LatLonTriangle |
polygons are decomposed into tessellated triangles using
Tessellator
these triangles are encoded and inserted as separate indexed POINT fields |
LatLonShapeBoundingBoxQuery |
Finds all previously indexed shapes that intersect the specified bounding box.
|
LatLonShapeLineQuery |
Finds all previously indexed shapes that intersect the specified arbitrary
Line . |
LatLonShapePolygonQuery |
Finds all previously indexed shapes that intersect the specified arbitrary.
|
LatLonShapeQuery |
Base LatLonShape Query class providing common query logic for
LatLonShapeBoundingBoxQuery and LatLonShapePolygonQuery
Note: this class implements the majority of the INTERSECTS, WITHIN, DISJOINT relation logic |
LatLonShapeQuery.RelationScorerSupplier |
utility class for implementing constant score logic specific to INTERSECT, WITHIN, and DISJOINT
|
LazyDocument |
Defers actually loading a field's value until you ask
for it.
|
LongDistanceFeatureQuery | |
LongPoint |
An indexed
long field for fast range filters. |
LongRange |
An indexed Long Range field.
|
NumericDocValuesField |
Field that stores a per-document
long value for scoring,
sorting or value retrieval. |
RangeFieldQuery |
Query class for searching
RangeField types by a defined PointValues.Relation . |
SortedDocValuesField |
Field that stores
a per-document
BytesRef value, indexed for
sorting. |
SortedNumericDocValuesField |
Field that stores a per-document
long values for scoring,
sorting or value retrieval. |
SortedNumericDocValuesRangeQuery | |
SortedSetDocValuesField |
Field that stores
a set of per-document
BytesRef values, indexed for
faceting,grouping,joining. |
SortedSetDocValuesRangeQuery | |
StoredField |
A field whose value is stored so that
IndexSearcher.doc(int) and IndexReader.document() will
return the field and its value. |
StringField |
A field that is indexed but not tokenized: the entire
String value is indexed as a single token.
|
TextField |
A field that is indexed and tokenized, without term
vectors.
|
Enum | Description |
---|---|
DateTools.Resolution |
Specifies the time granularity.
|
Field.Store |
Specifies whether and how a field should be stored.
|
LatLonShape.QueryRelation |
Query Relation Types
|
RangeFieldQuery.QueryType |
Used by
RangeFieldQuery to check how each internal or leaf node relates to the query. |
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.
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.
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