public final class FieldInfos extends java.lang.Object implements java.lang.Iterable<FieldInfo>
FieldInfo
s (accessible by number or by name).Modifier and Type | Field and Description |
---|---|
static int |
FORMAT_OMIT_POSITIONS |
static int |
FORMAT_PRE |
static int |
FORMAT_START |
Constructor and Description |
---|
FieldInfos() |
FieldInfos(Directory d,
java.lang.String name)
Construct a FieldInfos object using the directory and the name of the file
IndexInput
|
Modifier and Type | Method and Description |
---|---|
void |
add(Document doc)
Adds field info for a Document.
|
FieldInfo |
add(FieldInfo fi) |
void |
add(FieldInfos other) |
void |
add(java.lang.String name,
boolean isIndexed)
Calls 5 parameter add with false for all TermVector parameters.
|
void |
add(java.lang.String name,
boolean isIndexed,
boolean storeTermVector)
Calls 5 parameter add with false for term vector positions and offsets.
|
void |
add(java.lang.String name,
boolean isIndexed,
boolean storeTermVector,
boolean omitNorms)
If the field is not yet known, adds it.
|
FieldInfo |
add(java.lang.String name,
boolean isIndexed,
boolean storeTermVector,
boolean omitNorms,
boolean storePayloads,
FieldInfo.IndexOptions indexOptions)
If the field is not yet known, adds it.
|
java.lang.Object |
clone()
Returns a deep clone of this FieldInfos instance.
|
FieldInfo |
fieldInfo(int fieldNumber)
Return the fieldinfo object referenced by the fieldNumber.
|
FieldInfo |
fieldInfo(java.lang.String fieldName) |
java.lang.String |
fieldName(int fieldNumber)
Return the fieldName identified by its number.
|
int |
fieldNumber(java.lang.String fieldName)
lookup the number of a field by name.
|
boolean |
hasProx()
Returns true if any fields do not omitTermFreqAndPositions
|
boolean |
hasVectors() |
java.util.Iterator<FieldInfo> |
iterator() |
int |
size() |
void |
write(Directory d,
java.lang.String name) |
void |
write(IndexOutput output) |
public static final int FORMAT_PRE
public static final int FORMAT_START
public static final int FORMAT_OMIT_POSITIONS
public FieldInfos()
public FieldInfos(Directory d, java.lang.String name) throws java.io.IOException
d
- The directory to open the IndexInput fromname
- The name of the file to open the IndexInput from in the Directoryjava.io.IOException
public void add(FieldInfos other)
public java.lang.Object clone()
clone
in class java.lang.Object
public void add(Document doc)
public boolean hasProx()
public void add(java.lang.String name, boolean isIndexed)
name
- The name of the FieldableisIndexed
- true if the field is indexedadd(String, boolean, boolean)
public void add(java.lang.String name, boolean isIndexed, boolean storeTermVector)
name
- The name of the fieldisIndexed
- true if the field is indexedstoreTermVector
- true if the term vector should be storedpublic void add(java.lang.String name, boolean isIndexed, boolean storeTermVector, boolean omitNorms)
name
- The name of the fieldisIndexed
- true if the field is indexedstoreTermVector
- true if the term vector should be storedomitNorms
- true if the norms for the indexed field should be omittedpublic FieldInfo add(java.lang.String name, boolean isIndexed, boolean storeTermVector, boolean omitNorms, boolean storePayloads, FieldInfo.IndexOptions indexOptions)
name
- The name of the fieldisIndexed
- true if the field is indexedstoreTermVector
- true if the term vector should be storedomitNorms
- true if the norms for the indexed field should be omittedstorePayloads
- true if payloads should be stored for this fieldindexOptions
- if term freqs should be omitted for this fieldpublic int fieldNumber(java.lang.String fieldName)
fieldName
- field's namepublic FieldInfo fieldInfo(java.lang.String fieldName)
public java.lang.String fieldName(int fieldNumber)
fieldNumber
- public FieldInfo fieldInfo(int fieldNumber)
fieldNumber
- public java.util.Iterator<FieldInfo> iterator()
iterator
in interface java.lang.Iterable<FieldInfo>
public int size()
public boolean hasVectors()
public void write(Directory d, java.lang.String name) throws java.io.IOException
java.io.IOException
public void write(IndexOutput output) throws java.io.IOException
java.io.IOException
Copyright © 2000-2022 Apache Software Foundation. All Rights Reserved.