Package io.deephaven.engine.table.impl.sources.immutable

Class ImmutableConstantNanosBasedTimeSource<TIME_TYPE>

java.lang.Object
io.deephaven.engine.table.impl.AbstractColumnSource<TIME_TYPE>
io.deephaven.engine.table.impl.sources.immutable.ImmutableConstantNanosBasedTimeSource<TIME_TYPE>
All Implemented Interfaces:
ChunkSource<Values>, ChunkSource.WithPrev<Values>, ColumnSource<TIME_TYPE>, ElementSource<TIME_TYPE>, FillContextMaker, GetContextMaker, DefaultChunkSource<Values>, DefaultChunkSource.WithPrev<Values>, PushdownFilterMatcher, ConvertibleTimeSource, FillUnordered<Values>, InMemoryColumnSource, RowKeyAgnosticChunkSource<Values>, Releasable, TupleExporter<TIME_TYPE>, TupleSource<TIME_TYPE>
Direct Known Subclasses:
ImmutableConstantInstantSource, ImmutableConstantZonedDateTimeSource
public abstract class ImmutableConstantNanosBasedTimeSource<TIME_TYPE> extends AbstractColumnSource<TIME_TYPE> implements InMemoryColumnSource, RowKeyAgnosticChunkSource<Values>, ConvertibleTimeSource

  • Field Details

  • Constructor Details

  • Method Details

    • makeValue

      protected abstract TIME_TYPE makeValue(long nanos)

    • toNanos

      protected abstract long toNanos(TIME_TYPE value)

    • get

      public TIME_TYPE get(long rowKey)
      Description copied from interface: ElementSource
      Get the value from the source. This may return boxed values for basic types. RowKeys that are not present are undefined.
      Specified by:
      get in interface ElementSource<TIME_TYPE>
      Parameters:
      rowKey - the location in key space to get the value from.
      Returns:
      the value at the rowKey, potentially null.

    • getPrev

      public TIME_TYPE getPrev(long rowKey)
      Description copied from interface: ElementSource
      Get the previous value at the rowKey. Previous values are used during an UG update cycle to process changes in data. During normal operation previous values will be identical to current values. RowKeys that were not present are undefined.
      Specified by:
      getPrev in interface ElementSource<TIME_TYPE>
      Parameters:
      rowKey - the location in key space to get the value from.
      Returns:
      the previous value at the rowKey, potentially null.

    • getLong

      public long getLong(long rowKey)
      Description copied from interface: ElementSource
      Get the value at the rowKey as a long. RowKeys that are not present are undefined.
      Specified by:
      getLong in interface ElementSource<TIME_TYPE>
      Parameters:
      rowKey - the location in key space to get the value from.
      Returns:
      the long at the rowKey, null values are represented by QueryConstants.NULL_LONG

    • getPrevLong

      public long getPrevLong(long rowKey)
      Description copied from interface: ElementSource
      Get the previous value at the rowKey as a long. See ElementSource.getPrev(long) for more details.
      Specified by:
      getPrevLong in interface ElementSource<TIME_TYPE>
      Parameters:
      rowKey - the location in key space to get the previous value from.
      Returns:
      the previous long at the rowKey, null values are represented by QueryConstants.NULL_LONG

    • fillChunk

      public final void fillChunk(@NotNull @NotNull ChunkSource.FillContext context, @NotNull @NotNull WritableChunk<? super Values> destination, @NotNull @NotNull RowSequence rowSequence)
      Description copied from interface: ChunkSource
      Populates the given destination chunk with data corresponding to the keys from the given RowSequence.
      Specified by:
      fillChunk in interface ChunkSource<TIME_TYPE>
      Overrides:
      fillChunk in class AbstractColumnSource<TIME_TYPE>
      Parameters:
      context - A context containing all mutable/state related data used in retrieving the Chunk.
      destination - The chunk to be populated according to rowSequence. No assumptions shall be made about the size of the chunk shall be made. The chunk will be populated from position [0,rowSequence.size()).
      rowSequence - An RowSequence representing the keys to be fetched

    • fillPrevChunk

      public final void fillPrevChunk(@NotNull @NotNull ChunkSource.FillContext context, @NotNull @NotNull WritableChunk<? super Values> destination, @NotNull @NotNull RowSequence rowSequence)
      Description copied from interface: ChunkSource.WithPrev
      Populates the given destination chunk with data corresponding to the keys from the given RowSequence.
      Specified by:
      fillPrevChunk in interface ChunkSource.WithPrev<TIME_TYPE>
      Overrides:
      fillPrevChunk in class AbstractColumnSource<TIME_TYPE>
      Parameters:
      context - A context containing all mutable/state related data used in retrieving the Chunk.
      destination - The chunk to be populated according to rowSequence. No assumptions shall be made about the size of the chunk shall be made. The chunk will be populated from position [0,rowSequence.size()).
      rowSequence - An RowSequence representing the keys to be fetched

    • fillChunkUnordered

      public void fillChunkUnordered(@NotNull @NotNull ChunkSource.FillContext context, @NotNull @NotNull WritableChunk<? super Values> dest, @NotNull @NotNull LongChunk<? extends RowKeys> keys)
      Description copied from interface: FillUnordered
      Populates a contiguous portion of the given destination chunk with data corresponding to the keys from the given LongChunk.

      It behaves as if the following code were executed: 

       destination.setSize(keys.size());
 for (int ii = 0; ii < keys.size(); ++ii) {
     destination.set(ii, get(keys.get(ii)));
 }
      Specified by:
      fillChunkUnordered in interface FillUnordered<TIME_TYPE>
      Parameters:
      context - A context containing all mutable/state related data used in retrieving the Chunk.
      dest - The chunk to be populated according to keys
      keys - A chunk of individual, not assumed to be ordered keys to be fetched

    • fillPrevChunkUnordered

      public void fillPrevChunkUnordered(@NotNull @NotNull ChunkSource.FillContext context, @NotNull @NotNull WritableChunk<? super Values> dest, @NotNull @NotNull LongChunk<? extends RowKeys> keys)
      Description copied from interface: FillUnordered
      Populates a contiguous portion of the given destination chunk with prev data corresponding to the keys from the given LongChunk.

      It behaves as if the following code were executed: 

       destination.setSize(keys.size());
 for (int ii = 0; ii < keys.size(); ++ii) {
     destination.set(ii, getPrev(keys.get(ii)));
 }
      Specified by:
      fillPrevChunkUnordered in interface FillUnordered<TIME_TYPE>
      Parameters:
      context - A context containing all mutable/state related data used in retrieving the Chunk.
      dest - The chunk to be populated according to keys
      keys - A chunk of individual, not assumed to be ordered keys to be fetched

    • providesFillUnordered

      public boolean providesFillUnordered()
      Description copied from interface: FillUnordered
      Returns true if this column source can efficiently provide an unordered fill. If this method returns false, then fillChunkUnordered and fillPrevChunkUnordered may throw an UnsupportedOperationException.
      Specified by:
      providesFillUnordered in interface FillUnordered<TIME_TYPE>
      Returns:
      if this column source can provide an unordered fill

    • allowsReinterpret

      public <ALTERNATE_DATA_TYPE> boolean allowsReinterpret(@NotNull @NotNull Class<ALTERNATE_DATA_TYPE> alternateDataType)
      Description copied from interface: ColumnSource
      Test if a reinterpret call will succeed.
      Specified by:
      allowsReinterpret in interface ColumnSource<TIME_TYPE>
      Overrides:
      allowsReinterpret in class AbstractColumnSource<TIME_TYPE>
      Parameters:
      alternateDataType - The alternative type to consider
      Returns:
      If a reinterpret on this column source with the supplied alternateDataType will succeed.

    • doReinterpret

      protected <ALTERNATE_DATA_TYPE> ColumnSource<ALTERNATE_DATA_TYPE> doReinterpret(@NotNull @NotNull Class<ALTERNATE_DATA_TYPE> alternateDataType)
      Description copied from class: AbstractColumnSource
      Supply allowed reinterpret results. The default implementation handles the most common case to avoid code duplication.
      Overrides:
      doReinterpret in class AbstractColumnSource<TIME_TYPE>
      Parameters:
      alternateDataType - The alternate data type
      Returns:
      The resulting ColumnSource

    • supportsTimeConversion

      public boolean supportsTimeConversion()
      Description copied from interface: ConvertibleTimeSource
      Check if this class supports time conversion. If false, all other methods will fail.
      Specified by:
      supportsTimeConversion in interface ConvertibleTimeSource
      Returns:
      true if time conversion is supported.

    • toZonedDateTime

      public ColumnSource<ZonedDateTime> toZonedDateTime(@NotNull @NotNull ZoneId zone)
      Description copied from interface: ConvertibleTimeSource
      Convert this source to a ZonedDateTime source at the specified zone.
      Specified by:
      toZonedDateTime in interface ConvertibleTimeSource
      Parameters:
      zone - the time zone
      Returns:
      a view of this source as a ZonedDateTime

    • toLocalDate

      public ColumnSource<LocalDate> toLocalDate(@NotNull @NotNull ZoneId zone)
      Description copied from interface: ConvertibleTimeSource
      Convert this source to a LocalDate source at the specified zone.
      Specified by:
      toLocalDate in interface ConvertibleTimeSource
      Parameters:
      zone - the time zone
      Returns:
      a view of this source as a LocalDate

    • toLocalTime

      public ColumnSource<LocalTime> toLocalTime(@NotNull @NotNull ZoneId zone)
      Description copied from interface: ConvertibleTimeSource
      Convert this source to a LocalTime source at the specified zone.
      Specified by:
      toLocalTime in interface ConvertibleTimeSource
      Parameters:
      zone - the time zone
      Returns:
      a view of this source as a LocalTime

    • toInstant

      public ColumnSource<Instant> toInstant()
      Description copied from interface: ConvertibleTimeSource
      Convert this source to an Instant source.
      Specified by:
      toInstant in interface ConvertibleTimeSource
      Returns:
      a view of this source asan Instant

    • toEpochNano

      public ColumnSource<Long> toEpochNano()
      Description copied from interface: ConvertibleTimeSource
      Convert this source to a long source of nanoseconds of epoch.
      Specified by:
      toEpochNano in interface ConvertibleTimeSource
      Returns:
      a view of this source as a ZonedDateTime

    • estimatePushdownFilterCost

      public void estimatePushdownFilterCost(WhereFilter filter, RowSet selection, boolean usePrev, PushdownFilterContext context, JobScheduler jobScheduler, LongConsumer onComplete, Consumer<Exception> onError)
      Description copied from interface: PushdownFilterMatcher
      Estimate the cost of pushing down the next pushdown filter. This returns a unitless value to compare the cost of executing different filters. Common costs are listed in PushdownResult (such as PushdownResult.METADATA_STATS_COST) and should be used as a baseline for estimating the cost of newly implemented pushdown operations.

      A no-op implementation should simply complete with Long.MAX_VALUE.

      Specified by:
      estimatePushdownFilterCost in interface PushdownFilterMatcher
      Overrides:
      estimatePushdownFilterCost in class AbstractColumnSource<TIME_TYPE>
      Parameters:
      filter - The filter to test.
      selection - The set of rows to tests.
      usePrev - Whether to use the previous result
      context - The PushdownFilterContext to use for the pushdown operation.
      jobScheduler - The job scheduler to use for scheduling child jobs
      onComplete - Consumer of the estimated cost of the pushdown operation. 9223372036854775807L indicates that the filter cannot be pushed down.
      onError - Consumer of any exceptions that occur during the estimate operation

    • pushdownFilter

      public void pushdownFilter(WhereFilter filter, RowSet selection, boolean usePrev, PushdownFilterContext context, long costCeiling, JobScheduler jobScheduler, Consumer<PushdownResult> onComplete, Consumer<Exception> onError)
      Description copied from interface: PushdownFilterMatcher
      Push down the given filter to the underlying table and pass the result to the consumer. This method is expected to execute all pushdown filter steps that are greater than PushdownFilterContext.executedFilterCost() and less than or equal to costCeiling.

      The resulting PushdownResult (to onComplete) must only contain rows from selection. The match row set are rows that are guaranteed to match. The implicitly "missing" rows selection - match - maybeMatch are rows that are guaranteed to not match. The remaining maybe match row set are rows that may, or may not, match. The pushdown result ownership passes to onComplete.

      A no-op implementation should simply complete with PushdownResult.maybeMatch(selection).

      Specified by:
      pushdownFilter in interface PushdownFilterMatcher
      Overrides:
      pushdownFilter in class AbstractColumnSource<TIME_TYPE>
      Parameters:
      filter - The filter to apply.
      selection - The set of rows to test.
      usePrev - Whether to use the previous result
      context - The PushdownFilterContext to use for the pushdown operation.
      costCeiling - Execute all possible filters with a cost less than or equal this value.
      jobScheduler - The job scheduler to use for scheduling child jobs
      onComplete - Consumer of the output rowsets for added and modified rows that pass the filter
      onError - Consumer of any exceptions that occur during the pushdown operation