Module org.apache.lucene.core

Package org.apache.lucene.codecs.perfield

Class PerFieldPostingsFormat.FieldsReader

java.lang.Object

org.apache.lucene.index.Fields

org.apache.lucene.codecs.FieldsProducer

org.apache.lucene.codecs.perfield.PerFieldPostingsFormat.FieldsReader

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<String>

Enclosing class:

PerFieldPostingsFormat

private static class PerFieldPostingsFormat.FieldsReader
extends FieldsProducer

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<String,FieldsProducer>	fields
private final Map<String,FieldsProducer>	formats
private final String	segment

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

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor	Description
FieldsReader(PerFieldPostingsFormat.FieldsReader other)
FieldsReader(SegmentReadState readState)

Method Summary

Modifier and Type	Method	Description
void	checkIntegrity()	Checks consistency of this reader.
void	close()
FieldsProducer	getMergeInstance()	Returns an instance optimized for merging.
Iterator<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(String field)	Get the Terms for this field.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

fields

private final Map<String,FieldsProducer> fields

formats

private final Map<String,FieldsProducer> formats

segment

private final String segment

Constructor Details

FieldsReader

FieldsReader(PerFieldPostingsFormat.FieldsReader other)

FieldsReader

public FieldsReader(SegmentReadState readState)
             throws IOException

Throws:

IOException

Method Details

iterator

public Iterator<String> iterator()

Description copied from class: Fields

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

Specified by:

iterator in interface Iterable<String>

Specified by:

iterator in class Fields

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()

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.

Specified by:

size in class Fields

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class FieldsProducer

Throws:

IOException

checkIntegrity

public void checkIntegrity()
                    throws IOException

Description copied from class: FieldsProducer

Checks consistency of this reader.

Note that this may be costly in terms of I/O, e.g. may involve computing a checksum value against large data files.

Specified by:

checkIntegrity in class FieldsProducer

Throws:

IOException

getMergeInstance

public FieldsProducer getMergeInstance()

Description copied from class: FieldsProducer

Returns an instance optimized for merging. This instance may only be consumed in the thread that called FieldsProducer.getMergeInstance().

The default implementation returns this

Overrides:

getMergeInstance in class FieldsProducer

toString

public String toString()

Overrides:

toString in class Object