Uses of Interface
org.apache.lucene.index.IndexableField

Packages that use IndexableField

Package	Description
org.apache.lucene.analysis.icu	Analysis components based on ICU
org.apache.lucene.codecs	Codecs API: API for customization of the encoding and structure of the index.
org.apache.lucene.codecs.lucene90.compressing	Lucene 9.0 compressing format.
org.apache.lucene.codecs.simpletext	Simpletext Codec: writes human readable postings.
org.apache.lucene.collation	Unicode collation support.
org.apache.lucene.document	The logical representation of a Document for indexing and searching.
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.misc.document	Misc extensions of the Document/Field API.
org.apache.lucene.sandbox.document	This package contains several point types: BigIntegerPoint for 128-bit integers LatLonPoint for latitude/longitude geospatial points
org.apache.lucene.search.suggest	Support for Autocomplete/Autosuggest
org.apache.lucene.search.suggest.document	Support for document suggestion
org.apache.lucene.spatial3d	Lucene field & query support for the spatial geometry implemented in org.apache.lucene.spatial3d.geom.

Uses of IndexableField in org.apache.lucene.analysis.icu

Classes in org.apache.lucene.analysis.icu that implement IndexableField

Modifier and Type	Class	Description
class	ICUCollationDocValuesField	Indexes collation keys as a single-valued SortedDocValuesField.

Uses of IndexableField in org.apache.lucene.codecs

Classes in org.apache.lucene.codecs that implement IndexableField

Modifier and Type	Class	Description
protected class	StoredFieldsWriter.MergeVisitor	A visitor that adds every field it sees.

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

Modifier and Type	Method	Description
abstract void	StoredFieldsWriter.writeField(FieldInfo info, IndexableField field)	Writes a single stored field.

Uses of IndexableField in org.apache.lucene.codecs.lucene90.compressing

Methods in org.apache.lucene.codecs.lucene90.compressing with parameters of type IndexableField

Modifier and Type	Method	Description
void	Lucene90CompressingStoredFieldsWriter.writeField(FieldInfo info, IndexableField field)

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

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

Modifier and Type	Method	Description
void	SimpleTextStoredFieldsWriter.writeField(FieldInfo info, IndexableField field)

Uses of IndexableField in org.apache.lucene.collation

Classes in org.apache.lucene.collation that implement IndexableField

Modifier and Type	Class	Description
class	CollationDocValuesField	Indexes collation keys as a single-valued SortedDocValuesField.

Uses of IndexableField in org.apache.lucene.document

Classes in org.apache.lucene.document that implement IndexableField

Modifier and Type	Class	Description
class	BinaryDocValuesField	Field that stores a per-document BytesRef value.
class	BinaryPoint	An indexed binary field for fast range filters.
(package private) class	BinaryRangeDocValuesField
class	DoubleDocValuesField	Syntactic sugar for encoding doubles as NumericDocValues via Double.doubleToRawLongBits(double).
class	DoublePoint	An indexed double field for fast range filters.
class	DoubleRange	An indexed Double Range field.
class	DoubleRangeDocValuesField	DocValues field for DoubleRange.
class	FeatureField	Field that can be used to store static scoring factors into documents.
class	Field	Expert: directly create a field for a document.
class	FloatDocValuesField	Syntactic sugar for encoding floats as NumericDocValues via Float.floatToRawIntBits(float).
class	FloatPoint	An indexed float field for fast range filters.
class	FloatRange	An indexed Float Range field.
class	FloatRangeDocValuesField	DocValues field for FloatRange.
class	InetAddressPoint	An indexed 128-bit InetAddress field.
class	InetAddressRange	An indexed InetAddress Range Field
class	IntPoint	An indexed int field for fast range filters.
class	IntRange	An indexed Integer Range field.
class	IntRangeDocValuesField	DocValues field for IntRange.
class	KnnVectorField	A field that contains a single floating-point numeric vector (or none) for each document.
class	LatLonDocValuesField	An per-document location field.
class	LatLonPoint	An indexed location field.
class	LongPoint	An indexed long field for fast range filters.
class	LongRange	An indexed Long Range field.
class	LongRangeDocValuesField	DocValues field for LongRange.
class	NumericDocValuesField	Field that stores a per-document long value for scoring, sorting or value retrieval.
static class	ShapeField.Triangle	polygons are decomposed into tessellated triangles using Tessellator these triangles are encoded and inserted as separate indexed POINT fields
class	SortedDocValuesField	Field that stores a per-document BytesRef value, indexed for sorting.
class	SortedNumericDocValuesField	Field that stores a per-document long values for scoring, sorting or value retrieval.
class	SortedSetDocValuesField	Field that stores a set of per-document BytesRef values, indexed for faceting,grouping,joining.
class	StoredField	A field whose value is stored so that IndexSearcher.doc(int) and IndexReader.document() will return the field and its value.
class	StringField	A field that is indexed but not tokenized: the entire String value is indexed as a single token.
class	TextField	A field that is indexed and tokenized, without term vectors.
class	XYDocValuesField	An per-document location field.
class	XYPointField	An indexed XY position field.

Fields in org.apache.lucene.document with type parameters of type IndexableField

Modifier and Type	Field	Description
private java.util.List<IndexableField>	Document.fields

Methods in org.apache.lucene.document that return IndexableField

Modifier and Type	Method	Description
IndexableField	Document.getField(java.lang.String name)	Returns a field with the given name if any exist in this document, or null.
IndexableField[]	Document.getFields(java.lang.String name)	Returns an array of IndexableFields with the given name.

Methods in org.apache.lucene.document that return types with arguments of type IndexableField

Modifier and Type	Method	Description
java.util.List<IndexableField>	Document.getFields()	Returns a List of all the fields in a document.
java.util.Iterator<IndexableField>	Document.iterator()

Methods in org.apache.lucene.document with parameters of type IndexableField

Modifier and Type	Method	Description
void	Document.add(IndexableField field)	Adds a field to a document.

Uses of IndexableField in org.apache.lucene.index

Classes in org.apache.lucene.index that implement IndexableField

Modifier and Type	Class	Description
private static class	SortingStoredFieldsConsumer.CopyVisitor	A visitor that copies every field it sees in the provided StoredFieldsWriter.

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

Modifier and Type	Method	Description
private void	IndexingChain.indexDocValue(int docID, IndexingChain.PerField fp, DocValuesType dvType, IndexableField field)	Called from processDocument to index one field's doc value
void	IndexingChain.PerField.invert(int docID, IndexableField field, boolean first)	Inverts one field for one document; first is true if this is the first time we are seeing this field name in this document.
private boolean	IndexingChain.processField(int docID, IndexableField field, IndexingChain.PerField pf)	Index each field Returns true, if we are indexing a unique field with postings
(package private) boolean	FreqProxTermsWriterPerField.start(IndexableField f, boolean first)
(package private) boolean	TermsHashPerField.start(IndexableField field, boolean first)	Start adding a new field instance; first is true if this is the first time this field name was seen in the document.
(package private) boolean	TermVectorsConsumerPerField.start(IndexableField field, boolean first)
(package private) void	StoredFieldsConsumer.writeField(FieldInfo info, IndexableField field)

Method parameters in org.apache.lucene.index with type arguments of type IndexableField

Modifier and Type	Method	Description
long	IndexWriter.addDocument(java.lang.Iterable<? extends IndexableField> doc)	Adds a document to this index.
long	IndexWriter.addDocuments(java.lang.Iterable<? extends java.lang.Iterable<? extends IndexableField>> 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.
(package private) void	IndexingChain.processDocument(int docID, java.lang.Iterable<? extends IndexableField> document)
long	IndexWriter.softUpdateDocument(Term term, java.lang.Iterable<? extends IndexableField> doc, Field... softDeletes)	Expert: Updates a document by first updating the document(s) containing term with the given doc-values fields and then adding the new document.
long	IndexWriter.softUpdateDocuments(Term term, java.lang.Iterable<? extends java.lang.Iterable<? extends IndexableField>> docs, Field... softDeletes)	Expert: Atomically updates documents matching the provided term with the given doc-values fields 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	IndexWriter.updateDocument(Term term, java.lang.Iterable<? extends IndexableField> doc)	Updates a document by first deleting the document(s) containing term and then adding the new document.
(package private) long	DocumentsWriter.updateDocuments(java.lang.Iterable<? extends java.lang.Iterable<? extends IndexableField>> docs, DocumentsWriterDeleteQueue.Node<?> delNode)
(package private) long	DocumentsWriterPerThread.updateDocuments(java.lang.Iterable<? extends java.lang.Iterable<? extends IndexableField>> docs, DocumentsWriterDeleteQueue.Node<?> deleteNode, DocumentsWriter.FlushNotifications flushNotifications, java.lang.Runnable onNewDocOnRAM)
private long	IndexWriter.updateDocuments(DocumentsWriterDeleteQueue.Node<?> delNode, java.lang.Iterable<? extends java.lang.Iterable<? extends IndexableField>> docs)
long	IndexWriter.updateDocuments(Term delTerm, java.lang.Iterable<? extends java.lang.Iterable<? extends IndexableField>> 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.

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

Methods in org.apache.lucene.index.memory with parameters of type IndexableField

Modifier and Type	Method	Description
void	MemoryIndex.addField(IndexableField field, Analyzer analyzer)	Adds a lucene IndexableField to the MemoryIndex using the provided analyzer.

Method parameters in org.apache.lucene.index.memory with type arguments of type IndexableField

Modifier and Type	Method	Description
static MemoryIndex	MemoryIndex.fromDocument(java.lang.Iterable<? extends IndexableField> document, Analyzer analyzer)	Builds a MemoryIndex from a lucene Document using an analyzer
static MemoryIndex	MemoryIndex.fromDocument(java.lang.Iterable<? extends IndexableField> document, Analyzer analyzer, boolean storeOffsets, boolean storePayloads)	Builds a MemoryIndex from a lucene Document using an analyzer
static MemoryIndex	MemoryIndex.fromDocument(java.lang.Iterable<? extends IndexableField> document, Analyzer analyzer, boolean storeOffsets, boolean storePayloads, long maxReusedBytes)	Builds a MemoryIndex from a lucene Document using an analyzer

Uses of IndexableField in org.apache.lucene.misc.document

Classes in org.apache.lucene.misc.document that implement IndexableField

Modifier and Type	Class	Description
class	LazyDocument.LazyField	Lazy-loaded field

Fields in org.apache.lucene.misc.document declared as IndexableField

Modifier and Type	Field	Description
(package private) IndexableField	LazyDocument.LazyField.realValue

Methods in org.apache.lucene.misc.document that return IndexableField

Modifier and Type	Method	Description
IndexableField	LazyDocument.getField(FieldInfo fieldInfo)	Creates a StorableField whose value will be lazy loaded if and when it is used.
private IndexableField	LazyDocument.LazyField.getRealValue()

Uses of IndexableField in org.apache.lucene.sandbox.document

Classes in org.apache.lucene.sandbox.document that implement IndexableField

Modifier and Type	Class	Description
class	BigIntegerPoint	An indexed 128-bit BigInteger field.
class	HalfFloatPoint	An indexed half-float field for fast range filters.
class	LatLonBoundingBox	An indexed 2-Dimension Bounding Box field for the Geospatial Lat/Lon Coordinate system

Uses of IndexableField in org.apache.lucene.search.suggest

Fields in org.apache.lucene.search.suggest declared as IndexableField

Modifier and Type	Field	Description
(package private) IndexableField[]	DocumentDictionary.DocumentInputIterator.currentDocFields

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

Classes in org.apache.lucene.search.suggest.document that implement IndexableField

Modifier and Type	Class	Description
class	ContextSuggestField	SuggestField which additionally takes in a set of contexts.
class	SuggestField	Field that indexes a string value and a weight as a weighted completion against a named suggester.

Uses of IndexableField in org.apache.lucene.spatial3d

Classes in org.apache.lucene.spatial3d that implement IndexableField

Modifier and Type	Class	Description
class	Geo3DDocValuesField	An per-document 3D location field.
class	Geo3DPoint	Add this to a document to index lat/lon or x/y/z point, indexed as a 3D point.