Package org.apache.lucene.index
Class FieldInfos
java.lang.Object
org.apache.lucene.index.FieldInfos
Collection of
FieldInfos (accessible by number or by name).- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionFieldInfos(FieldInfo[] infos) Constructs a new FieldInfos from an array of FieldInfo objects. -
Method Summary
Modifier and TypeMethodDescriptionfieldInfo(int fieldNumber) Return the fieldinfo object referenced by the fieldNumber.Return the fieldinfo object referenced by the field namestatic Collection<String> getIndexedFields(IndexReader reader) Returns a set of names of fields that have a terms index.static FieldInfosgetMergedFieldInfos(IndexReader reader) Call this to get the (merged) FieldInfos for a composite reader.Returns the parent document field name if exists; otherwise returns nullReturns the soft-deletes field name if exists; otherwise returns nullbooleanReturns true if any fields have DocValuesbooleanhasFreq()Returns true if any fields have freqsbooleanhasNorms()Returns true if any fields have normsbooleanReturns true if any fields have offsetsbooleanReturns true if any fields have payloadsbooleanReturns true if any fields have PointValuesbooleanReturns true if any fields have postingsbooleanhasProx()Returns true if any fields have positionsbooleanReturns true if any fields have term vectorsbooleanReturns true if any fields have vector valuesiterator()Returns an iterator over all the fieldinfo objects present, ordered by ascending field numberintsize()Returns the number of fieldsMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface java.lang.Iterable
forEach, spliterator
-
Field Details
-
EMPTY
An instance without any fields.
-
-
Constructor Details
-
FieldInfos
Constructs a new FieldInfos from an array of FieldInfo objects. The array can be used directly as the backing structure.
-
-
Method Details
-
getMergedFieldInfos
Call this to get the (merged) FieldInfos for a composite reader.NOTE: the returned field numbers will likely not correspond to the actual field numbers in the underlying readers, and codec metadata (
FieldInfo.getAttribute(String)will be unavailable. -
getIndexedFields
Returns a set of names of fields that have a terms index. The order is undefined. -
hasFreq
public boolean hasFreq()Returns true if any fields have freqs -
hasPostings
public boolean hasPostings()Returns true if any fields have postings -
hasProx
public boolean hasProx()Returns true if any fields have positions -
hasPayloads
public boolean hasPayloads()Returns true if any fields have payloads -
hasOffsets
public boolean hasOffsets()Returns true if any fields have offsets -
hasTermVectors
public boolean hasTermVectors()Returns true if any fields have term vectors -
hasNorms
public boolean hasNorms()Returns true if any fields have norms -
hasDocValues
public boolean hasDocValues()Returns true if any fields have DocValues -
hasPointValues
public boolean hasPointValues()Returns true if any fields have PointValues -
hasVectorValues
public boolean hasVectorValues()Returns true if any fields have vector values -
getSoftDeletesField
Returns the soft-deletes field name if exists; otherwise returns null -
getParentField
Returns the parent document field name if exists; otherwise returns null -
size
public int size()Returns the number of fields -
iterator
Returns an iterator over all the fieldinfo objects present, ordered by ascending field number -
fieldInfo
Return the fieldinfo object referenced by the field name- Returns:
- the FieldInfo object or null when the given fieldName doesn't exist.
-
fieldInfo
Return the fieldinfo object referenced by the fieldNumber.- Parameters:
fieldNumber- field's number.- Returns:
- the FieldInfo object or null when the given fieldNumber doesn't exist.
- Throws:
IllegalArgumentException- if fieldNumber is negative
-