org.terrier.structures.postings.integer

Class IntegerCodingIterablePosting

java.lang.Object

org.terrier.structures.postings.integer.IntegerCodingIterablePosting

All Implemented Interfaces:

Closeable, AutoCloseable, BlockPosting, FieldPosting, IterablePosting, Posting

Deprecated.

public class IntegerCodingIterablePosting
extends Object
implements IterablePosting, FieldPosting, BlockPosting

An IterablePosting implementation, which can optionally support fields and/or blocks. Its content is compressed using some integer coding technique. Note: this class read the input in chunks of posting. The chunk size is specified in chunkSize

Since:

4.0

Author:

Matteo Catena

Field Summary

Fields

Modifier and Type	Field and Description
protected FieldDocumentIndex	asFieldDocumentIndex Deprecated.
protected int	bf Deprecated.
protected int[]	bfs Deprecated.
protected int	blkCnt Deprecated.
protected int[]	blocks Deprecated.
protected IntegerCodec	blocksCodec Deprecated.
protected int[]	blocksMatrix Deprecated.
protected int	chunkSize Deprecated. Number of postings in a chunk
protected int	currentPosting Deprecated.
protected boolean	decompressed Deprecated.
protected DocumentIndex	documentIndex Deprecated.
protected int[]	fields Deprecated.
protected IntegerCodec	fieldsCodec Deprecated.
protected int	fieldsCount Deprecated.
protected int[][]	fieldsMatrix Deprecated.
protected int	hasBlocks Deprecated.
protected int	id Deprecated.
protected int[]	ids Deprecated.
protected IntegerCodec	idsCodec Deprecated.
protected ByteIn	input Deprecated.
protected static org.slf4j.Logger	logger Deprecated. The logger used
protected int	numberOfEntries Deprecated.
protected int	tf Deprecated.
protected int[]	tfs Deprecated.
protected IntegerCodec	tfsCodec Deprecated.

Fields inherited from interface org.terrier.structures.postings.IterablePosting

EOL

Constructor Summary

Constructors

Constructor and Description
IntegerCodingIterablePosting(ByteIn input, int numberOfEntries, DocumentIndex documentIndex, int chunkSize, int fieldCount, int hasBlocks, IntegerCodec idsCodec, IntegerCodec tfsCodec, IntegerCodec fieldsCodec, IntegerCodec blocksCodec) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
WritablePosting	asWritablePosting() Deprecated. Copies this posting to one free of an iterator.
void	close() Deprecated.
protected void	decompress() Deprecated. This load the a chunk (tfs, fields and blocks (optionally)) and decompress it
boolean	endOfPostings() Deprecated. Status method to see if this posting list iterator has been finished
protected void	get(int pos) Deprecated. Read the posting components from the chunk
long	getCurrentAddress() Deprecated.
int	getDocumentLength() Deprecated. Return the length of the document for this posting.
int[]	getFieldFrequencies() Deprecated. Returns the frequencies of the term in each field of the document
int[]	getFieldLengths() Deprecated. Returns the lengths of the each fields in the current document
int	getFrequency() Deprecated. Return the frequency of the term in the current document
int	getId() Deprecated. Return the id of the current posting.
int[]	getPositions() Deprecated. Return positions of occurrences
protected void	load() Deprecated. This load a chunk (just the document ids!) and decompress it
int	next() Deprecated. Move this iterator to the next posting.
int	next(int targetId) Deprecated. Move this iterator to the posting with specified id, or next posting after that.
void	setFieldLengths(int[] newLengths) Deprecated.
void	setId(int id) Deprecated. It may be of benefit to update the frequency of the id in some applications.
protected void	skip() Deprecated. If tfs, fields frequencies and blocks are not required, skip that part of the chunk
String	toString() Deprecated. Makes a human readable form of this posting

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

Deprecated.

The logger used

documentIndex

protected DocumentIndex documentIndex

Deprecated.

chunkSize

protected int chunkSize

Deprecated.

Number of postings in a chunk

numberOfEntries

protected int numberOfEntries

Deprecated.

currentPosting

protected int currentPosting

Deprecated.

id

protected int id

Deprecated.

tf

protected int tf

Deprecated.

fields

protected int[] fields

Deprecated.

bf

protected int bf

Deprecated.

blocks

protected int[] blocks

Deprecated.

ids

protected final int[] ids

Deprecated.

tfs

protected final int[] tfs

Deprecated.

fieldsMatrix

protected final int[][] fieldsMatrix

Deprecated.

bfs

protected int[] bfs

Deprecated.

blocksMatrix

protected int[] blocksMatrix

Deprecated.

fieldsCount

protected final int fieldsCount

Deprecated.

asFieldDocumentIndex

protected FieldDocumentIndex asFieldDocumentIndex

Deprecated.

hasBlocks

protected final int hasBlocks

Deprecated.

input

protected final ByteIn input

Deprecated.

idsCodec

protected final IntegerCodec idsCodec

Deprecated.

tfsCodec

protected final IntegerCodec tfsCodec

Deprecated.

fieldsCodec

protected final IntegerCodec fieldsCodec

Deprecated.

blocksCodec

protected final IntegerCodec blocksCodec

Deprecated.

blkCnt

protected int blkCnt

Deprecated.

decompressed

protected boolean decompressed

Deprecated.

Constructor Detail

IntegerCodingIterablePosting

public IntegerCodingIterablePosting(ByteIn input,
                            int numberOfEntries,
                            DocumentIndex documentIndex,
                            int chunkSize,
                            int fieldCount,
                            int hasBlocks,
                            IntegerCodec idsCodec,
                            IntegerCodec tfsCodec,
                            IntegerCodec fieldsCodec,
                            IntegerCodec blocksCodec)
                             throws IOException

Deprecated.

Parameters:

input - the input channel

numberOfEntries - the number of postings

documentIndex - the document index

chunkSize - the size of the chunk

fieldCount - the number of fields (0 if the posting list has no fields)

hasBlocks - has this posting list posting positions? (0: no, 1:has positions, >1:has blocks)

idsCodec - the IntegerCodec to use to decode docIds

tfsCodec - the IntegerCodec to use to decode term frequencies

fieldsCodec - the IntegerCodec to use to decode field frequencies (if any, null otherwise)

blocksCodec - the IntegerCodec to use to decode blocks (if any, null otherwise)

Throws:

IOException

Method Detail

getId

public int getId()

Deprecated.

Description copied from interface: Posting

Return the id of the current posting. For the inverted index, this is the docid; for the direct index it corresponds to the term id

Specified by:

getId in interface Posting

Returns:

id of the posting

getFrequency

public int getFrequency()

Deprecated.

Description copied from interface: Posting

Return the frequency of the term in the current document

Specified by:

getFrequency in interface Posting

Returns:

frequency of posting, in tokens

getDocumentLength

public int getDocumentLength()

Deprecated.

Description copied from interface: Posting

Return the length of the document for this posting. Usually uses the DocumentIndex, may do otherwise if document length statistics are in posting list

Specified by:

getDocumentLength in interface Posting

Returns:

length of the document of the current posting in tokens.

setId

public void setId(int id)

Deprecated.

Description copied from interface: Posting

It may be of benefit to update the frequency of the id in some applications. This should not be used lightly, as it may break the decompression of other postings in iterators.

Specified by:

setId in interface Posting

asWritablePosting

public WritablePosting asWritablePosting()

Deprecated.

Description copied from interface: Posting

Copies this posting to one free of an iterator. Kind of like a clone.

Specified by:

asWritablePosting in interface Posting

Returns:

an identical posting, but which can be maniulated free of this iterator

close

public void close()
           throws IOException

Deprecated.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

load

protected final void load()
                   throws IOException

Deprecated.

This load a chunk (just the document ids!) and decompress it

Throws:

IOException

decompress

protected final void decompress()
                         throws IOException

Deprecated.

This load the a chunk (tfs, fields and blocks (optionally)) and decompress it

Throws:

IOException

skip

protected final void skip()
                   throws IOException

Deprecated.

If tfs, fields frequencies and blocks are not required, skip that part of the chunk

Throws:

IOException

get

protected final void get(int pos)
                  throws IOException

Deprecated.

Read the posting components from the chunk

Parameters:

pos - the posting to load (as index in the internal arrays)

Throws:

IOException

next

public int next()
         throws IOException

Deprecated.

Description copied from interface: IterablePosting

Move this iterator to the next posting.

Specified by:

next in interface IterablePosting

Returns:

id of next posting, or EOL if end of posting list

Throws:

IOException

next

public int next(int targetId)
         throws IOException

Deprecated.

Description copied from interface: IterablePosting

Move this iterator to the posting with specified id, or next posting after that. This is usually implemented internally by next(), but more efficient implementations can override this behaviour.

Specified by:

next in interface IterablePosting

Parameters:

targetId - id of the posting to find in this postingn list.

Returns:

id of the posting found, or EOL if end of posting list.

Throws:

IOException

endOfPostings

public boolean endOfPostings()

Deprecated.

Description copied from interface: IterablePosting

Status method to see if this posting list iterator has been finished

Specified by:

endOfPostings in interface IterablePosting

Returns:

true if next() or next(int) would return EOL or have returned EOL.

getPositions

public int[] getPositions()

Deprecated.

Description copied from interface: BlockPosting

Return positions of occurrences

Specified by:

getPositions in interface BlockPosting

getFieldFrequencies

public int[] getFieldFrequencies()

Deprecated.

Description copied from interface: FieldPosting

Returns the frequencies of the term in each field of the document

Specified by:

getFieldFrequencies in interface FieldPosting

getFieldLengths

public int[] getFieldLengths()

Deprecated.

Description copied from interface: FieldPosting

Returns the lengths of the each fields in the current document

Specified by:

getFieldLengths in interface FieldPosting

setFieldLengths

public void setFieldLengths(int[] newLengths)

Deprecated.

Specified by:

setFieldLengths in interface FieldPosting

toString

public String toString()

Deprecated.

Makes a human readable form of this posting

Overrides:

toString in class Object

getCurrentAddress

public long getCurrentAddress()

Deprecated.