Uses of Class org.apache.lucene.document.Document (Lucene 3.6.2 API)

Packages that use Document
Package	Description
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.facet.index	Indexing of document categories
org.apache.lucene.index	Code to maintain and access indices.
org.apache.lucene.index.pruning	Static Index Pruning Tools
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.
org.apache.lucene.util	Some utility classes.

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

Methods in org.apache.lucene.benchmark.byTask.feeds that return Document
Modifier and Type	Method	Description
`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

Fields in org.apache.lucene.benchmark.byTask.tasks declared as Document
Modifier and Type	Field	Description
`protected Document`	AddDocTask.`doc`	volatile data passed between setup(), doLogic(), tearDown().

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

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

Uses of Document in org.apache.lucene.facet.index

Methods in org.apache.lucene.facet.index that return Document
Modifier and Type	Method	Description
`Document`	CategoryDocumentBuilder.`build(Document doc)`	Adds the fields created in one of the "set" methods to the document

Methods in org.apache.lucene.facet.index with parameters of type Document
Modifier and Type	Method	Description
`Document`	CategoryDocumentBuilder.`build(Document doc)`	Adds the fields created in one of the "set" methods to the document

Uses of Document in org.apache.lucene.index

Methods in org.apache.lucene.index that return Document
Modifier and Type	Method	Description
`Document`	FilterIndexReader.`document(int n, FieldSelector fieldSelector)`
`Document`	IndexReader.`document(int n)`	Returns the stored fields of the `n`^th `Document` in this index.
`abstract Document`	IndexReader.`document(int n, FieldSelector fieldSelector)`	Get the `Document` at the `n` ^th position.
`Document`	MultiReader.`document(int n, FieldSelector fieldSelector)`
`Document`	ParallelReader.`document(int n, FieldSelector fieldSelector)`
`Document`	PruningReader.`document(int n, FieldSelector fieldSelector)`	Applies a `StorePruningPolicy` to stored fields of a document.
`Document`	SegmentReader.`document(int n, FieldSelector fieldSelector)`

Methods in org.apache.lucene.index with parameters of type Document
Modifier and Type	Method	Description
`void`	FieldInfos.`add(Document doc)`	Adds field info for a Document.
`void`	IndexWriter.`addDocument(Document doc)`	Adds a document to this index.
`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`	RandomIndexWriter.`addDocument(Document doc)`	Adds a Document.
`protected void`	ThreadedIndexingAndSearchingTestCase.`addDocument(Term id, Document doc)`
`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.
`void`	RandomIndexWriter.`updateDocument(Term t, Document doc)`	Updates a document.
`protected void`	ThreadedIndexingAndSearchingTestCase.`updateDocument(Term term, Document doc)`

Method parameters in org.apache.lucene.index with type arguments of type Document
Modifier and Type	Method	Description
`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.
`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.
`void`	RandomIndexWriter.`addDocuments(Collection<Document> docs)`
`protected void`	ThreadedIndexingAndSearchingTestCase.`addDocuments(Term id, 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.
`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.
`void`	RandomIndexWriter.`updateDocuments(Term delTerm, Collection<Document> docs)`
`protected void`	ThreadedIndexingAndSearchingTestCase.`updateDocuments(Term id, Collection<Document> docs)`

Uses of Document in org.apache.lucene.index.pruning

Methods in org.apache.lucene.index.pruning that return Document
Modifier and Type	Method	Description
`Document`	StorePruningPolicy.`pruneDocument(int doc, FieldSelector parent)`	Prune stored fields of a document.

Uses of Document in org.apache.lucene.search

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

Methods in org.apache.lucene.search with parameters of type Document
Modifier and Type	Method	Description
`long`	NRTManager.TrackingIndexWriter.`addDocument(Document d)`
`long`	NRTManager.TrackingIndexWriter.`addDocument(Document d, Analyzer a)`
`long`	NRTManager.TrackingIndexWriter.`updateDocument(Term t, Document d)`
`long`	NRTManager.TrackingIndexWriter.`updateDocument(Term t, Document d, Analyzer a)`

Method parameters in org.apache.lucene.search with type arguments of type Document
Modifier and Type	Method	Description
`long`	NRTManager.TrackingIndexWriter.`addDocuments(Collection<Document> docs)`
`long`	NRTManager.TrackingIndexWriter.`addDocuments(Collection<Document> docs, Analyzer a)`
`long`	NRTManager.TrackingIndexWriter.`updateDocuments(Term t, Collection<Document> docs)`
`long`	NRTManager.TrackingIndexWriter.`updateDocuments(Term t, Collection<Document> docs, Analyzer a)`

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

Methods in org.apache.lucene.search.highlight with parameters of type Document
Modifier and Type	Method	Description
`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
Modifier and Type	Method	Description
`Document`	InstantiatedIndexReader.`document(int n, FieldSelector fieldSelector)`	Deprecated. Return the `Document` at the `n`^th position.
`Document`	InstantiatedDocument.`getDocument()`

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

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

Uses of Document in org.apache.lucene.util

Methods in org.apache.lucene.util that return Document
Modifier and Type	Method	Description
`static Document`	_TestUtil.`cloneDocument(Document doc1)`
`Document`	LineFileDocs.`nextDoc()`	Note: Document instance is re-used per-thread

Methods in org.apache.lucene.util with parameters of type Document
Modifier and Type	Method	Description
`static Document`	_TestUtil.`cloneDocument(Document doc1)`