org.terrier.structures.bit

Class BitPostingIndex

java.lang.Object

org.terrier.structures.bit.BitPostingIndex

All Implemented Interfaces:

Closeable, AutoCloseable, PostingIndex<BitIndexPointer>

Direct Known Subclasses:

DirectIndex, InvertedIndex

public class BitPostingIndex
extends Object
implements PostingIndex<BitIndexPointer>

Class for various bit compressed index implementations, including parents to current DirectIndex and InvertedIndex implementations. Index properties:

• index.STRUCTURENAME.data-files - how many files represent this structure.
• index.STRUCTURENAME.data-source - one of {file,fileinmem} or a class implements BitInSeekable.
• index.STRUCTURENAME.fields.count - how many fields are in use by this structures.

Since:

3.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.terrier.structures.PostingIndex

PostingIndex.DocidSpecificDocumentIndex

Field Summary

Fields

Modifier and Type	Field and Description
protected DocumentIndex	doi
protected int	fieldCount
protected IndexOnDisk	index
protected Constructor<? extends IterablePosting>	postingConstructor
protected Class<? extends IterablePosting>	postingImplementation

Constructor Summary

Constructors

Modifier	Constructor and Description
	BitPostingIndex(IndexOnDisk _index, String _structureName, Class<? extends IterablePosting> _postingImplementation) Constructs an instance of the BitPostingIndex.
	BitPostingIndex(IndexOnDisk _index, String _structureName, DocumentIndex _documentIndex, Class<? extends IterablePosting> _postingImplementation) Constructs an instance of the BitPostingIndex.
protected	BitPostingIndex(String filename, byte fileCount, Class<? extends IterablePosting> _postingImplementation, String _dataSource) Deprecated.
	BitPostingIndex(String filename, byte fileCount, Class<BasicIterablePosting> _postingImplementation, String _dataSource, int _fieldCount)
protected	BitPostingIndex(String filename, byte fileCount, DocumentIndex _doi, Class<? extends IterablePosting> _postingImplementation, String _dataSource, int _fieldCount)

Method Summary

Modifier and Type	Method and Description
void	close()
IterablePosting	getPostings(Pointer pointer) Get the posting given a pointer
protected void	setPostingImplementation(Class<? extends IterablePosting> postingClass)

Methods inherited from class java.lang.Object

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

Field Detail

postingImplementation

protected Class<? extends IterablePosting> postingImplementation

postingConstructor

protected Constructor<? extends IterablePosting> postingConstructor

doi

protected DocumentIndex doi

index

protected IndexOnDisk index

fieldCount

protected int fieldCount

Constructor Detail

BitPostingIndex

public BitPostingIndex(IndexOnDisk _index,
                       String _structureName,
                       Class<? extends IterablePosting> _postingImplementation)
                throws IOException

Constructs an instance of the BitPostingIndex.

Parameters:

_index -

_structureName -

_postingImplementation -

Throws:

IOException

BitPostingIndex

public BitPostingIndex(IndexOnDisk _index,
                       String _structureName,
                       DocumentIndex _documentIndex,
                       Class<? extends IterablePosting> _postingImplementation)
                throws IOException

Constructs an instance of the BitPostingIndex.

Parameters:

_index -

_structureName -

_documentIndex -

_postingImplementation -

Throws:

IOException

BitPostingIndex

public BitPostingIndex(String filename,
                       byte fileCount,
                       Class<BasicIterablePosting> _postingImplementation,
                       String _dataSource,
                       int _fieldCount)
                throws IOException

Throws:

IOException

BitPostingIndex

@Deprecated
protected BitPostingIndex(String filename,
                                      byte fileCount,
                                      Class<? extends IterablePosting> _postingImplementation,
                                      String _dataSource)
                               throws IOException

Deprecated.

Throws:

IOException

BitPostingIndex

protected BitPostingIndex(String filename,
                          byte fileCount,
                          DocumentIndex _doi,
                          Class<? extends IterablePosting> _postingImplementation,
                          String _dataSource,
                          int _fieldCount)
                   throws IOException

Throws:

IOException

Method Detail

setPostingImplementation

protected void setPostingImplementation(Class<? extends IterablePosting> postingClass)
                                 throws IOException

Throws:

IOException

getPostings

public IterablePosting getPostings(Pointer pointer)
                            throws IOException

Get the posting given a pointer

Specified by:

getPostings in interface PostingIndex<BitIndexPointer>

Throws:

IOException

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable