Module org.apache.lucene.codecs

Package org.apache.lucene.codecs.simpletext

Class SimpleTextFieldsWriter

java.lang.Object

org.apache.lucene.codecs.FieldsConsumer

org.apache.lucene.codecs.simpletext.SimpleTextFieldsWriter

All Implemented Interfaces:

Closeable, AutoCloseable

class SimpleTextFieldsWriter
extends FieldsConsumer

Field Summary

Fields

Modifier and Type	Field	Description
private final CompetitiveImpactAccumulator	competitiveImpactAccumulator
(package private) static final BytesRef	DOC
private int	docCount	for write skip data.
(package private) static final BytesRef	END
(package private) static final BytesRef	END_OFFSET
(package private) static final BytesRef	FIELD
(package private) static final BytesRef	FREQ
private long	lastDocFilePointer
private IndexOutput	out
(package private) static final BytesRef	PAYLOAD
(package private) static final BytesRef	POS
private final BytesRefBuilder	scratch
(package private) final String	segment
private final SimpleTextSkipWriter	skipWriter
(package private) static final BytesRef	START_OFFSET
(package private) static final BytesRef	TERM
private final SegmentWriteState	writeState

Constructor Summary

Constructors

Constructor	Description
SimpleTextFieldsWriter(SegmentWriteState writeState)

Method Summary

Modifier and Type	Method	Description
void	close()
private long	getNorm(int doc, NumericDocValues norms)
private void	newline()
private void	write(String s)
void	write(FieldInfos fieldInfos, Fields fields, NormsProducer normsProducer)
void	write(Fields fields, NormsProducer norms)	Write all fields, terms and postings.
private void	write(BytesRef b)

Methods inherited from class org.apache.lucene.codecs.FieldsConsumer

merge

Methods inherited from class java.lang.Object

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

Field Details

out

private IndexOutput out

scratch

private final BytesRefBuilder scratch

writeState

private final SegmentWriteState writeState

segment

final String segment

docCount

private int docCount

for write skip data.

skipWriter

private final SimpleTextSkipWriter skipWriter

competitiveImpactAccumulator

private final CompetitiveImpactAccumulator competitiveImpactAccumulator

lastDocFilePointer

private long lastDocFilePointer

END

static final BytesRef END

FIELD

static final BytesRef FIELD

TERM

static final BytesRef TERM

DOC

static final BytesRef DOC

FREQ

static final BytesRef FREQ

POS

static final BytesRef POS

START_OFFSET

static final BytesRef START_OFFSET

END_OFFSET

static final BytesRef END_OFFSET

PAYLOAD

static final BytesRef PAYLOAD

Constructor Details

SimpleTextFieldsWriter

public SimpleTextFieldsWriter(SegmentWriteState writeState)
                       throws IOException

Throws:

IOException

Method Details

write

public void write(Fields fields,
 NormsProducer norms)
           throws IOException

Description copied from class: FieldsConsumer

Write all fields, terms and postings. This the "pull" API, allowing you to iterate more than once over the postings, somewhat analogous to using a DOM API to traverse an XML tree.

Notes:

• You must compute index statistics, including each Term's docFreq and totalTermFreq, as well as the summary sumTotalTermFreq, sumTotalDocFreq and docCount.
• You must skip terms that have no docs and fields that have no terms, even though the provided Fields API will expose them; this typically requires lazily writing the field or term until you've actually seen the first term or document.
• The provided Fields instance is limited: you cannot call any methods that return statistics/counts; you cannot pass a non-null live docs when pulling docs/positions enums.

Specified by:

write in class FieldsConsumer

Throws:

IOException

write

public void write(FieldInfos fieldInfos,
 Fields fields,
 NormsProducer normsProducer)
           throws IOException

Throws:

IOException

write

private void write(String s)
            throws IOException

Throws:

IOException

write

private void write(BytesRef b)
            throws IOException

Throws:

IOException

newline

private void newline()
              throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class FieldsConsumer

Throws:

IOException

getNorm

private long getNorm(int doc,
 NumericDocValues norms)
              throws IOException

Throws:

IOException