Package org.apache.lucene.index
Class MultiFields
- java.lang.Object
-
- org.apache.lucene.index.Fields
-
- org.apache.lucene.index.MultiFields
-
public final class MultiFields extends Fields
Provides a singleFieldsterm index view over anIndexReader. This is useful when you're interacting with anIndexReaderimplementation that consists of sequential sub-readers (egDirectoryReaderorMultiReader) and you must treat it as aLeafReader.NOTE: for composite readers, you'll get better performance by gathering the sub readers using
IndexReader.getContext()to get the atomic leaves and then operate per-LeafReader, instead of using this class.- NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.
-
-
Field Summary
-
Fields inherited from class org.apache.lucene.index.Fields
EMPTY_ARRAY
-
-
Constructor Summary
Constructors Constructor Description MultiFields(Fields[] subs, ReaderSlice[] subSlices)Sole constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Iterator<String>iterator()Returns an iterator that will step through all fields names.intsize()Returns the number of fields or -1 if the number of distinct field names is unknown.Termsterms(String field)Get theTermsfor this field.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
-
-
-
Constructor Detail
-
MultiFields
public MultiFields(Fields[] subs, ReaderSlice[] subSlices)
Sole constructor.
-
-
Method Detail
-
iterator
public Iterator<String> iterator()
Description copied from class:FieldsReturns an iterator that will step through all fields names. This will not return null.
-
terms
public Terms terms(String field) throws IOException
Description copied from class:FieldsGet theTermsfor this field. This will return null if the field does not exist.- Specified by:
termsin classFields- Throws:
IOException
-
size
public int size()
Description copied from class:FieldsReturns the number of fields or -1 if the number of distinct field names is unknown. If >= 0,Fields.iterator()will return as many field names.
-
-