org.apache.lucene.index
Class MultiFieldsEnum

java.lang.Object
  extended by org.apache.lucene.index.FieldsEnum
      extended by org.apache.lucene.index.MultiFieldsEnum

public final class MultiFieldsEnum
extends FieldsEnum

Exposes flex API, merged from flex API of sub-segments. This does a merge sort, by field name, of the sub-readers.

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

Nested Class Summary
static class MultiFieldsEnum.FieldsEnumWithSlice
           
 
Field Summary
 
Fields inherited from class org.apache.lucene.index.FieldsEnum
EMPTY, EMPTY_ARRAY
 
Constructor Summary
MultiFieldsEnum(MultiFields fields, FieldsEnum[] subs, ReaderSlice[] subSlices)
          The subs array must be newly initialized FieldsEnum (ie, FieldsEnum.next() has not been called.
 
Method Summary
 String next()
          Increments the enumeration to the next field.
 Terms terms()
          Get Terms for the current field.
 
Methods inherited from class org.apache.lucene.index.FieldsEnum
attributes
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MultiFieldsEnum

public MultiFieldsEnum(MultiFields fields,
                       FieldsEnum[] subs,
                       ReaderSlice[] subSlices)
                throws IOException
The subs array must be newly initialized FieldsEnum (ie, FieldsEnum.next() has not been called.

Throws:
IOException
Method Detail

next

public String next()
            throws IOException
Description copied from class: FieldsEnum
Increments the enumeration to the next field. Returns null when there are no more fields.

Specified by:
next in class FieldsEnum
Throws:
IOException

terms

public Terms terms()
            throws IOException
Description copied from class: FieldsEnum
Get Terms for the current field. After FieldsEnum.next() returns null this method should not be called. This method may return null in some cases, which means the provided field does not have any terms.

Specified by:
terms in class FieldsEnum
Throws:
IOException


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