org.apache.lucene.codecs
Class PerDocProducer

java.lang.Object
  org.apache.lucene.codecs.PerDocProducer

All Implemented Interfaces:

Closeable

Direct Known Subclasses:

PerDocProducerBase

public abstract class PerDocProducer
extends Object
implements Closeable

Abstract API that provides access to one or more per-document storage features. The concrete implementations provide access to the underlying storage on a per-document basis corresponding to their actual PerDocConsumer counterpart.

The PerDocProducer API is accessible through the PostingsFormat - API providing per field consumers and producers for inverted data (terms, postings) as well as per-document data.

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

Constructor Summary

protected

PerDocProducer() Sole constructor.

Method Summary

abstract void	close()
abstract DocValues	docValues(String field) Returns DocValues for the current field.

Methods inherited from class java.lang.Object

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

Constructor Detail

PerDocProducer

protected PerDocProducer()

Sole constructor. (For invocation by subclass constructors, typically implicit.)

Method Detail

docValues

public abstract DocValues docValues(String field)
                             throws IOException

Returns DocValues for the current field.

Parameters:

field - the field name

Returns:

the DocValues for this field or null if not applicable.

Throws:

IOException - If an I/O error occurs

close

public abstract void close()
                    throws IOException

Specified by:

close in interface Closeable

Throws:

IOException