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

Packages that use Document
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.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.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, String field, Document document, Analyzer analyzer, String text)`
`protected Collection<String>` `SearchTravRetVectorHighlightTask.getFieldsToHighlight(Document document)`
`protected Collection<String>` `SearchTravRetHighlightTask.getFieldsToHighlight(Document document)`
`protected Collection<String>` `ReadTask.getFieldsToHighlight(Document document)` Define the fields to highlight.

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` `MultiReader.document(int n, FieldSelector fieldSelector)`
`Document` `FilterIndexReader.document(int n, FieldSelector fieldSelector)`
`Document` `ParallelReader.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
`long` `NRTManager.addDocument(Document d)`
`void` `IndexWriter.addDocument(Document doc)` Adds a document to this index.
`long` `NRTManager.addDocument(Document d, Analyzer a)`
`void` `IndexWriter.addDocument(Document doc, Analyzer analyzer)` Adds a document to this index, using the provided analyzer instead of the value of `IndexWriter.getAnalyzer()`.
`long` `NRTManager.updateDocument(Term t, Document d)`
`void` `IndexWriter.updateDocument(Term term, Document doc)` Updates a document by first deleting the document(s) containing `term` and then adding the new document.
`long` `NRTManager.updateDocument(Term t, Document d, Analyzer a)`
`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.

Method parameters in org.apache.lucene.index with type arguments of type Document
`long` `NRTManager.addDocuments(Collection<Document> docs)`
`void` `IndexWriter.addDocuments(Collection<Document> docs)` Atomically adds a block of documents with sequentially assigned document IDs, such that an external reader will see all or none of the documents.
`long` `NRTManager.addDocuments(Collection<Document> docs, Analyzer a)`
`void` `IndexWriter.addDocuments(Collection<Document> docs, Analyzer analyzer)` Atomically adds a block of documents, analyzed using the provided analyzer, with sequentially assigned document IDs, such that an external reader will see all or none of the documents.
`long` `NRTManager.updateDocuments(Term t, Collection<Document> docs)`
`void` `IndexWriter.updateDocuments(Term delTerm, Collection<Document> docs)` Atomically deletes documents matching the provided delTerm and adds a block of documents with sequentially assigned document IDs, such that an external reader will see all or none of the documents.
`long` `NRTManager.updateDocuments(Term t, Collection<Document> docs, Analyzer a)`
`void` `IndexWriter.updateDocuments(Term delTerm, Collection<Document> docs, Analyzer analyzer)` Atomically deletes documents matching the provided delTerm and adds a block of documents, analyzed using the provided analyzer, with sequentially assigned document IDs, such that an external reader will see all or none of the documents.

Uses of Document in org.apache.lucene.search

Methods in org.apache.lucene.search that return Document
`Document` `RemoteSearchable.doc(int i)` Deprecated.
`Document` `MultiSearcher.doc(int n)` Deprecated.
`Document` `Searchable.doc(int i)` Deprecated. Returns the stored fields of document `i`.
`Document` `IndexSearcher.doc(int docID)`
`abstract Document` `Searcher.doc(int i)` Deprecated.
`Document` `RemoteSearchable.doc(int i, FieldSelector fieldSelector)` Deprecated.
`Document` `MultiSearcher.doc(int n, FieldSelector fieldSelector)` Deprecated.
`Document` `Searchable.doc(int n, FieldSelector fieldSelector)` Deprecated. Get the `Document` at the `n`th position.
`Document` `IndexSearcher.doc(int docID, FieldSelector fieldSelector)`
`abstract Document` `Searcher.doc(int docid, FieldSelector fieldSelector)` Deprecated.

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, 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, 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.