Package org.terrier.structures.postings.bit

Class BlockFieldIterablePosting

java.lang.Object

org.terrier.structures.postings.BasicPostingImpl

org.terrier.structures.postings.bit.BasicIterablePosting

org.terrier.structures.postings.bit.BlockFieldIterablePosting

All Implemented Interfaces:

java.io.Closeable, java.io.Serializable, java.lang.AutoCloseable, org.apache.hadoop.io.Writable, BlockPosting, FieldPosting, IterablePosting, Posting, WritablePosting

public class BlockFieldIterablePosting
extends BasicIterablePosting
implements BlockPosting, FieldPosting

class BlockFieldIterablePosting

See Also:

Serialized Form

Field Summary

Fields inherited from class org.terrier.structures.postings.bit.BasicIterablePosting

bitFileReader, doi, numEntries

Fields inherited from class org.terrier.structures.postings.BasicPostingImpl

dl, id, tf

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

END_OF_LIST, EOL

Constructor Summary

Constructors

Constructor	Description
BlockFieldIterablePosting(int _fieldCount)	Make a new posting that can be loaded using Writable methods
BlockFieldIterablePosting(BitIn _bitFileReader, int _numEntries, DocumentIndex doi, int _fieldCount)	Make a new posting iterator that is read from a BitIn stream.

Method Summary

Modifier and Type	Method	Description
WritablePosting	asWritablePosting()	Copy this posting to one free of an iterator.
int[]	getFieldFrequencies()	Returns the frequencies of the term in each field of the document.
int[]	getFieldLengths()	Returns the lengths of the each field in the current document.
int[]	getPositions()	Return the positions of occurrences of the term in the current document.
int	next()	Move this iterator to the next posting.
void	readFields(java.io.DataInput in)	Reads the a single posting (not an iterable posting - use BitPostingIndex for that)
void	setFieldLengths(int[] fl)	.
java.lang.String	toString()	Makes a human readable form of this posting
void	write(java.io.DataOutput out)	Writes the current posting (not an iterable posting - use DirectInvertedOutputStream for that).

Methods inherited from class org.terrier.structures.postings.bit.BasicIterablePosting

close, endOfPostings, getDocumentLength, next

Methods inherited from class org.terrier.structures.postings.BasicPostingImpl

getFrequency, getId, setDocumentLength, setId, setTf

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

Constructor Detail

BlockFieldIterablePosting

public BlockFieldIterablePosting(int _fieldCount)

Make a new posting that can be loaded using Writable methods

Parameters:

_fieldCount - number of fields to expect

BlockFieldIterablePosting

public BlockFieldIterablePosting(BitIn _bitFileReader,
                                 int _numEntries,
                                 DocumentIndex doi,
                                 int _fieldCount)
                          throws java.io.IOException

Make a new posting iterator that is read from a BitIn stream.

Parameters:

_bitFileReader - BitIn stream containing postings

_numEntries - number of postings to read from stream

doi - DocumentIndex to read document and field lengths from

_fieldCount - number of fields to expect

Throws:

java.io.IOException

Method Detail

next

public int next()
         throws java.io.IOException

Move this iterator to the next posting.

Specified by:

next in interface IterablePosting

Overrides:

next in class BasicIterablePosting

Returns:

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

Throws:

java.io.IOException

getPositions

public int[] getPositions()

Return the positions of occurrences of the term in the current document.

Specified by:

getPositions in interface BlockPosting

Returns:

the positions of occurrences of the term in the current document.

getFieldFrequencies

public int[] getFieldFrequencies()

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

Specified by:

getFieldFrequencies in interface FieldPosting

Returns:

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

setFieldLengths

public void setFieldLengths(int[] fl)

. This operation is unsupported.

Specified by:

setFieldLengths in interface FieldPosting

getFieldLengths

public int[] getFieldLengths()

Returns the lengths of the each field in the current document.

Specified by:

getFieldLengths in interface FieldPosting

Returns:

the lengths of the each field in the current document.

readFields

public void readFields(java.io.DataInput in)
                throws java.io.IOException

Reads the a single posting (not an iterable posting - use BitPostingIndex for that)

Specified by:

readFields in interface org.apache.hadoop.io.Writable

Overrides:

readFields in class BasicPostingImpl

Throws:

java.io.IOException

write

public void write(java.io.DataOutput out)
           throws java.io.IOException

Writes the current posting (not an iterable posting - use DirectInvertedOutputStream for that). Compression using this method is not expected to be comparable to bit-level compression.

Specified by:

write in interface org.apache.hadoop.io.Writable

Overrides:

write in class BasicPostingImpl

Throws:

java.io.IOException

asWritablePosting

public WritablePosting asWritablePosting()

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

Specified by:

asWritablePosting in interface Posting

Overrides:

asWritablePosting in class BasicIterablePosting

Returns:

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

toString

public java.lang.String toString()

Makes a human readable form of this posting

Overrides:

toString in class BasicIterablePosting