org.apache.lucene.index
Class MultiDocValues

java.lang.Object
  extended by org.apache.lucene.index.DocValues
      extended by org.apache.lucene.index.MultiDocValues
All Implemented Interfaces:
Closeable

public class MultiDocValues
extends DocValues

A wrapper for CompositeIndexReader providing access to per segment DocValues

NOTE: for multi readers, you'll get better performance by gathering the sub readers using IndexReader.getTopReaderContext() to get the atomic leaves and then operate per-AtomicReader, instead of using this class.

WARNING: This API is experimental and might change in incompatible ways in the next release.
NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

Nested Class Summary
static class MultiDocValues.DocValuesSlice
           
static class MultiDocValues.EmptyDocValues
           
static class MultiDocValues.EmptyFixedDocValues
           
 
Nested classes/interfaces inherited from class org.apache.lucene.index.DocValues
DocValues.SortedSource, DocValues.Source, DocValues.SourceCache, DocValues.Type
 
Field Summary
 
Fields inherited from class org.apache.lucene.index.DocValues
EMPTY_ARRAY
 
Method Summary
 DocValues.Source getDirectSource()
          Returns a disk resident DocValues.Source instance.
static DocValues getDocValues(IndexReader r, String field)
          Returns a single DocValues instance for this field, merging their values on the fly.
static DocValues getNormDocValues(IndexReader r, String field)
          Returns a single DocValues instance for this norms field, merging their values on the fly.
 DocValues.Type getType()
          Returns the DocValues.Type of this DocValues instance
 int getValueSize()
          Returns the size per value in bytes or -1 iff size per value is variable.
 DocValues.Source load()
          Loads a new DocValues.Source instance for this DocValues field instance.
 
Methods inherited from class org.apache.lucene.index.DocValues
close, getDefaultSortedSource, getDefaultSource, getSource, setCache
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getDocValues

public static DocValues getDocValues(IndexReader r,
                                     String field)
                              throws IOException
Returns a single DocValues instance for this field, merging their values on the fly.

NOTE: this is a slow way to access DocValues. It's better to get the sub-readers and iterate through them yourself.

Throws:
IOException

getNormDocValues

public static DocValues getNormDocValues(IndexReader r,
                                         String field)
                                  throws IOException
Returns a single DocValues instance for this norms field, merging their values on the fly.

NOTE: this is a slow way to access DocValues. It's better to get the sub-readers and iterate through them yourself.

Throws:
IOException

load

public DocValues.Source load()
                      throws IOException
Description copied from class: DocValues
Loads a new DocValues.Source instance for this DocValues field instance. Source instances returned from this method are not cached. It is the callers responsibility to maintain the instance and release its resources once the source is not needed anymore.

For managed DocValues.Source instances see DocValues.getSource().

Specified by:
load in class DocValues
Throws:
IOException
See Also:
DocValues.getSource(), DocValues.setCache(SourceCache)

getType

public DocValues.Type getType()
Description copied from class: DocValues
Returns the DocValues.Type of this DocValues instance

Specified by:
getType in class DocValues

getValueSize

public int getValueSize()
Description copied from class: DocValues
Returns the size per value in bytes or -1 iff size per value is variable.

Overrides:
getValueSize in class DocValues
Returns:
the size per value in bytes or -1 iff size per value is variable.

getDirectSource

public DocValues.Source getDirectSource()
                                 throws IOException
Description copied from class: DocValues
Returns a disk resident DocValues.Source instance. Direct Sources are not cached in the DocValues.SourceCache and should not be shared between threads.

Specified by:
getDirectSource in class DocValues
Throws:
IOException


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