org.sindice.siren.index.codecs.block

Class BlockIndexInput

java.lang.Object

org.sindice.siren.index.codecs.block.BlockIndexInput

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

DocsFreqBlockIndexInput, NodBlockIndexInput, PosBlockIndexInput

public abstract class BlockIndexInput
extends Object
implements Closeable

Abstract API to decode a block-based posting format.

This class is safe for concurrent file access. This is achieved by cloning the underlying IndexInput in every BlockIndexInput.BlockReader.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	BlockIndexInput.BlockReader Abstraction over the reader of the blocks of the postings file.
class	BlockIndexInput.Index This class stores the file pointer of a DataInput.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.lucene.store.IndexInput	in
protected static org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
BlockIndexInput(org.apache.lucene.store.IndexInput in)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
abstract BlockIndexInput.BlockReader	getBlockReader() Create a new BlockIndexInput.BlockReader associated to the BlockIndexInput.
BlockIndexInput.Index	index()

Methods inherited from class java.lang.Object

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

Field Detail

in

protected final org.apache.lucene.store.IndexInput in

logger

protected static final org.slf4j.Logger logger

Constructor Detail

BlockIndexInput

public BlockIndexInput(org.apache.lucene.store.IndexInput in)
                throws IOException

Throws:

IOException

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

index

public BlockIndexInput.Index index()
                            throws IOException

Throws:

IOException

getBlockReader

public abstract BlockIndexInput.BlockReader getBlockReader()

Create a new BlockIndexInput.BlockReader associated to the BlockIndexInput.

Subclasses must create a clone of the in to ensure safe concurrent file access.