org.apache.lucene.index

Class FieldsEnum

java.lang.Object

org.apache.lucene.index.FieldsEnum

Direct Known Subclasses:

FilterAtomicReader.FilterFieldsEnum, MultiFieldsEnum

public abstract class FieldsEnum
extends Object

Enumerates indexed fields. You must first call next() before calling terms().

WARNING: This API is experimental and might change in incompatible ways in the next release.

Field Summary

Fields

Modifier and Type	Field and Description
static FieldsEnum	EMPTY Provides zero fields
static FieldsEnum[]	EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
FieldsEnum()

Method Summary

Methods

Modifier and Type	Method and Description
AttributeSource	attributes() Returns the related attributes.
abstract String	next() Increments the enumeration to the next field.
abstract Terms	terms() Get Terms for the current field.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EMPTY_ARRAY

public static final FieldsEnum[] EMPTY_ARRAY

EMPTY

public static final FieldsEnum EMPTY

Provides zero fields

Constructor Detail

FieldsEnum

public FieldsEnum()

Method Detail

attributes

public AttributeSource attributes()

Returns the related attributes.

next

public abstract String next()
                     throws IOException

Increments the enumeration to the next field. Returns null when there are no more fields.

Throws:

IOException

terms

public abstract Terms terms()
                     throws IOException

Get Terms for the current field. After next() returns null this method should not be called. This method may return null in some cases, which means the provided field does not have any terms.

Throws:

IOException