Package org.apache.lucene.index
Class FilterLeafReader.FilterFields
- java.lang.Object
-
- org.apache.lucene.index.Fields
-
- org.apache.lucene.index.FilterLeafReader.FilterFields
-
- Direct Known Subclasses:
MappedMultiFields
- Enclosing class:
- FilterLeafReader
public abstract static class FilterLeafReader.FilterFields extends Fields
Base class for filteringFieldsimplementations.
-
-
Field Summary
Fields Modifier and Type Field Description protected FieldsinThe underlying Fields instance.-
Fields inherited from class org.apache.lucene.index.Fields
EMPTY_ARRAY
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedFilterFields(Fields in)Creates a new FilterFields.
-
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
-
-
-
-
Field Detail
-
in
protected final Fields in
The underlying Fields instance.
-
-
Constructor Detail
-
FilterFields
protected FilterFields(Fields in)
Creates a new FilterFields.- Parameters:
in- the underlying Fields instance.
-
-
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.
-
-