org.apache.lucene.codecs.lucene40
Class Lucene40PostingsWriter

java.lang.Object
  extended by org.apache.lucene.codecs.PostingsConsumer
      extended by org.apache.lucene.codecs.PostingsWriterBase
          extended by org.apache.lucene.codecs.lucene40.Lucene40PostingsWriter
All Implemented Interfaces:
Closeable

public final class Lucene40PostingsWriter
extends PostingsWriterBase

Concrete class that writes the 4.0 frq/prx postings format.

See Also:
Lucene40PostingsFormat
WARNING: This API is experimental and might change in incompatible ways in the next release.

Constructor Summary
Lucene40PostingsWriter(SegmentWriteState state)
           
Lucene40PostingsWriter(SegmentWriteState state, int skipInterval)
           
 
Method Summary
 void addPosition(int position, BytesRef payload, int startOffset, int endOffset)
          Add a new position & payload
 void close()
           
 void finishDoc()
          Called when we are done adding positions & payloads for each doc.
 void finishTerm(TermStats stats)
          Called when we are done adding docs to this term
 void flushTermsBlock(int start, int count)
          Flush count terms starting at start "backwards", as a block.
 void setField(FieldInfo fieldInfo)
           
 void start(IndexOutput termsOut)
           
 void startDoc(int docID, int termDocFreq)
          Adds a new doc in this term.
 void startTerm()
           
 
Methods inherited from class org.apache.lucene.codecs.PostingsConsumer
merge
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Lucene40PostingsWriter

public Lucene40PostingsWriter(SegmentWriteState state)
                       throws IOException
Throws:
IOException

Lucene40PostingsWriter

public Lucene40PostingsWriter(SegmentWriteState state,
                              int skipInterval)
                       throws IOException
Throws:
IOException
Method Detail

start

public void start(IndexOutput termsOut)
           throws IOException
Specified by:
start in class PostingsWriterBase
Throws:
IOException

startTerm

public void startTerm()
Specified by:
startTerm in class PostingsWriterBase

setField

public void setField(FieldInfo fieldInfo)
Specified by:
setField in class PostingsWriterBase

startDoc

public void startDoc(int docID,
                     int termDocFreq)
              throws IOException
Adds a new doc in this term. If this returns null then we just skip consuming positions/payloads.

Specified by:
startDoc in class PostingsConsumer
Throws:
IOException

addPosition

public void addPosition(int position,
                        BytesRef payload,
                        int startOffset,
                        int endOffset)
                 throws IOException
Add a new position & payload

Specified by:
addPosition in class PostingsConsumer
Throws:
IOException

finishDoc

public void finishDoc()
Description copied from class: PostingsConsumer
Called when we are done adding positions & payloads for each doc.

Specified by:
finishDoc in class PostingsConsumer

finishTerm

public void finishTerm(TermStats stats)
                throws IOException
Called when we are done adding docs to this term

Specified by:
finishTerm in class PostingsWriterBase
Throws:
IOException

flushTermsBlock

public void flushTermsBlock(int start,
                            int count)
                     throws IOException
Description copied from class: PostingsWriterBase
Flush count terms starting at start "backwards", as a block. start is a negative offset from the end of the terms stack, ie bigger start means further back in the stack.

Specified by:
flushTermsBlock in class PostingsWriterBase
Throws:
IOException

close

public void close()
           throws IOException
Specified by:
close in interface Closeable
Specified by:
close in class PostingsWriterBase
Throws:
IOException


Copyright © 2000-2012 Apache Software Foundation. All Rights Reserved.