org.apache.lucene.codecs.compressing
Class CompressingStoredFieldsWriter

java.lang.Object
  extended by org.apache.lucene.codecs.StoredFieldsWriter
      extended by org.apache.lucene.codecs.compressing.CompressingStoredFieldsWriter
All Implemented Interfaces:
Closeable

public final class CompressingStoredFieldsWriter
extends StoredFieldsWriter

StoredFieldsWriter impl for CompressingStoredFieldsFormat.

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

Constructor Summary
CompressingStoredFieldsWriter(Directory directory, SegmentInfo si, String segmentSuffix, IOContext context, String formatName, CompressionMode compressionMode, int chunkSize)
          Sole constructor.
 
Method Summary
 void abort()
          Aborts writing entirely, implementation should remove any partially-written files, etc.
 void close()
           
 void finish(FieldInfos fis, int numDocs)
          Called before StoredFieldsWriter.close(), passing in the number of documents that were written.
 void finishDocument()
          Called when a document and all its fields have been added.
 int merge(MergeState mergeState)
          Merges in the stored fields from the readers in mergeState.
 void startDocument(int numStoredFields)
          Called before writing the stored fields of the document.
 void writeField(FieldInfo info, IndexableField field)
          Writes a single stored field.
 
Methods inherited from class org.apache.lucene.codecs.StoredFieldsWriter
addDocument
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CompressingStoredFieldsWriter

public CompressingStoredFieldsWriter(Directory directory,
                                     SegmentInfo si,
                                     String segmentSuffix,
                                     IOContext context,
                                     String formatName,
                                     CompressionMode compressionMode,
                                     int chunkSize)
                              throws IOException
Sole constructor.

Throws:
IOException
Method Detail

close

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

startDocument

public void startDocument(int numStoredFields)
                   throws IOException
Description copied from class: StoredFieldsWriter
Called before writing the stored fields of the document. StoredFieldsWriter.writeField(FieldInfo, IndexableField) will be called numStoredFields times. Note that this is called even if the document has no stored fields, in this case numStoredFields will be zero.

Specified by:
startDocument in class StoredFieldsWriter
Throws:
IOException

finishDocument

public void finishDocument()
                    throws IOException
Description copied from class: StoredFieldsWriter
Called when a document and all its fields have been added.

Overrides:
finishDocument in class StoredFieldsWriter
Throws:
IOException

writeField

public void writeField(FieldInfo info,
                       IndexableField field)
                throws IOException
Description copied from class: StoredFieldsWriter
Writes a single stored field.

Specified by:
writeField in class StoredFieldsWriter
Throws:
IOException

abort

public void abort()
Description copied from class: StoredFieldsWriter
Aborts writing entirely, implementation should remove any partially-written files, etc.

Specified by:
abort in class StoredFieldsWriter

finish

public void finish(FieldInfos fis,
                   int numDocs)
            throws IOException
Description copied from class: StoredFieldsWriter
Called before StoredFieldsWriter.close(), passing in the number of documents that were written. Note that this is intentionally redundant (equivalent to the number of calls to StoredFieldsWriter.startDocument(int), but a Codec should check that this is the case to detect the JRE bug described in LUCENE-1282.

Specified by:
finish in class StoredFieldsWriter
Throws:
IOException

merge

public int merge(MergeState mergeState)
          throws IOException
Description copied from class: StoredFieldsWriter
Merges in the stored fields from the readers in mergeState. The default implementation skips over deleted documents, and uses StoredFieldsWriter.startDocument(int), StoredFieldsWriter.writeField(FieldInfo, IndexableField), and StoredFieldsWriter.finish(FieldInfos, int), returning the number of documents that were written. Implementations can override this method for more sophisticated merging (bulk-byte copying, etc).

Overrides:
merge in class StoredFieldsWriter
Throws:
IOException


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