org.apache.lucene.codecs

Class PostingsWriterBase

java.lang.Object

org.apache.lucene.codecs.PostingsConsumer

org.apache.lucene.codecs.PostingsWriterBase

All Implemented Interfaces:

Closeable

Direct Known Subclasses:

Lucene40PostingsWriter, PulsingPostingsWriter, SepPostingsWriter

public abstract class PostingsWriterBase
extends PostingsConsumer
implements Closeable

Extension of PostingsConsumer to support pluggable term dictionaries.

This class contains additional hooks to interact with the provided term dictionaries such as BlockTreeTermsWriter and BlockTermsWriter. If you want to re-use one of these existing implementations and are only interested in customizing the format of the postings list, extend this class instead.

See Also:

PostingsReaderBase

WARNING: This API is experimental and might change in incompatible ways in the next release.

Constructor Summary

Constructors

Constructor and Description
PostingsWriterBase()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	close()
abstract void	finishTerm(TermStats stats) Finishes the current term
abstract void	flushTermsBlock(int start, int count) Flush count terms starting at start "backwards", as a block.
abstract void	setField(FieldInfo fieldInfo)
abstract void	start(IndexOutput termsOut)
abstract void	startTerm()

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

addPosition, finishDoc, merge, startDoc

Methods inherited from class java.lang.Object

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

Constructor Detail

PostingsWriterBase

public PostingsWriterBase()

Method Detail

start

public abstract void start(IndexOutput termsOut)
                    throws IOException

Throws:

IOException

startTerm

public abstract void startTerm()
                        throws IOException

Throws:

IOException

flushTermsBlock

public abstract void flushTermsBlock(int start,
                   int count)
                              throws IOException

Flush count terms starting at start "backwards", as a block. start is a negative offset from the end of the terms stack, ie bigger start means further back in the stack.

Throws:

IOException

finishTerm

public abstract void finishTerm(TermStats stats)
                         throws IOException

Finishes the current term

Throws:

IOException

setField

public abstract void setField(FieldInfo fieldInfo)

close

public abstract void close()
                    throws IOException

Specified by:

close in interface Closeable

Throws:

IOException