Overview | Package | Class | Use | Tree | Deprecated | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.lucene.codecs.blockterms
Class FixedGapTermsIndexWriter

    java.lang.Object
      org.apache.lucene.codecs.blockterms.TermsIndexWriterBase
          org.apache.lucene.codecs.blockterms.FixedGapTermsIndexWriter

All Implemented Interfaces:
  Closeable

    public class FixedGapTermsIndexWriter

extends TermsIndexWriterBase

Selects every Nth term as and index term, and hold term bytes (mostly) fully expanded in memory. This terms index supports seeking by ord. See `VariableGapTermsIndexWriter` for a more memory efficient terms index that does not support seeking by ord.

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

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.codecs.blockterms.TermsIndexWriterBase
`TermsIndexWriterBase.FieldWriter`

Field Summary
`protected IndexOutput` | `out`

Constructor Summary
`FixedGapTermsIndexWriter(SegmentWriteState state)`

Method Summary
`TermsIndexWriterBase.FieldWriter` | `addField(FieldInfo field, long termsFilePointer)`
`void` | `close()`
`protected int` | `indexedTermPrefixLength(BytesRef priorTerm, BytesRef indexedTerm)` NOTE: if your codec does not sort in unicode code point order, you must override this method, to simply return indexedTerm.length.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### out

    protected final IndexOutput out

Constructor Detail

### FixedGapTermsIndexWriter

    public FixedGapTermsIndexWriter(SegmentWriteState state)
                             throws IOException

Throws:
  `IOException`

Method Detail

### addField

    public TermsIndexWriterBase.FieldWriter addField(FieldInfo field,
                                                     long termsFilePointer)

  Specified by:
    `addField` in class `TermsIndexWriterBase`

### indexedTermPrefixLength

    protected int indexedTermPrefixLength(BytesRef priorTerm,
                                          BytesRef indexedTerm)

  NOTE: if your codec does not sort in unicode code point order, you must override this method, to simply return indexedTerm.length.

### close

    public void close()
               throws IOException

  Throws:
    `IOException`

Overview | Package | Class | Use | Tree | Deprecated | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

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