org.apache.lucene.codecs.perfield

Class PerFieldPostingsFormat.FieldsWriter

java.lang.Object

org.apache.lucene.codecs.FieldsConsumer

org.apache.lucene.codecs.perfield.PerFieldPostingsFormat.FieldsWriter

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Enclosing class:

PerFieldPostingsFormat

private class PerFieldPostingsFormat.FieldsWriter
extends FieldsConsumer

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.util.List<java.io.Closeable>	toClose
(package private) SegmentWriteState	writeState

Constructor Summary

Constructors

Constructor and Description
FieldsWriter(SegmentWriteState writeState)

Method Summary

Modifier and Type	Method and Description
private java.util.Map<PostingsFormat,PerFieldPostingsFormat.FieldsGroup>	buildFieldsGroupMapping(Fields fields)
void	close()
void	merge(MergeState mergeState) Merges in the fields from the readers in mergeState.
void	write(Fields fields) Write all fields, terms and postings.

Methods inherited from class java.lang.Object

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

Field Detail

writeState

final SegmentWriteState writeState

toClose

final java.util.List<java.io.Closeable> toClose

Constructor Detail

FieldsWriter

public FieldsWriter(SegmentWriteState writeState)

Method Detail

write

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

java.io.IOException

merge

public void merge(MergeState mergeState)
           throws java.io.IOException

Description copied from class: FieldsConsumer

Merges in the fields from the readers in mergeState. The default implementation skips and maps around deleted documents, and calls FieldsConsumer.write(Fields). Implementations can override this method for more sophisticated merging (bulk-byte copying, etc).

Overrides:

merge in class FieldsConsumer

Throws:

java.io.IOException

buildFieldsGroupMapping

private java.util.Map<PostingsFormat,PerFieldPostingsFormat.FieldsGroup> buildFieldsGroupMapping(Fields 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 FieldsConsumer

Throws:

java.io.IOException