# Package org.apache.lucene.document

The logical representation of a `Document` for indexing and searching.

See: Description

- Class Summary
  Class | Description
  --- | ---
  BinaryDocValuesField | Field that stores a per-document `BytesRef` value.
  ByteDocValuesField | Deprecated use `NumericDocValuesField` instead.
  CompressionTools | Simple utility class providing static methods to compress and decompress binary data for stored fields.
  DateTools | Provides support for converting dates to strings and vice-versa.
  DerefBytesDocValuesField | Deprecated Use `BinaryDocValuesField` instead.
  Document | Documents are the unit of indexing and search.
  DocumentStoredFieldVisitor | A `StoredFieldVisitor` that creates a `Document` containing all stored fields, or only specific requested fields provided to `DocumentStoredFieldVisitor.DocumentStoredFieldVisitor(Set)`.
  DoubleDocValuesField | Syntactic sugar for encoding doubles as NumericDocValues via `Double.doubleToRawLongBits(double)`.
  DoubleField | Field that indexes `double` values for efficient range filtering and sorting.
  Field | Expert: directly create a field for a document.
  FieldType | Describes the properties of a field.
  FloatDocValuesField | Syntactic sugar for encoding floats as NumericDocValues via `Float.floatToRawIntBits(float)`.
  FloatField | Field that indexes `float` values for efficient range filtering and sorting.
  IntDocValuesField | Deprecated use `NumericDocValuesField` instead.
  IntField | Field that indexes `int` values for efficient range filtering and sorting.
  LongDocValuesField | Deprecated use `NumericDocValuesField` instead.
  LongField | Field that indexes `long` values for efficient range filtering and sorting.
  NumericDocValuesField | Field that stores a per-document `long` value for scoring, sorting or value retrieval.
  PackedLongDocValuesField | Deprecated use `NumericDocValuesField` instead.
  ShortDocValuesField | Deprecated use `NumericDocValuesField` instead.
  SortedBytesDocValuesField | Deprecated Use `SortedDocValuesField` instead.
  SortedDocValuesField | Field that stores a per-document `BytesRef` value, indexed for sorting.
  SortedSetDocValuesField | Field that stores a set of per-document `BytesRef` values, indexed for faceting,grouping,joining.
  StoredField | A field whose value is stored so that `IndexSearcher.doc(int)` and `IndexReader.document(int, org.apache.lucene.index.StoredFieldVisitor)` will return the field and its value.
  StraightBytesDocValuesField | Deprecated Use `BinaryDocValuesField` instead.
  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 Summary
  Enum | Description
  --- | ---
  DateTools.Resolution | Specifies the time granularity.
  Field.Index | Deprecated This is here only to ease transition from the pre-4.0 APIs.
  Field.Store | Specifies whether and how a field should be stored.
  Field.TermVector | Deprecated This is here only to ease transition from the pre-4.0 APIs.
  FieldType.NumericType | Data type of the numeric value

## Package org.apache.lucene.document Description

The logical representation of a `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 (remember, Lucene only searches text). `IntField`, `LongField`, `FloatField` and `DoubleField` are a special helper class to simplify indexing of numeric values (and also dates) for fast range range queries with `NumericRangeQuery` (using a special sortable string representation of numeric values).

Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.