public class FieldInfos extends java.lang.Object implements java.lang.Iterable<FieldInfo>
FieldInfo
s (accessible by number or by name).Modifier and Type | Class and Description |
---|---|
(package private) static class |
FieldInfos.Builder |
(package private) static class |
FieldInfos.FieldDimensions |
(package private) static class |
FieldInfos.FieldNumbers |
Modifier and Type | Field and Description |
---|---|
private java.util.HashMap<java.lang.String,FieldInfo> |
byName |
private FieldInfo[] |
byNumber |
static FieldInfos |
EMPTY
An instance without any fields.
|
private boolean |
hasDocValues |
private boolean |
hasFreq |
private boolean |
hasNorms |
private boolean |
hasOffsets |
private boolean |
hasPayloads |
private boolean |
hasPointValues |
private boolean |
hasProx |
private boolean |
hasVectors |
private java.lang.String |
softDeletesField |
private java.util.Collection<FieldInfo> |
values |
Constructor and Description |
---|
FieldInfos(FieldInfo[] infos)
Constructs a new FieldInfos from an array of FieldInfo objects
|
Modifier and Type | Method and Description |
---|---|
FieldInfo |
fieldInfo(int fieldNumber)
Return the fieldinfo object referenced by the fieldNumber.
|
FieldInfo |
fieldInfo(java.lang.String fieldName)
Return the fieldinfo object referenced by the field name
|
static java.util.Collection<java.lang.String> |
getIndexedFields(IndexReader reader)
Returns a set of names of fields that have a terms index.
|
static FieldInfos |
getMergedFieldInfos(IndexReader reader)
Call this to get the (merged) FieldInfos for a
composite reader.
|
java.lang.String |
getSoftDeletesField()
Returns the soft-deletes field name if exists; otherwise returns null
|
boolean |
hasDocValues()
Returns true if any fields have DocValues
|
boolean |
hasFreq()
Returns true if any fields have freqs
|
boolean |
hasNorms()
Returns true if any fields have norms
|
boolean |
hasOffsets()
Returns true if any fields have offsets
|
boolean |
hasPayloads()
Returns true if any fields have payloads
|
boolean |
hasPointValues()
Returns true if any fields have PointValues
|
boolean |
hasProx()
Returns true if any fields have positions
|
boolean |
hasVectors()
Returns true if any fields have vectors
|
java.util.Iterator<FieldInfo> |
iterator()
Returns an iterator over all the fieldinfo objects present,
ordered by ascending field number
|
int |
size()
Returns the number of fields
|
public static final FieldInfos EMPTY
private final boolean hasFreq
private final boolean hasProx
private final boolean hasPayloads
private final boolean hasOffsets
private final boolean hasVectors
private final boolean hasNorms
private final boolean hasDocValues
private final boolean hasPointValues
private final java.lang.String softDeletesField
private final FieldInfo[] byNumber
private final java.util.HashMap<java.lang.String,FieldInfo> byName
private final java.util.Collection<FieldInfo> values
public FieldInfos(FieldInfo[] infos)
public static FieldInfos getMergedFieldInfos(IndexReader 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.
public static java.util.Collection<java.lang.String> getIndexedFields(IndexReader reader)
public boolean hasFreq()
public boolean hasProx()
public boolean hasPayloads()
public boolean hasOffsets()
public boolean hasVectors()
public boolean hasNorms()
public boolean hasDocValues()
public boolean hasPointValues()
public java.lang.String getSoftDeletesField()
public int size()
public java.util.Iterator<FieldInfo> iterator()
iterator
in interface java.lang.Iterable<FieldInfo>
public FieldInfo fieldInfo(java.lang.String fieldName)
public FieldInfo fieldInfo(int fieldNumber)
fieldNumber
- field's number.java.lang.IllegalArgumentException
- if fieldNumber is negative