org.terrier.structures.postings.integer

Class FieldIntegerCodingIterablePosting

java.lang.Object

org.terrier.structures.postings.integer.BasicIntegerCodingIterablePosting

org.terrier.structures.postings.integer.FieldIntegerCodingIterablePosting

All Implemented Interfaces:

Closeable, AutoCloseable, FieldPosting, IterablePosting, Posting

Direct Known Subclasses:

BlockFieldIntegerCodingIterablePosting

public class FieldIntegerCodingIterablePosting
extends BasicIntegerCodingIterablePosting
implements FieldPosting

An IterablePosting implementation, which can optionally support Fields

Since:

4.0

Author:

Matteo Catena

Field Summary

Fields

Modifier and Type	Field and Description
protected FieldDocumentIndex	asFieldDocumentIndex
protected int[]	fields
protected IntegerCodec	fieldsCodec
protected int	fieldsCount
protected int[][]	fieldsMatrix

Fields inherited from class org.terrier.structures.postings.integer.BasicIntegerCodingIterablePosting

blkCnt, chunkSize, currentPosting, decompressed, documentIndex, id, ids, idsCodec, input, logger, numberOfEntries, tf, tfs, tfsCodec

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

END_OF_LIST, EOL

Constructor Summary

Constructors

Constructor and Description
FieldIntegerCodingIterablePosting(ByteIn input, int numberOfEntries, DocumentIndex documentIndex, int chunkSize, int fieldCount, IntegerCodec idsCodec, IntegerCodec tfsCodec, IntegerCodec fieldsCodec)

Method Summary

Modifier and Type	Method and Description
WritablePosting	asWritablePosting() Copies this posting to one free of an iterator.
protected void	decompress() This load the a chunk (tfs) and decompress it
protected void	get(int pos) Read the posting components from the chunk
int[]	getFieldFrequencies() Returns the frequencies of the term in each field of the document
int[]	getFieldLengths() Returns the lengths of the each fields in the current document
void	setFieldLengths(int[] newLengths)
protected void	skip() If tfs, fields frequencies and blocks are not required, skip that part of the chunk
String	toString() Makes a human readable form of this posting

Methods inherited from class org.terrier.structures.postings.integer.BasicIntegerCodingIterablePosting

close, endOfPostings, getCurrentAddress, getDocumentLength, getFrequency, getId, load, next, next, setId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.terrier.structures.postings.Posting

getDocumentLength, getFrequency, getId, setId

Field Detail

fields

protected int[] fields

fieldsMatrix

protected final int[][] fieldsMatrix

fieldsCodec

protected final IntegerCodec fieldsCodec

fieldsCount

protected final int fieldsCount

asFieldDocumentIndex

protected FieldDocumentIndex asFieldDocumentIndex

Constructor Detail

FieldIntegerCodingIterablePosting

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

Throws:

IOException

Method Detail

asWritablePosting

public WritablePosting asWritablePosting()

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

Overrides:

asWritablePosting in class BasicIntegerCodingIterablePosting

Returns:

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

getFieldFrequencies

public int[] getFieldFrequencies()

Description copied from interface: FieldPosting

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

Specified by:

getFieldFrequencies in interface FieldPosting

decompress

protected void decompress()
                   throws IOException

Description copied from class: BasicIntegerCodingIterablePosting

This load the a chunk (tfs) and decompress it

Overrides:

decompress in class BasicIntegerCodingIterablePosting

Throws:

IOException

skip

protected void skip()
             throws IOException

Description copied from class: BasicIntegerCodingIterablePosting

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

Overrides:

skip in class BasicIntegerCodingIterablePosting

Throws:

IOException

get

protected void get(int pos)
            throws IOException

Description copied from class: BasicIntegerCodingIterablePosting

Read the posting components from the chunk

Overrides:

get in class BasicIntegerCodingIterablePosting

Parameters:

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

Throws:

IOException

getFieldLengths

public int[] getFieldLengths()

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)

Specified by:

setFieldLengths in interface FieldPosting

toString

public String toString()

Makes a human readable form of this posting

Overrides:

toString in class BasicIntegerCodingIterablePosting