Field Detail

• DEFAULT_MIN_BLOCK_SIZE

  public static final int DEFAULT_MIN_BLOCK_SIZE

  Suggested default value for the minItemsInBlock parameter to OrdsBlockTreeTermsWriter(SegmentWriteState,PostingsWriterBase,int,int).

  See Also:

  Constant Field Values

• DEFAULT_MAX_BLOCK_SIZE

  public static final int DEFAULT_MAX_BLOCK_SIZE

  Suggested default value for the maxItemsInBlock parameter to OrdsBlockTreeTermsWriter(SegmentWriteState,PostingsWriterBase,int,int).

  See Also:

  Constant Field Values

• VERSION_START

  public static final int VERSION_START

  Initial terms format.

  See Also:

  Constant Field Values

• VERSION_CURRENT

  public static final int VERSION_CURRENT

  Current terms format.

  See Also:

  Constant Field Values

Constructor Detail

• OrdsBlockTreeTermsWriter

  public OrdsBlockTreeTermsWriter(SegmentWriteState state,
                                  PostingsWriterBase postingsWriter,
                                  int minItemsInBlock,
                                  int maxItemsInBlock)
                           throws IOException

  Create a new writer. The number of items (terms or sub-blocks) per block will aim to be between minItemsPerBlock and maxItemsPerBlock, though in some cases the blocks may be smaller than the min.

  Throws:

  IOException

Method Detail

• write

  public void write(Fields fields)
             throws IOException

  Description copied from class: FieldsConsumer
  Write all fields, terms and postings. This the "pull" API, allowing you to iterate more than once over the postings, somewhat analogous to using a DOM API to traverse an XML tree.

  Notes:

  • You must compute index statistics, including each Term's docFreq and totalTermFreq, as well as the summary sumTotalTermFreq, sumTotalDocFreq and docCount.
  • You must skip terms that have no docs and fields that have no terms, even though the provided Fields API will expose them; this typically requires lazily writing the field or term until you've actually seen the first term or document.
  • The provided Fields instance is limited: you cannot call any methods that return statistics/counts; you cannot pass a non-null live docs when pulling docs/positions enums.

  Specified by:

  write in class FieldsConsumer

  Throws:

  IOException

• close

  public void close()
             throws IOException

  Specified by:

  close in interface Closeable

  Specified by:

  close in interface AutoCloseable

  Specified by:

  close in class FieldsConsumer

  Throws:

  IOException