Uses of Class
org.apache.lucene.index.Fields

Packages that use Fields

Package	Description
org.apache.lucene.codecs	Codecs API: API for customization of the encoding and structure of the index.
org.apache.lucene.codecs.blockterms	Pluggable term index / block terms dictionary implementations.
org.apache.lucene.codecs.blocktree	BlockTree terms dictionary.
org.apache.lucene.codecs.blocktreeords	Same postings format as Lucene50, except the terms dictionary also supports ords, i.e.
org.apache.lucene.codecs.bloom	Codec PostingsFormat for fast access to low-frequency terms such as primary key fields.
org.apache.lucene.codecs.compressing	StoredFieldsFormat that allows cross-document and cross-field compression of stored fields.
org.apache.lucene.codecs.idversion	A primary-key postings format that associates a version (long) with each term and can provide fail-fast lookups by ID and version.
org.apache.lucene.codecs.memory	Term dictionary, DocValues or Postings formats that are read entirely into memory.
org.apache.lucene.codecs.perfield	Postings format that can delegate to different formats per-field.
org.apache.lucene.codecs.simpletext	Simpletext Codec: writes human readable postings.
org.apache.lucene.codecs.uniformsplit	Pluggable term index / block terms dictionary implementations.
org.apache.lucene.codecs.uniformsplit.sharedterms	Pluggable term index / block terms dictionary implementations.
org.apache.lucene.index	Code to maintain and access indices.
org.apache.lucene.index.memory	High-performance single-document main memory Apache Lucene fulltext search index.
org.apache.lucene.search.highlight	Highlighting search terms.
org.apache.lucene.search.suggest.document	Support for document suggestion
org.apache.lucene.search.uhighlight	The UnifiedHighlighter -- a flexible highlighter that can get offsets from postings, term vectors, or analysis.

Uses of Fields in org.apache.lucene.codecs

Subclasses of Fields in org.apache.lucene.codecs

Modifier and Type	Class	Description
class	FieldsProducer	Abstract API that produces terms, doc, freq, prox, offset and payloads postings.

Methods in org.apache.lucene.codecs that return Fields

Modifier and Type	Method	Description
abstract Fields	TermVectorsReader.get(int doc)	Returns term vectors for this document, or null if term vectors were not indexed.

Methods in org.apache.lucene.codecs with parameters of type Fields

Modifier and Type	Method	Description
protected final void	TermVectorsWriter.addAllDocVectors(Fields vectors, MergeState mergeState)	Safe (but, slowish) default method to write every vector field in the document.
abstract void	FieldsConsumer.write(Fields fields, NormsProducer norms)	Write all fields, terms and postings.

Uses of Fields in org.apache.lucene.codecs.blockterms

Subclasses of Fields in org.apache.lucene.codecs.blockterms

Modifier and Type	Class	Description
class	BlockTermsReader	Handles a terms dict, but decouples all details of doc/freqs/positions reading to an instance of PostingsReaderBase.

Methods in org.apache.lucene.codecs.blockterms with parameters of type Fields

Modifier and Type	Method	Description
void	BlockTermsWriter.write(Fields fields, NormsProducer norms)

Uses of Fields in org.apache.lucene.codecs.blocktree

Subclasses of Fields in org.apache.lucene.codecs.blocktree

Modifier and Type	Class	Description
final class	BlockTreeTermsReader	A block-based terms index and dictionary that assigns terms to variable length blocks according to how they share prefixes.

Methods in org.apache.lucene.codecs.blocktree with parameters of type Fields

Modifier and Type	Method	Description
void	BlockTreeTermsWriter.write(Fields fields, NormsProducer norms)

Uses of Fields in org.apache.lucene.codecs.blocktreeords

Subclasses of Fields in org.apache.lucene.codecs.blocktreeords

Modifier and Type	Class	Description
final class	OrdsBlockTreeTermsReader	See OrdsBlockTreeTermsWriter.

Methods in org.apache.lucene.codecs.blocktreeords with parameters of type Fields

Modifier and Type	Method	Description
void	OrdsBlockTreeTermsWriter.write(Fields fields, NormsProducer norms)

Uses of Fields in org.apache.lucene.codecs.bloom

Subclasses of Fields in org.apache.lucene.codecs.bloom

Modifier and Type	Class	Description
(package private) static class	BloomFilteringPostingsFormat.BloomFilteredFieldsProducer

Methods in org.apache.lucene.codecs.bloom with parameters of type Fields

Modifier and Type	Method	Description
void	BloomFilteringPostingsFormat.BloomFilteredFieldsConsumer.write(Fields fields, NormsProducer norms)

Uses of Fields in org.apache.lucene.codecs.compressing

Subclasses of Fields in org.apache.lucene.codecs.compressing

Modifier and Type	Class	Description
private class	CompressingTermVectorsReader.TVFields

Methods in org.apache.lucene.codecs.compressing that return Fields

Modifier and Type	Method	Description
Fields	CompressingTermVectorsReader.get(int doc)

Uses of Fields in org.apache.lucene.codecs.idversion

Subclasses of Fields in org.apache.lucene.codecs.idversion

Modifier and Type	Class	Description
final class	VersionBlockTreeTermsReader	See VersionBlockTreeTermsWriter.

Methods in org.apache.lucene.codecs.idversion with parameters of type Fields

Modifier and Type	Method	Description
void	VersionBlockTreeTermsWriter.write(Fields fields, NormsProducer norms)

Uses of Fields in org.apache.lucene.codecs.memory

Subclasses of Fields in org.apache.lucene.codecs.memory

Modifier and Type	Class	Description
private static final class	DirectPostingsFormat.DirectFields
class	FSTTermsReader	FST-based terms dictionary reader.

Methods in org.apache.lucene.codecs.memory with parameters of type Fields

Modifier and Type	Method	Description
void	FSTTermsWriter.write(Fields fields, NormsProducer norms)

Constructors in org.apache.lucene.codecs.memory with parameters of type Fields

Modifier	Constructor	Description
	DirectFields(SegmentReadState state, Fields fields, int minSkipCount, int lowFreqCutoff)

Uses of Fields in org.apache.lucene.codecs.perfield

Subclasses of Fields in org.apache.lucene.codecs.perfield

Modifier and Type	Class	Description
private static class	PerFieldMergeState.FilterFieldsProducer
private static class	PerFieldPostingsFormat.FieldsReader

Methods in org.apache.lucene.codecs.perfield with parameters of type Fields

Modifier and Type	Method	Description
void	PerFieldPostingsFormat.FieldsWriter.write(Fields fields, NormsProducer norms)

Uses of Fields in org.apache.lucene.codecs.simpletext

Subclasses of Fields in org.apache.lucene.codecs.simpletext

Modifier and Type	Class	Description
(package private) class	SimpleTextFieldsReader
private static class	SimpleTextTermVectorsReader.SimpleTVFields

Methods in org.apache.lucene.codecs.simpletext that return Fields

Modifier and Type	Method	Description
Fields	SimpleTextTermVectorsReader.get(int doc)

Methods in org.apache.lucene.codecs.simpletext with parameters of type Fields

Modifier and Type	Method	Description
void	SimpleTextFieldsWriter.write(FieldInfos fieldInfos, Fields fields)
void	SimpleTextFieldsWriter.write(Fields fields, NormsProducer norms)

Uses of Fields in org.apache.lucene.codecs.uniformsplit

Subclasses of Fields in org.apache.lucene.codecs.uniformsplit

Modifier and Type	Class	Description
class	UniformSplitTermsReader	A block-based terms index and dictionary based on the Uniform Split technique.

Methods in org.apache.lucene.codecs.uniformsplit with parameters of type Fields

Modifier and Type	Method	Description
void	UniformSplitTermsWriter.write(Fields fields, NormsProducer normsProducer)

Uses of Fields in org.apache.lucene.codecs.uniformsplit.sharedterms

Subclasses of Fields in org.apache.lucene.codecs.uniformsplit.sharedterms

Modifier and Type	Class	Description
class	STUniformSplitTermsReader	A block-based terms index and dictionary based on the Uniform Split technique, and sharing all the fields terms in the same dictionary, with all the fields of a term in the same block line.

Methods in org.apache.lucene.codecs.uniformsplit.sharedterms with parameters of type Fields

Modifier and Type	Method	Description
private STUniformSplitTermsWriter.TermIteratorQueue<STUniformSplitTermsWriter.FieldTerms>	STUniformSplitTermsWriter.createFieldTermsQueue(Fields fields, List<FieldMetadata> fieldMetadataList)
void	STUniformSplitTermsWriter.write(Fields fields, NormsProducer normsProducer)
private Collection<FieldMetadata>	STUniformSplitTermsWriter.writeSingleSegment(Fields fields, NormsProducer normsProducer, STBlockWriter blockWriter, IndexDictionary.Builder dictionaryBuilder)

Constructors in org.apache.lucene.codecs.uniformsplit.sharedterms with parameters of type Fields

Modifier	Constructor	Description
(package private)	FieldsIterator(Fields fields, FieldInfos fieldInfos)

Uses of Fields in org.apache.lucene.index

Subclasses of Fields in org.apache.lucene.index

Modifier and Type	Class	Description
static class	FilterLeafReader.FilterFields	Base class for filtering Fields implementations.
(package private) class	FreqProxFields	Implements limited (iterators only, no stats) Fields interface over the in-RAM buffered fields/terms/postings, to flush postings through the PostingsFormat.
class	MappedMultiFields	A Fields implementation that merges multiple Fields into one, and maps around deleted documents.
final class	MultiFields	Provides a single Fields term index view over an IndexReader.
private static final class	ParallelLeafReader.ParallelFields

Fields in org.apache.lucene.index declared as Fields

Modifier and Type	Field	Description
static final Fields[]	Fields.EMPTY_ARRAY	Zero-length Fields array.
protected final Fields	FilterLeafReader.FilterFields.in	The underlying Fields instance.
private final Fields[]	MultiFields.subs

Methods in org.apache.lucene.index that return Fields

Modifier and Type	Method	Description
final Fields	BaseCompositeReader.getTermVectors(int docID)
final Fields	CodecReader.getTermVectors(int docID)
final Fields	DocValuesLeafReader.getTermVectors(int docID)
Fields	FilterLeafReader.getTermVectors(int docID)
abstract Fields	IndexReader.getTermVectors(int docID)	Retrieve term vectors for this document, or null if term vectors were not indexed.
Fields	MergeReaderWrapper.getTermVectors(int docID)
Fields	ParallelLeafReader.getTermVectors(int docID)

Methods in org.apache.lucene.index with parameters of type Fields

Modifier and Type	Method	Description
private void	FreqProxTermsWriter.applyDeletes(SegmentWriteState state, Fields fields)
private static CheckIndex.Status.TermIndexStatus	CheckIndex.checkFields(Fields fields, Bits liveDocs, int maxDoc, FieldInfos fieldInfos, NormsProducer normsProducer, boolean doPrint, boolean isVectors, PrintStream infoStream, boolean verbose, boolean doSlowChecks)	checks Fields api is consistent with itself.
private static void	SortingTermVectorsConsumer.writeTermVectors(TermVectorsWriter writer, Fields vectors, FieldInfos fieldInfos)	Safe (but, slowish) default method to copy every vector field in the provided TermVectorsWriter.

Constructors in org.apache.lucene.index with parameters of type Fields

Modifier	Constructor	Description
	FilterFields(Fields in)	Creates a new FilterFields.
	MultiFields(Fields[] subs, ReaderSlice[] subSlices)	Sole constructor.
(package private)	TermDocsIterator(Fields fields, boolean sortedTerms)

Uses of Fields in org.apache.lucene.index.memory

Subclasses of Fields in org.apache.lucene.index.memory

Modifier and Type	Class	Description
private class	MemoryIndex.MemoryIndexReader.MemoryFields

Methods in org.apache.lucene.index.memory that return Fields

Modifier and Type	Method	Description
Fields	MemoryIndex.MemoryIndexReader.getTermVectors(int docID)

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

Fields in org.apache.lucene.search.highlight declared as Fields

Modifier and Type	Field	Description
private final Fields	TermVectorLeafReader.fields

Methods in org.apache.lucene.search.highlight that return Fields

Modifier and Type	Method	Description
Fields	TermVectorLeafReader.getTermVectors(int docID)

Methods in org.apache.lucene.search.highlight with parameters of type Fields

Modifier and Type	Method	Description
static TokenStream	TokenSources.getTermVectorTokenStreamOrNull(String field, Fields tvFields, int maxStartOffset)	Get a token stream by un-inverting the term vector.
static TokenStream	TokenSources.getTokenStream(String field, Fields tvFields, String text, Analyzer analyzer, int maxStartOffset)	Get a token stream from either un-inverting a term vector if possible, or by analyzing the text.

Uses of Fields in org.apache.lucene.search.suggest.document

Subclasses of Fields in org.apache.lucene.search.suggest.document

Modifier and Type	Class	Description
(package private) final class	CompletionFieldsProducer	Completion index (.cmp) is opened and read at instantiation to read in SuggestField numbers and their FST offsets in the Completion dictionary (.lkp).

Methods in org.apache.lucene.search.suggest.document with parameters of type Fields

Modifier and Type	Method	Description
void	CompletionFieldsConsumer.write(Fields fields, NormsProducer norms)

Uses of Fields in org.apache.lucene.search.uhighlight

Fields in org.apache.lucene.search.uhighlight declared as Fields

Modifier and Type	Field	Description
private Fields	UnifiedHighlighter.TermVectorReusingLeafReader.tvFields

Methods in org.apache.lucene.search.uhighlight that return Fields

Modifier and Type	Method	Description
Fields	UnifiedHighlighter.TermVectorReusingLeafReader.getTermVectors(int docID)