org.apache.lucene.index

Class FilterAtomicReader.FilterFields

java.lang.Object

org.apache.lucene.index.Fields

org.apache.lucene.index.FilterAtomicReader.FilterFields

Enclosing class:

FilterAtomicReader

public static class FilterAtomicReader.FilterFields
extends Fields

Base class for filtering Fields implementations.

Field Summary

Fields

Modifier and Type	Field and Description
protected Fields	in

Fields inherited from class org.apache.lucene.index.Fields

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
FilterAtomicReader.FilterFields(Fields in)

Method Summary

Methods

Modifier and Type	Method and Description
long	getUniqueTermCount() Returns the number of terms for all fields, or -1 if this measure isn't stored by the codec.
FieldsEnum	iterator() Returns an iterator that will step through all fields names.
int	size() Returns the number of terms for all fields, or -1 if this measure isn't stored by the codec.
Terms	terms(String field) Get the Terms for this field.

Methods inherited from class java.lang.Object

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

Field Detail

in

protected final Fields in

Constructor Detail

FilterAtomicReader.FilterFields

public FilterAtomicReader.FilterFields(Fields in)

Method Detail

iterator

public FieldsEnum iterator()
                    throws IOException

Description copied from class: Fields

Returns an iterator that will step through all fields names. This will not return null.

Specified by:

iterator in class Fields

Throws:

IOException

terms

public Terms terms(String field)
            throws IOException

Description copied from class: Fields

Get the Terms for this field. This will return null if the field does not exist.

Specified by:

terms in class Fields

Throws:

IOException

size

public int size()
         throws IOException

Description copied from class: Fields

Returns the number of terms for all fields, or -1 if this measure isn't stored by the codec. Note that, just like other term measures, this measure does not take deleted documents into account.

Specified by:

size in class Fields

Throws:

IOException

getUniqueTermCount

public long getUniqueTermCount()
                        throws IOException

Description copied from class: Fields

Returns the number of terms for all fields, or -1 if this measure isn't stored by the codec. Note that, just like other term measures, this measure does not take deleted documents into account.

Overrides:

getUniqueTermCount in class Fields

Throws:

IOException