Package org.terrier.structures.indexing

Class DocumentPostingList.postingIterator

    • Constructor Summary

      Constructors 
      Constructor Description
      postingIterator​(java.lang.String[] _terms, int[] _termIds)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      WritablePosting asWritablePosting()
      Copy this posting to one free of an iterator.
      void close()  
      boolean endOfPostings()
      Status method to see if this posting list iterator has been finished.
      int getDocumentLength()
      Return the length of the document of the current posting in tokens.
      int getFrequency()
      Return the frequency of the term in the current document, in tokens.
      int getId()
      Return the id of the current posting.
      int next()
      Move this iterator to the next posting.

      • Methods inherited from class java.lang.Object

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

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

        setId

    • Constructor Detail

      • postingIterator

        public postingIterator​(java.lang.String[] _terms,
                       int[] _termIds)

    • Method Detail

      • asWritablePosting

        public WritablePosting asWritablePosting()
        Description copied from interface: Posting
        Copy this posting to one free of an iterator. Kind of like a clone.
        Returns:
        an identical posting, but which can be manipulated free of this iterator

      • getDocumentLength

        public int getDocumentLength()
        Description copied from interface: Posting
        Return the length of the document of the current posting in tokens. Usually uses the DocumentIndex, may do otherwise if document length statistics are in posting list.
        Returns:
        length of the document of the current posting in tokens.

      • getFrequency

        public int getFrequency()
        Description copied from interface: Posting
        Return the frequency of the term in the current document, in tokens.
        Returns:
        frequency of the term in the current document, in tokens.

      • getId

        public int getId()
        Description copied from interface: Posting
        Return the id of the current posting. For the inverted index, this is the current docid; for the direct index it corresponds to the current term id.
        Returns:
        id of the posting.

      • next

        public int next()
         throws java.io.IOException
        Description copied from interface: IterablePosting
        Move this iterator to the next posting.
        Returns:
        id of next posting, or EOL if end of posting list.
        Throws:
        java.io.IOException

      • close

        public void close()
           throws java.io.IOException
        Throws:
        java.io.IOException