Module org.apache.lucene.codecs

Package org.apache.lucene.codecs.simpletext

Class SimpleTextFieldsReader

java.lang.Object

org.apache.lucene.index.Fields

org.apache.lucene.codecs.FieldsProducer

org.apache.lucene.codecs.simpletext.SimpleTextFieldsReader

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<String>

class SimpleTextFieldsReader
extends FieldsProducer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	SimpleTextFieldsReader.SimpleTextDocsEnum
private class	SimpleTextFieldsReader.SimpleTextPostingsEnum
private class	SimpleTextFieldsReader.SimpleTextTerms
private class	SimpleTextFieldsReader.SimpleTextTermsEnum

Field Summary

Fields

Modifier and Type	Field	Description
private final FieldInfos	fieldInfos
private final TreeMap<String,Long>	fields
private final IndexInput	in
private final int	maxDoc
private static final long	TERMS_BASE_RAM_BYTES_USED
private final Map<String,SimpleTextFieldsReader.SimpleTextTerms>	termsCache

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

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor	Description
SimpleTextFieldsReader(SegmentReadState state)

Method Summary

Modifier and Type	Method	Description
void	checkIntegrity()	Checks consistency of this reader.
void	close()
Iterator<String>	iterator()	Returns an iterator that will step through all fields names.
private TreeMap<String,Long>	readFields(IndexInput in)
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 org.apache.lucene.codecs.FieldsProducer

getMergeInstance

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 TreeMap<String,Long> fields

in

private final IndexInput in

fieldInfos

private final FieldInfos fieldInfos

maxDoc

private final int maxDoc

TERMS_BASE_RAM_BYTES_USED

private static final long TERMS_BASE_RAM_BYTES_USED

termsCache

private final Map<String,SimpleTextFieldsReader.SimpleTextTerms> termsCache

Constructor Details

SimpleTextFieldsReader

public SimpleTextFieldsReader(SegmentReadState state)
                       throws IOException

Throws:

IOException

Method Details

readFields

private TreeMap<String,Long> readFields(IndexInput in)
                                 throws IOException

Throws:

IOException

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

toString

public String toString()

Overrides:

toString in class Object

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