org.apache.lucene.codecs.lucene40
Class Lucene40DocValuesConsumer

java.lang.Object
  org.apache.lucene.codecs.PerDocConsumer
      org.apache.lucene.codecs.lucene40.values.DocValuesWriterBase
          org.apache.lucene.codecs.lucene40.Lucene40DocValuesConsumer

All Implemented Interfaces:

Closeable

Direct Known Subclasses:

Lucene40NormsFormat.Lucene40NormsDocValuesConsumer

public class Lucene40DocValuesConsumer
extends DocValuesWriterBase

Lucene 4.0 PerDocConsumer implementation that uses compound file.

See Also:

Lucene40DocValuesFormat

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

Field Summary

static String

DOC_VALUES_SEGMENT_SUFFIX Segment suffix used when writing doc values index files.

Fields inherited from class org.apache.lucene.codecs.lucene40.values.DocValuesWriterBase

context, DATA_EXTENSION, INDEX_EXTENSION, segmentName

Constructor Summary

Lucene40DocValuesConsumer(PerDocWriteState state, String segmentSuffix)
Sole constructor.

Method Summary

void	abort() Called during indexing if the indexing session is aborted due to a unrecoverable exception.
void	close()
protected Directory	getDirectory() Returns the Directory that files should be written to.

Methods inherited from class org.apache.lucene.codecs.lucene40.values.DocValuesWriterBase

addValuesField, getComparator

Methods inherited from class org.apache.lucene.codecs.PerDocConsumer

canMerge, getDocValuesForMerge, getDocValuesType, merge

Methods inherited from class java.lang.Object

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

Field Detail

DOC_VALUES_SEGMENT_SUFFIX

public static final String DOC_VALUES_SEGMENT_SUFFIX

Segment suffix used when writing doc values index files.

See Also:

Constant Field Values

Constructor Detail

Lucene40DocValuesConsumer

public Lucene40DocValuesConsumer(PerDocWriteState state,
                                 String segmentSuffix)

Sole constructor.

Method Detail

getDirectory

protected Directory getDirectory()
                          throws IOException

Description copied from class: DocValuesWriterBase

Returns the Directory that files should be written to.

Specified by:

getDirectory in class DocValuesWriterBase

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Overrides:

close in class DocValuesWriterBase

Throws:

IOException

abort

public void abort()

Description copied from class: PerDocConsumer

Called during indexing if the indexing session is aborted due to a unrecoverable exception. This method should cleanup all resources.

Specified by:

abort in class PerDocConsumer