Package org.apache.druid.segment

Class FilteredOffset

java.lang.Object

org.apache.druid.segment.data.Offset

org.apache.druid.segment.FilteredOffset

All Implemented Interfaces:

Cloneable, HotLoopCallee, ReadableOffset

public final class FilteredOffset
extends Offset

Method Summary

Modifier and Type	Method	Description
Offset	clone()	clone() is not supported by FilteredOffset because it's not possible to clone filterMatcher, and while re-creating filterMatcher could be not very cheap for some implementations of Filter.
ReadableOffset	getBaseReadableOffset()	Returns the same offset ("this") or a readable "view" of this offset, which always returns the same value from ReadableOffset.getOffset(), as this offset.
int	getOffset()
void	increment()
void	inspectRuntimeShape(RuntimeShapeInspector inspector)	Implementations of this method should call inspector.visit() with all fields of this class, which meet two conditions: 1.
void	reset()	Resets the Offset to the position it was created or cloned with.
boolean	withinBounds()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

increment

public void increment()

Specified by:

increment in class Offset

withinBounds

public boolean withinBounds()

Specified by:

withinBounds in class Offset

reset

public void reset()

Description copied from class: Offset

Resets the Offset to the position it was created or cloned with.

Specified by:

reset in class Offset

getBaseReadableOffset

public ReadableOffset getBaseReadableOffset()

Description copied from class: Offset

Returns the same offset ("this") or a readable "view" of this offset, which always returns the same value from ReadableOffset.getOffset(), as this offset. This method is useful for "unwrapping" such offsets as FilteredOffset and reduce reference indirection, when only ReadableOffset API is needed.

Specified by:

getBaseReadableOffset in class Offset

clone

public Offset clone()

clone() is not supported by FilteredOffset because it's not possible to clone filterMatcher, and while re-creating filterMatcher could be not very cheap for some implementations of Filter. Although this approach could be investigated. If clone is made possible for FilteredOffset, some improvements could become possible in PooledTopNAlgorithm.computeSpecializedScanAndAggregateImplementations(). See also https://github.com/apache/druid/issues/5132.

Overrides:

clone in class Offset

getOffset

public int getOffset()

inspectRuntimeShape

public void inspectRuntimeShape(RuntimeShapeInspector inspector)

Description copied from interface: HotLoopCallee

Implementations of this method should call inspector.visit() with all fields of this class, which meet two conditions: 1. They are used in methods of this class, annotated with CalledFromHotLoop 2. They are either: a. Nullable objects b. Instances of HotLoopCallee c. Objects, which don't always have a specific class in runtime. For example, a field of type Set could be HashSet or TreeSet in runtime, depending on how this instance (the instance on which inspectRuntimeShape() is called) is configured. d. ByteBuffer or similar objects, where byte order matters e. boolean flags, affecting branch taking f. Arrays of objects, meeting any of conditions a-e.