org.terrier.structures.postings
Class FieldIterablePosting

java.lang.Object
  extended by org.terrier.structures.postings.BasicPostingImpl
      extended by org.terrier.structures.postings.BasicIterablePosting
          extended by org.terrier.structures.postings.FieldIterablePosting
All Implemented Interfaces:
java.io.Closeable, org.apache.hadoop.io.Writable, FieldPosting, IterablePosting, Posting, WritablePosting

public class FieldIterablePosting
extends BasicIterablePosting
implements FieldPosting

A posting iterator for field postings.

Since:
3.0
Author:
Craig Macdonald
See Also:
Posting, IterablePosting, FieldPosting

Field Summary
 
Fields inherited from class org.terrier.structures.postings.BasicIterablePosting
bitFileReader, doi, numEntries
 
Fields inherited from class org.terrier.structures.postings.BasicPostingImpl
id, tf
 
Fields inherited from interface org.terrier.structures.postings.IterablePosting
EOL
 
Constructor Summary
FieldIterablePosting(BitIn fileReader, int entries, DocumentIndex _doi, int _fieldCount)
          constructor
FieldIterablePosting(int _fieldCount)
          contructor
 
Method Summary
 WritablePosting asWritablePosting()
          Get this posting as a WritablePosting
 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
 int next()
          Move this iterator to the next posting.
 void readFields(java.io.DataInput in)
          Read this posting from specified inputstream
 java.lang.String toString()
          Makes a human readable form of this posting
 void write(java.io.DataOutput out)
          Write this posting to specified outputstream
 
Methods inherited from class org.terrier.structures.postings.BasicIterablePosting
close, endOfPostings, getDocumentLength, next
 
Methods inherited from class org.terrier.structures.postings.BasicPostingImpl
getFrequency, getId, 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
 

Constructor Detail

FieldIterablePosting

public FieldIterablePosting(int _fieldCount)
contructor

Parameters:
_fieldCount -

FieldIterablePosting

public FieldIterablePosting(BitIn fileReader,
                            int entries,
                            DocumentIndex _doi,
                            int _fieldCount)
                     throws java.io.IOException
constructor

Parameters:
fileReader -
entries -
_doi -
_fieldCount -
Throws:
java.io.IOException
Method Detail

getFieldFrequencies

public int[] getFieldFrequencies()
Returns the frequencies of the term in each field of the document

Specified by:
getFieldFrequencies in interface FieldPosting

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

getFieldLengths

public int[] getFieldLengths()
Returns the lengths of the each fields in the current document

Specified by:
getFieldLengths in interface FieldPosting

readFields

public void readFields(java.io.DataInput in)
                throws java.io.IOException
Read this posting from specified inputstream

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
Write this posting to specified outputstream

Specified by:
write in interface org.apache.hadoop.io.Writable
Overrides:
write in class BasicPostingImpl
Throws:
java.io.IOException

asWritablePosting

public WritablePosting asWritablePosting()
Get this posting as a WritablePosting

Specified by:
asWritablePosting in interface Posting
Overrides:
asWritablePosting in class BasicIterablePosting
Returns:
an identical posting, but which can be maniulated free of this iterator

toString

public java.lang.String toString()
Description copied from class: BasicPostingImpl
Makes a human readable form of this posting

Overrides:
toString in class BasicPostingImpl


Terrier 3.5. Copyright © 2004-2011 University of Glasgow