org.apache.lucene.codecs.lucene45
Class Lucene45DocValuesProducer

java.lang.Object
  extended by org.apache.lucene.codecs.DocValuesProducer
      extended by org.apache.lucene.codecs.lucene45.Lucene45DocValuesProducer
All Implemented Interfaces:
Closeable

public class Lucene45DocValuesProducer
extends DocValuesProducer
implements Closeable

reader for Lucene45DocValuesFormat


Nested Class Summary
protected static class Lucene45DocValuesProducer.BinaryEntry
          metadata entry for a binary docvalues field
protected static class Lucene45DocValuesProducer.NumericEntry
          metadata entry for a numeric docvalues field
 
Nested classes/interfaces inherited from class org.apache.lucene.codecs.DocValuesProducer
DocValuesProducer.SortedDocsWithField, DocValuesProducer.SortedSetDocsWithField
 
Constructor Summary
protected Lucene45DocValuesProducer(SegmentReadState state, String dataCodec, String dataExtension, String metaCodec, String metaExtension)
          expert: instantiates a new reader
 
Method Summary
 void close()
           
protected  MonotonicBlockPackedReader getAddressInstance(IndexInput data, FieldInfo field, Lucene45DocValuesProducer.BinaryEntry bytes)
          returns an address instance for variable-length binary values.
 BinaryDocValues getBinary(FieldInfo field)
          Returns BinaryDocValues for this field.
 Bits getDocsWithField(FieldInfo field)
          Returns a Bits at the size of reader.maxDoc(), with turned on bits for each docid that does have a value for this field.
protected  MonotonicBlockPackedReader getIntervalInstance(IndexInput data, FieldInfo field, Lucene45DocValuesProducer.BinaryEntry bytes)
          returns an address instance for prefix-compressed binary values.
 NumericDocValues getNumeric(FieldInfo field)
          Returns NumericDocValues for this field.
protected  MonotonicBlockPackedReader getOrdIndexInstance(IndexInput data, FieldInfo field, Lucene45DocValuesProducer.NumericEntry entry)
          returns an address instance for sortedset ordinal lists
 SortedDocValues getSorted(FieldInfo field)
          Returns SortedDocValues for this field.
 SortedSetDocValues getSortedSet(FieldInfo field)
          Returns SortedSetDocValues for this field.
 long ramBytesUsed()
          Returns approximate RAM bytes used
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Lucene45DocValuesProducer

protected Lucene45DocValuesProducer(SegmentReadState state,
                                    String dataCodec,
                                    String dataExtension,
                                    String metaCodec,
                                    String metaExtension)
                             throws IOException
expert: instantiates a new reader

Throws:
IOException
Method Detail

getNumeric

public NumericDocValues getNumeric(FieldInfo field)
                            throws IOException
Description copied from class: DocValuesProducer
Returns NumericDocValues for this field. The returned instance need not be thread-safe: it will only be used by a single thread.

Specified by:
getNumeric in class DocValuesProducer
Throws:
IOException

ramBytesUsed

public long ramBytesUsed()
Description copied from class: DocValuesProducer
Returns approximate RAM bytes used

Specified by:
ramBytesUsed in class DocValuesProducer

getBinary

public BinaryDocValues getBinary(FieldInfo field)
                          throws IOException
Description copied from class: DocValuesProducer
Returns BinaryDocValues for this field. The returned instance need not be thread-safe: it will only be used by a single thread.

Specified by:
getBinary in class DocValuesProducer
Throws:
IOException

getAddressInstance

protected MonotonicBlockPackedReader getAddressInstance(IndexInput data,
                                                        FieldInfo field,
                                                        Lucene45DocValuesProducer.BinaryEntry bytes)
                                                 throws IOException
returns an address instance for variable-length binary values.

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

getIntervalInstance

protected MonotonicBlockPackedReader getIntervalInstance(IndexInput data,
                                                         FieldInfo field,
                                                         Lucene45DocValuesProducer.BinaryEntry bytes)
                                                  throws IOException
returns an address instance for prefix-compressed binary values.

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

getSorted

public SortedDocValues getSorted(FieldInfo field)
                          throws IOException
Description copied from class: DocValuesProducer
Returns SortedDocValues for this field. The returned instance need not be thread-safe: it will only be used by a single thread.

Specified by:
getSorted in class DocValuesProducer
Throws:
IOException

getOrdIndexInstance

protected MonotonicBlockPackedReader getOrdIndexInstance(IndexInput data,
                                                         FieldInfo field,
                                                         Lucene45DocValuesProducer.NumericEntry entry)
                                                  throws IOException
returns an address instance for sortedset ordinal lists

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

getSortedSet

public SortedSetDocValues getSortedSet(FieldInfo field)
                                throws IOException
Description copied from class: DocValuesProducer
Returns SortedSetDocValues for this field. The returned instance need not be thread-safe: it will only be used by a single thread.

Specified by:
getSortedSet in class DocValuesProducer
Throws:
IOException

getDocsWithField

public Bits getDocsWithField(FieldInfo field)
                      throws IOException
Description copied from class: DocValuesProducer
Returns a Bits at the size of reader.maxDoc(), with turned on bits for each docid that does have a value for this field. The returned instance need not be thread-safe: it will only be used by a single thread.

Specified by:
getDocsWithField in class DocValuesProducer
Throws:
IOException

close

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


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