Uses of Class
org.apache.lucene.document.Document
Packages that use Document
Package
Description
Uses already seen data (the indexed documents) to classify new documents.
Utilities for evaluation, data preparation, etc.
The logical representation of a
Document
for indexing and
searching.Faceted search.
Taxonomy index implementation using on top of a Directory.
Code to maintain and access indices.
Misc extensions of the Document/Field API.
Monitoring framework
Highlighting search terms.
Suggest alternate spellings for words.
Support for Autocomplete/Autosuggest
Analyzer based autosuggest.
-
Uses of Document in org.apache.lucene.classification.document
Methods in org.apache.lucene.classification.document with parameters of type DocumentModifier and TypeMethodDescriptionprivate void
SimpleNaiveBayesDocumentClassifier.analyzeSeedDocument
(Document inputDocument, Map<String, List<String[]>> fieldName2tokensArray, Map<String, Float> fieldName2boost) This methods performs the analysis for the seed document and extract the boosts if present.DocumentClassifier.assignClass
(Document document) Assign a class (with score) to the givenDocument
KNearestNeighborDocumentClassifier.assignClass
(Document document) SimpleNaiveBayesDocumentClassifier.assignClass
(Document document) private List
<ClassificationResult<BytesRef>> SimpleNaiveBayesDocumentClassifier.assignNormClasses
(Document inputDocument) DocumentClassifier.getClasses
(Document document) Get all the classes (sorted by score, descending) assigned to the givenDocument
.DocumentClassifier.getClasses
(Document document, int max) Get the firstmax
classes (sorted by score, descending) assigned to the given text String.KNearestNeighborDocumentClassifier.getClasses
(Document document) KNearestNeighborDocumentClassifier.getClasses
(Document document, int max) SimpleNaiveBayesDocumentClassifier.getClasses
(Document document) SimpleNaiveBayesDocumentClassifier.getClasses
(Document document, int max) private TopDocs
Returns the top k results from a More Like This query based on the input document -
Uses of Document in org.apache.lucene.classification.utils
Methods in org.apache.lucene.classification.utils that return DocumentModifier and TypeMethodDescriptionprivate Document
DatasetSplitter.createNewDoc
(StoredFields originalFields, FieldType ft, ScoreDoc scoreDoc, String[] fieldNames) -
Uses of Document in org.apache.lucene.document
Fields in org.apache.lucene.document declared as DocumentMethods in org.apache.lucene.document that return DocumentModifier and TypeMethodDescriptionDocumentStoredFieldVisitor.getDocument()
Retrieve the visited document. -
Uses of Document in org.apache.lucene.facet
Methods in org.apache.lucene.facet that return DocumentModifier and TypeMethodDescriptionTranslates any addedFacetField
s into normal fields for indexing; only use this version if you did not add any taxonomy-based fields (FacetField
orAssociationFacetField
).FacetsConfig.build
(TaxonomyWriter taxoWriter, Document doc) Translates any addedFacetField
s into normal fields for indexing.Methods in org.apache.lucene.facet with parameters of type DocumentModifier and TypeMethodDescriptionTranslates any addedFacetField
s into normal fields for indexing; only use this version if you did not add any taxonomy-based fields (FacetField
orAssociationFacetField
).FacetsConfig.build
(TaxonomyWriter taxoWriter, Document doc) Translates any addedFacetField
s into normal fields for indexing.private void
FacetsConfig.indexDrillDownTerms
(Document doc, String indexFieldName, FacetsConfig.DimConfig dimConfig, FacetLabel facetLabel) private void
FacetsConfig.processAssocFacetFields
(TaxonomyWriter taxoWriter, Map<String, List<AssociationFacetField>> byField, Document doc) private void
FacetsConfig.processFacetFields
(TaxonomyWriter taxoWriter, Map<String, List<FacetField>> byField, Document doc) private void
FacetsConfig.processSSDVFacetFields
(Map<String, List<SortedSetDocValuesFacetField>> byField, Document doc) -
Uses of Document in org.apache.lucene.facet.taxonomy.directory
Fields in org.apache.lucene.facet.taxonomy.directory with type parameters of type DocumentModifier and TypeFieldDescriptionprivate BiConsumer
<FacetLabel, Document> ReindexingEnrichedDirectoryTaxonomyWriter.ordinalDataAppender
Methods in org.apache.lucene.facet.taxonomy.directory with parameters of type DocumentModifier and TypeMethodDescriptionprotected void
DirectoryTaxonomyWriter.enrichOrdinalDocument
(Document d, FacetLabel categoryPath) Child classes can implement this method to modify the document corresponding to a category path before indexing it.protected void
ReindexingEnrichedDirectoryTaxonomyWriter.enrichOrdinalDocument
(Document d, FacetLabel categoryPath) Add fields specified by theReindexingEnrichedDirectoryTaxonomyWriter.ordinalDataAppender
to the providedDocument
.Method parameters in org.apache.lucene.facet.taxonomy.directory with type arguments of type DocumentModifier and TypeMethodDescriptionvoid
ReindexingEnrichedDirectoryTaxonomyWriter.reindexWithNewOrdinalData
(BiConsumer<FacetLabel, Document> ordinalDataAppender) Delete the existing taxonomy index and recreate it using new ordinal data.Constructor parameters in org.apache.lucene.facet.taxonomy.directory with type arguments of type DocumentModifierConstructorDescriptionReindexingEnrichedDirectoryTaxonomyWriter
(Directory d, BiConsumer<FacetLabel, Document> ordinalDataAppender) Create a taxonomy writer that will allow editing the ordinal docs before indexing them. -
Uses of Document in org.apache.lucene.index
Methods in org.apache.lucene.index that return Document -
Uses of Document in org.apache.lucene.misc.document
Fields in org.apache.lucene.misc.document declared as DocumentMethods in org.apache.lucene.misc.document that return DocumentModifier and TypeMethodDescription(package private) Document
LazyDocument.getDocument()
non-private for test only access -
Uses of Document in org.apache.lucene.monitor
Fields in org.apache.lucene.monitor declared as DocumentModifier and TypeFieldDescriptionprivate final Document
WritableQueryIndex.Indexable.document
The field for thedocument
record component.Methods in org.apache.lucene.monitor that return DocumentModifier and TypeMethodDescriptionMultipassTermFilteredPresearcher.buildQueryDocument
(QueryTree querytree) protected Document
TermFilteredPresearcher.buildQueryDocument
(QueryTree querytree) Builds aDocument
from the terms extracted from a queryWritableQueryIndex.Indexable.document()
Returns the value of thedocument
record component.abstract Document
Presearcher.indexQuery
(Query query, Map<String, String> metadata) Build a lucene Document to index the query in a Monitor's queryindexfinal Document
TermFilteredPresearcher.indexQuery
(Query query, Map<String, String> metadata) Methods in org.apache.lucene.monitor with parameters of type DocumentModifier and TypeMethodDescriptionprivate LeafReader
DocumentBatch.MultiDocumentBatch.build
(IndexWriter writer, Document... docs) <T extends QueryMatch>
PresearcherMatches<T> Monitor.debug
(Document[] docs, MatcherFactory<T> factory) Match a DocumentBatch against the queries stored in the Monitor, also returning information about which queries were selected by the presearcher, and why.<T extends QueryMatch>
PresearcherMatches<T> Monitor.debug
(Document doc, MatcherFactory<T> factory) Match a singleDocument
against the queries stored in the Monitor, also returning information about which queries were selected by the presearcher, and why.<T extends QueryMatch>
MultiMatchingQueries<T> Monitor.match
(Document[] docs, MatcherFactory<T> factory) Match an array ofDocument
s against the queryindex, calling aCandidateMatcher
produced by the suppliedMatcherFactory
for each possible matching query.<T extends QueryMatch>
MatchingQueries<T> Monitor.match
(Document doc, MatcherFactory<T> factory) Match a singleDocument
against the queryindex, calling aCandidateMatcher
produced by the suppliedMatcherFactory
for each possible matching query.static DocumentBatch
Create a DocumentBatch containing a single InputDocumentstatic DocumentBatch
Create a DocumentBatch containing a set of InputDocumentsConstructors in org.apache.lucene.monitor with parameters of type DocumentModifierConstructorDescriptionprivate
Indexable
(QueryCacheEntry queryCacheEntry, Document document) Creates an instance of aIndexable
record class.(package private)
MultiDocumentBatch
(Analyzer analyzer, Document... docs) private
SingletonDocumentBatch
(Analyzer analyzer, Document doc) -
Uses of Document in org.apache.lucene.search.highlight
Methods in org.apache.lucene.search.highlight with parameters of type DocumentModifier and TypeMethodDescriptionstatic TokenStream
TokenSources.getAnyTokenStream
(IndexReader reader, int docId, String field, Document document, Analyzer analyzer) Deprecated.static TokenStream
TokenSources.getTokenStream
(Document doc, String field, Analyzer analyzer) Deprecated. -
Uses of Document in org.apache.lucene.search.spell
Methods in org.apache.lucene.search.spell that return DocumentModifier and TypeMethodDescriptionprivate static Document
SpellChecker.createDocument
(String text, int ng1, int ng2) Methods in org.apache.lucene.search.spell with parameters of type Document -
Uses of Document in org.apache.lucene.search.suggest
Methods in org.apache.lucene.search.suggest with parameters of type DocumentModifier and TypeMethodDescriptionprotected long
Returns the value of theweightField
for the current document.protected long
Returns the weight for the currentdocId
as computed by theweightsValueSource
-
Uses of Document in org.apache.lucene.search.suggest.analyzing
Methods in org.apache.lucene.search.suggest.analyzing that return Document