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:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Iterable<java.lang.String>, Accountable

Enclosing class:

PerFieldPostingsFormat

private static class PerFieldPostingsFormat.FieldsReader
extends FieldsProducer

Field Summary

Fields

Modifier and Type	Field and Description
private static long	BASE_RAM_BYTES_USED
private java.util.Map<java.lang.String,FieldsProducer>	fields
private java.util.Map<java.lang.String,FieldsProducer>	formats
private java.lang.String	segment

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

EMPTY_ARRAY

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	checkIntegrity() Checks consistency of this reader.
void	close()
java.util.Collection<Accountable>	getChildResources() Returns nested resources of this class.
FieldsProducer	getMergeInstance() Returns an instance optimized for merging.
java.util.Iterator<java.lang.String>	iterator() Returns an iterator that will step through all fields names.
long	ramBytesUsed() Return the memory usage of this object in bytes.
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 the Terms for this field.
java.lang.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 Detail

BASE_RAM_BYTES_USED

private static final long BASE_RAM_BYTES_USED

fields

private final java.util.Map<java.lang.String,FieldsProducer> fields

formats

private final java.util.Map<java.lang.String,FieldsProducer> formats

segment

private final java.lang.String segment

Constructor Detail

FieldsReader

FieldsReader(PerFieldPostingsFormat.FieldsReader other)

FieldsReader

public FieldsReader(SegmentReadState readState)
             throws java.io.IOException

Throws:

java.io.IOException

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.

Specified by:

iterator in interface java.lang.Iterable<java.lang.String>

Specified by:

iterator in class Fields

terms

public Terms terms(java.lang.String field)
            throws java.io.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:

java.io.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 java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class FieldsProducer

Throws:

java.io.IOException

ramBytesUsed

public long ramBytesUsed()

Description copied from interface: Accountable

Return the memory usage of this object in bytes. Negative values are illegal.

getChildResources

public java.util.Collection<Accountable> getChildResources()

Description copied from interface: Accountable

Returns nested resources of this class. The result should be a point-in-time snapshot (to avoid race conditions).

See Also:

Accountables

checkIntegrity

public void checkIntegrity()
                    throws java.io.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:

java.io.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 java.lang.String toString()

Overrides:

toString in class java.lang.Object