Home » lucene-3.0.1-src » org.apache » lucene » store » instantiated » [javadoc | source]
org.apache.lucene.store.instantiated
public class: InstantiatedTermPositions [javadoc | source]
java.lang.Object
   org.apache.lucene.store.instantiated.InstantiatedTermDocs
      org.apache.lucene.store.instantiated.InstantiatedTermPositions

All Implemented Interfaces:
    TermPositions, TermDocs

A org.apache.lucene.index.TermPositions navigating an InstantiatedIndexReader .
Fields inherited from org.apache.lucene.store.instantiated.InstantiatedTermDocs:
currentDocumentInformation,  currentTerm
Constructor:
 public InstantiatedTermPositions(InstantiatedIndexReader reader) 
Method from org.apache.lucene.store.instantiated.InstantiatedTermPositions Summary:
getPayload,   getPayloadLength,   isPayloadAvailable,   next,   nextPosition,   skipTo
Methods from org.apache.lucene.store.instantiated.InstantiatedTermDocs:
close,   doc,   freq,   next,   read,   seek,   seek,   skipTo
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.lucene.store.instantiated.InstantiatedTermPositions Detail:
 public byte[] getPayload(byte[] data,
    int offset) throws IOException 
 public int getPayloadLength() 
 public boolean isPayloadAvailable() 
 public boolean next() 
    Moves to the next pair in the enumeration.

    Returns true if there is such a next pair in the enumeration.

 public int nextPosition() 
    Returns next position in the current document. It is an error to call this more than #freq() times without calling #next()

    This is invalid until #next() is called for the first time.

 public boolean skipTo(int target) 
    Skips entries to the first beyond the current whose document number is greater than or equal to target.

    Returns true iff there is such an entry.

    Behaves as if written:

      boolean skipTo(int target) {
        do {
          if (!next())
    	     return false;
        } while (target > doc());
        return true;
      }
    
    Some implementations are considerably more efficient than that.