## Uses of Class
org.apache.lucene.document.Document

Packages that use Document
org.apache.lucene.ant: Ant task to create Lucene indexes.
org.apache.lucene.benchmark.byTask.feeds: Sources for benchmark inputs: documents and queries.
org.apache.lucene.benchmark.byTask.tasks: Extendable benchmark tasks.
org.apache.lucene.demo
org.apache.lucene.index: Code to maintain and access indices.
org.apache.lucene.search: Code to search indices.
org.apache.lucene.search.highlight: The highlight package contains classes to provide "keyword in context" features typically used to highlight search terms in the text of results pages.
org.apache.lucene.store.instantiated: InstantiatedIndex, alternative RAM store for small corpora.

Uses of Document in org.apache.lucene.ant

Methods in org.apache.lucene.ant that return Document
`static Document` `HtmlDocument.Document(java.io.File file)` Creates a Lucene `Document` from a `File`.
`static Document` `TextDocument.Document(java.io.File f)` Makes a document for a File.
`static Document` `HtmlDocument.Document(java.io.File file, java.lang.String tidyConfigFile)` Creates a Lucene `Document` from a `File`.
`Document` `FileExtensionDocumentHandler.getDocument(java.io.File file)` Gets the document attribute of the FileExtensionDocumentHandler object
`Document` `DocumentHandler.getDocument(java.io.File file)` Gets the document attribute of the DocumentHandler object
`static Document` `HtmlDocument.getDocument(java.io.InputStream is)` Creates a Lucene `Document` from an `InputStream`.

Uses of Document in org.apache.lucene.benchmark.byTask.feeds

Methods in org.apache.lucene.benchmark.byTask.feeds that return Document
`Document` `DocMaker.makeDocument()` Creates a `Document` object ready for indexing.
`Document` `DocMaker.makeDocument(int size)` Same as `DocMaker.makeDocument()`, only this method creates a document of the given size input by `size`.

Uses of Document in org.apache.lucene.benchmark.byTask.tasks

Methods in org.apache.lucene.benchmark.byTask.tasks that return Document
`protected Document` `SearchTravRetLoadFieldSelectorTask.retrieveDoc(IndexReader ir, int id)`
`protected Document` `ReadTask.retrieveDoc(IndexReader ir, int id)`

Methods in org.apache.lucene.benchmark.byTask.tasks with parameters of type Document
`abstract int` `BenchmarkHighlighter.doHighlight(IndexReader reader, int doc, java.lang.String field, Document document, Analyzer analyzer, java.lang.String text)`
`protected java.util.Collection` `SearchTravRetVectorHighlightTask.getFieldsToHighlight(Document document)`
`protected java.util.Collection` `SearchTravRetHighlightTask.getFieldsToHighlight(Document document)`
`protected java.util.Collection` `ReadTask.getFieldsToHighlight(Document document)` Define the fields to highlight.

Uses of Document in org.apache.lucene.demo

Methods in org.apache.lucene.demo that return Document
`static Document` `FileDocument.Document(java.io.File f)` Makes a document for a File.
`static Document` `HTMLDocument.Document(java.io.File f)`

Uses of Document in org.apache.lucene.index

Methods in org.apache.lucene.index that return Document
`Document` `IndexReader.document(int n)` Returns the stored fields of the `n`th `Document` in this index.
`Document` `ParallelReader.document(int n, FieldSelector fieldSelector)`
`Document` `MultiReader.document(int n, FieldSelector fieldSelector)`
`Document` `FilterIndexReader.document(int n, FieldSelector fieldSelector)`
`abstract Document` `IndexReader.document(int n, FieldSelector fieldSelector)` Get the `Document` at the `n` th position.
`Document` `SegmentReader.document(int n, FieldSelector fieldSelector)`

Methods in org.apache.lucene.index with parameters of type Document
`void` `IndexModifier.addDocument(Document doc)` Deprecated. Adds a document to this index.
`void` `IndexWriter.addDocument(Document doc)` Adds a document to this index.
`void` `IndexModifier.addDocument(Document doc, Analyzer docAnalyzer)` Deprecated. Adds a document to this index, using the provided analyzer instead of the one specific in the constructor.
`void` `IndexWriter.addDocument(Document doc, Analyzer analyzer)` Adds a document to this index, using the provided analyzer instead of the value of `IndexWriter.getAnalyzer()`.
`void` `IndexWriter.updateDocument(Term term, Document doc)` Updates a document by first deleting the document(s) containing `term` and then adding the new document.
`void` `IndexWriter.updateDocument(Term term, Document doc, Analyzer analyzer)` Updates a document by first deleting the document(s) containing `term` and then adding the new document.

Uses of Document in org.apache.lucene.search

Methods in org.apache.lucene.search that return Document
`Document` `RemoteSearchable.doc(int i)`
`Document` `MultiSearcher.doc(int n)`
`Document` `IndexSearcher.doc(int i)`
`Document` `Hits.doc(int n)` Deprecated. Returns the stored fields of the nth document in this set.
`Document` `Searchable.doc(int i)` Returns the stored fields of document `i`.
`abstract Document` `Searcher.doc(int i)`
`Document` `RemoteSearchable.doc(int i, FieldSelector fieldSelector)`
`Document` `MultiSearcher.doc(int n, FieldSelector fieldSelector)`
`Document` `IndexSearcher.doc(int i, FieldSelector fieldSelector)`
`Document` `Searchable.doc(int n, FieldSelector fieldSelector)` Get the `Document` at the `n`th position.
`Document` `Hit.getDocument()` Deprecated. Returns document for this hit.

Uses of Document in org.apache.lucene.search.highlight

Methods in org.apache.lucene.search.highlight with parameters of type Document
`static TokenStream` `TokenSources.getAnyTokenStream(IndexReader reader, int docId, java.lang.String field, Document doc, Analyzer analyzer)` A convenience method that tries to first get a TermPositionVector for the specified docId, then, falls back to using the passed in `Document` to retrieve the TokenStream.
`static TokenStream` `TokenSources.getTokenStream(Document doc, java.lang.String field, Analyzer analyzer)`

Uses of Document in org.apache.lucene.store.instantiated

Methods in org.apache.lucene.store.instantiated that return Document
`Document` `InstantiatedIndexReader.document(int n)` Returns the stored fields of the `n`th `Document` in this index.
`Document` `InstantiatedIndexReader.document(int n, FieldSelector fieldSelector)` Return the `Document` at the `n`th position.
`Document` `InstantiatedDocument.getDocument()`

Methods in org.apache.lucene.store.instantiated with parameters of type Document
`void` `InstantiatedIndexWriter.addDocument(Document doc)` Adds a document to this index.
`void` `InstantiatedIndexWriter.addDocument(Document doc, Analyzer analyzer)` Adds a document to this index, using the provided analyzer instead of the value of `InstantiatedIndexWriter.getAnalyzer()`.
`void` `InstantiatedIndexWriter.updateDocument(Term term, Document doc)`
`void` `InstantiatedIndexWriter.updateDocument(Term term, Document doc, Analyzer analyzer)`

Constructors in org.apache.lucene.store.instantiated with parameters of type Document
`InstantiatedDocument(Document document)`

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