Module org.apache.lucene.sandbox
Package org.apache.lucene.sandbox.facet.cutters.ranges

Interface IntervalTracker

All Superinterfaces:
OrdinalIterator
All Known Implementing Classes:
IntervalTracker.MultiIntervalTracker
interface IntervalTracker extends OrdinalIterator
A specialised ordinal iterator that supports write (set and clear) operations. Clients can write data and freeze the state before reading data from it like any other OrdinalIterator. Instances may be reused by clearing the current iterator E.g. LongRangeFacetCutter uses IntervalTracker instances to map ranges to ordinals and track per-range data and retrieve recorded ranges for a data set.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    IntervalTracker.MultiIntervalTracker
    Interval Tracker that tracks data for multiple intervals.

  • Field Summary

    Fields inherited from interface org.apache.lucene.sandbox.facet.iterators.OrdinalIterator

    EMPTY, NO_MORE_ORDS

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clear()
    clear recorded information on this tracker.
    void
    freeze()
    finalise any state before read operations can be performed on this OrdinalIterator
    boolean
    get(int index)
    check if any data for the interval has been recorded *
    void
    set(int i)
    track information for the seen input interval *

    Methods inherited from interface org.apache.lucene.sandbox.facet.iterators.OrdinalIterator

    nextOrd, toArray

  • Method Details

    • set

      void set(int i)
      track information for the seen input interval *

    • clear

      void clear()
      clear recorded information on this tracker. *

    • get

      boolean get(int index)
      check if any data for the interval has been recorded *

    • freeze

      void freeze()
      finalise any state before read operations can be performed on this OrdinalIterator