org.sindice.siren.index.codecs.block

Class BlockIndexOutput

java.lang.Object

org.sindice.siren.index.codecs.block.BlockIndexOutput

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

DocsFreqBlockIndexOutput, NodBlockIndexOutput, PosBlockIndexOutput

public abstract class BlockIndexOutput
extends Object
implements Closeable

Abstract API to encode a block-based posting format.

This class is not thread-safe and not safe for concurrent file access. It must not be used to encode multiple blocks concurrently. In the current implementation of Lucene, terms are processed sequentially during the creation of a new index segment. It is ensured that (1) one instance of this class is always used by one single thread, and (2) one instance of this class is always encoding postings one term at a time.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	BlockIndexOutput.BlockWriter Abstraction over the writer of the blocks of the postings file.
class	BlockIndexOutput.Index This class stores the file pointer of an IndexOutput.

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	logger
protected org.apache.lucene.store.IndexOutput	out

Constructor Summary

Constructors

Constructor and Description
BlockIndexOutput(org.apache.lucene.store.IndexOutput out)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
abstract BlockIndexOutput.BlockWriter	getBlockWriter() Create a new BlockIndexOutput.BlockWriter associated to this BlockIndexOutput.
BlockIndexOutput.Index	index() Instantiates a new block index.

Methods inherited from class java.lang.Object

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

Field Detail

out

protected final org.apache.lucene.store.IndexOutput out

logger

protected static final org.slf4j.Logger logger

Constructor Detail

BlockIndexOutput

public BlockIndexOutput(org.apache.lucene.store.IndexOutput out)

Method Detail

index

public BlockIndexOutput.Index index()
                             throws IOException

Instantiates a new block index.

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getBlockWriter

public abstract BlockIndexOutput.BlockWriter getBlockWriter()

Create a new BlockIndexOutput.BlockWriter associated to this BlockIndexOutput.

You should ensure to flush all BlockIndexOutput.BlockWriter before closing the BlockIndexOutput.

More than one BlockIndexOutput.BlockWriter can be instantiated by a BlockIndexOutput. Usually one writer is instantiated for each term.