Record Class LinearDataSlice<T>
- Type Parameters:
T- decoded block payload type, as defined by the structure's descriptor- Record Components:
entries- the blocks and gaps, ascending by index, tiling the time axisdataDelayNs- the shift applied to every entry's time bounds, in nanoseconds;0when the instrument is not delayed or its delay is unknown
Entries tile the time axis: consecutive entries always touch (start[i] =
end[i-1]) and their index ranges are consecutive. Two kinds of entry exist:
LinearDataSlice.Block— one recorded block. Periods with no market activity are still recorded, as a block whose payload says so (e.g. a candle with zero volume), so quiet markets do not produce gaps.LinearDataSlice.Gap— a run of blocks the server does not have at all: a hole between merged recordings, or blocks removed by retention. It carries the missing index range and the time it spans, so a consumer can render or skip it without arithmetic.
A gap is only ever reported between two blocks. Where the recorded data simply ends before the requested range does (the server's finalized edge, or blocks missing at the very start of the range), the slice is shorter rather than ending in a gap — there is no second block to bound the hole in time. An unavailable structure or interval yields an empty slice rather than an error.
Consumers that only want data can use blocks(); those that render the time axis
should walk entries() and switch over the sealed LinearDataSlice.Entry.
Delayed instruments. Bookmap shows a delayed instrument's data shifted forward by its
delay (InstrumentInfo.dataDelay), while the server records it in
the time it happened. Every entry's startTimeNanos/endTimeNanos is already
shifted into the time the chart shows (the same time the request was made in), so it lines up
with live data. What Bookmap cannot shift is the decoded payload: if a block's value carries
absolute timestamps of its own, add dataDelayNs() to them.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final recordOne decoded block placed on the time axis.static interfaceOne entry on the time axis: either a recordedLinearDataSlice.Blockor aLinearDataSlice.Gapof missing blocks.static final recordA run of consecutive blocks the server does not have. -
Constructor Summary
ConstructorsConstructorDescriptionLinearDataSlice(List<LinearDataSlice.Entry<T>> entries) A slice whose entries were not shifted, i.e.LinearDataSlice(List<LinearDataSlice.Entry<T>> entries, long dataDelayNs) Creates an instance of aLinearDataSlicerecord class. -
Method Summary
Modifier and TypeMethodDescriptionblocks()The recorded blocks only, ascending by index.longReturns the value of thedataDelayNsrecord component.static <T> LinearDataSlice<T> empty()entries()Returns the value of theentriesrecord component.final booleanIndicates whether some other object is "equal to" this one.gaps()The holes only, ascending by index.booleanhasGaps()True if at least oneLinearDataSlice.Gapseparates the blocks.final inthashCode()Returns a hash code value for this object.booleanisEmpty()True if there is neither a block nor a gap — nothing recorded intersects the request.final StringtoString()Returns a string representation of this record class.
-
Constructor Details
-
LinearDataSlice
Creates an instance of aLinearDataSlicerecord class.- Parameters:
entries- the value for theentriesrecord componentdataDelayNs- the value for thedataDelayNsrecord component
-
LinearDataSlice
A slice whose entries were not shifted, i.e. of an instrument without a data delay.
-
-
Method Details
-
empty
-
isEmpty
public boolean isEmpty()True if there is neither a block nor a gap — nothing recorded intersects the request. -
hasGaps
public boolean hasGaps()True if at least oneLinearDataSlice.Gapseparates the blocks. -
blocks
The recorded blocks only, ascending by index. Gaps are skipped, so indices may jump. -
gaps
The holes only, ascending by index. -
toString
Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components. -
hashCode
public final int hashCode()Returns a hash code value for this object. The value is derived from the hash code of each of the record components. -
equals
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared withObjects::equals(Object,Object); primitive components are compared with '=='. -
entries
Returns the value of theentriesrecord component.- Returns:
- the value of the
entriesrecord component
-
dataDelayNs
public long dataDelayNs()Returns the value of thedataDelayNsrecord component.- Returns:
- the value of the
dataDelayNsrecord component
-