Package org.apache.lucene.index
Class FilterAtomicReader.FilterFields
- java.lang.Object
-
- org.apache.lucene.index.Fields
-
- org.apache.lucene.index.FilterAtomicReader.FilterFields
-
- All Implemented Interfaces:
java.lang.Iterable<java.lang.String>
- Enclosing class:
- FilterAtomicReader
public static class FilterAtomicReader.FilterFields extends Fields
Base class for filteringFields
implementations.
-
-
Field Summary
Fields Modifier and Type Field Description protected Fields
in
The underlying Fields instance.-
Fields inherited from class org.apache.lucene.index.Fields
EMPTY_ARRAY
-
-
Constructor Summary
Constructors Constructor Description FilterFields(Fields in)
Creates a new FilterFields.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Iterator<java.lang.String>
iterator()
Returns an iterator that will step through all fields names.int
size()
Returns the number of fields or -1 if the number of distinct field names is unknown.Terms
terms(java.lang.String field)
Get theTerms
for this field.-
Methods inherited from class org.apache.lucene.index.Fields
getUniqueTermCount
-
-
-
-
Field Detail
-
in
protected final Fields in
The underlying Fields instance.
-
-
Constructor Detail
-
FilterFields
public FilterFields(Fields in)
Creates a new FilterFields.- Parameters:
in
- the underlying Fields instance.
-
-
Method Detail
-
iterator
public java.util.Iterator<java.lang.String> iterator()
Description copied from class:Fields
Returns an iterator that will step through all fields names. This will not return null.
-
terms
public Terms terms(java.lang.String field) throws java.io.IOException
Description copied from class:Fields
Get theTerms
for this field. This will return null if the field does not exist.
-
size
public int size()
Description copied from class:Fields
Returns 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.
-
-