Index (rbed 0.4.0 API)

A B C D E F H I L M N O P R S T U V W
All Classes and Interfaces|All Packages

A

above(double) - Method in class io.github.romanhaendler.rbed.Expression: True when this value is strictly greater than limit.
above(Expression) - Method in class io.github.romanhaendler.rbed.Expression: True when this value is strictly greater than other.
abs() - Method in class io.github.romanhaendler.rbed.Expression: The absolute value.
advanceTo(long) - Method in class io.github.romanhaendler.rbed.Detector: Tells this Detector that time has passed up to timestamp without new Samples.
after(Rule) - Static method in class io.github.romanhaendler.rbed.Conditions: True once an Event of the given Rule has Ended; see After for narrowing it.
After - Class in io.github.romanhaendler.rbed: True once an Event of the given Rule has Ended, optionally narrowed by After.unless and After.within.
age() - Method in class io.github.romanhaendler.rbed.ChannelExpression: Milliseconds since the latest value, at the current Sample or time advance; undefined before the first value.
aggregate(Channel...) - Method in class io.github.romanhaendler.rbed.Rule: Also keeps Aggregates for these Channels.
aggregates() - Method in record class io.github.romanhaendler.rbed.Event: Returns the value of the aggregates record component.
aggregates(Channel) - Method in record class io.github.romanhaendler.rbed.Event: Aggregates of one Channel; Aggregates.count() is 0 if it had no value.
Aggregates - Record Class in io.github.romanhaendler.rbed: Aggregates of one Channel over an Event.
Aggregates(double, double, double, long, double, double) - Constructor for record class io.github.romanhaendler.rbed.Aggregates: Creates an instance of a Aggregates record class.
and(Condition) - Method in class io.github.romanhaendler.rbed.Condition: True when both are true; false when either is false; otherwise undefined.
averageOverDuration(long) - Method in class io.github.romanhaendler.rbed.ChannelExpression: Mean of the values from the last millis milliseconds, counted back from the latest value; undefined until the values span that long.
averageOverDuration(Duration) - Method in class io.github.romanhaendler.rbed.ChannelExpression: See ChannelExpression.averageOverDuration(long).
averageOverSamples(int) - Method in class io.github.romanhaendler.rbed.ChannelExpression: Mean of the last n values; undefined until n values exist.

B

below(double) - Method in class io.github.romanhaendler.rbed.Expression: True when this value is strictly less than limit.
below(Expression) - Method in class io.github.romanhaendler.rbed.Expression: True when this value is strictly less than other.
between(double, double) - Method in class io.github.romanhaendler.rbed.Expression: True when low <= value <= high.
build() - Method in class io.github.romanhaendler.rbed.Detector.Builder: Builds the Detector and binds every Rule's Conditions and every watched Expression to it.
builder() - Static method in class io.github.romanhaendler.rbed.Detector

C

Channel - Class in io.github.romanhaendler.rbed: A named quantity of a time series, such as "weight".
ChannelExpression - Class in io.github.romanhaendler.rbed: The current value of a Channel, or of a moving average derived from one, plus Expressions over how it developed.
close() - Method in class io.github.romanhaendler.rbed.Detector: Ends running Events as truncated and makes this Detector reject further Samples.
Condition - Class in io.github.romanhaendler.rbed: A statement about the current Sample that is true, false or undefined (for instance while a Channel has no value yet).
Conditions - Class in io.github.romanhaendler.rbed: Static factories for building Conditions; intended for static import.
confirmed() - Method in record class io.github.romanhaendler.rbed.Event: Returns the value of the confirmed record component.
count() - Method in record class io.github.romanhaendler.rbed.Aggregates: Returns the value of the count record component.
count(Rule) - Static method in class io.github.romanhaendler.rbed.Conditions: The number of Events of the given Rule Confirmed since the Detector started, History included; narrow it with EventCount.within(long).

D

detect(Iterable<Sample>) - Method in class io.github.romanhaendler.rbed.Detector: Runs a whole recorded series through this unused Detector and closes it.
Detector - Class in io.github.romanhaendler.rbed: Receives Samples one at a time and evaluates Rules against them, reporting Event lifecycles to an EventListener.
Detector.Builder - Class in io.github.romanhaendler.rbed: Builds a Detector.
detectValues(Iterable<Map<Channel, Double>>) - Method in class io.github.romanhaendler.rbed.Detector: Like Detector.detect(java.lang.Iterable<io.github.romanhaendler.rbed.Sample>), for a regularly sampled series without timestamps.
dividedBy(double) - Method in class io.github.romanhaendler.rbed.Expression: This value divided by c; undefined when c is 0.
dividedBy(Expression) - Method in class io.github.romanhaendler.rbed.Expression: This value divided by other; undefined when other is 0.
droppedValues() - Method in class io.github.romanhaendler.rbed.Detector: The number of entries dropped because a window was full (see Detector.Builder.retentionLimit) since this Detector was built.
duration() - Method in class io.github.romanhaendler.rbed.LatestEvent: The latest Event's duration in milliseconds; for a running Event, up to now.
during(Rule) - Static method in class io.github.romanhaendler.rbed.Conditions: True while an Event of the given Rule is Confirmed and has not Ended.

E

end() - Method in record class io.github.romanhaendler.rbed.Event: Returns the value of the end record component.
endWhen(Condition) - Method in class io.github.romanhaendler.rbed.Rule: An End Condition: once Confirmed, the Event continues until this holds (for its own duration), regardless of when.
equals(Object) - Method in record class io.github.romanhaendler.rbed.Aggregates: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class io.github.romanhaendler.rbed.Channel
equals(Object) - Method in record class io.github.romanhaendler.rbed.Event: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.romanhaendler.rbed.MemoryHorizon: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.romanhaendler.rbed.Sample: Indicates whether some other object is "equal to" this one.
Event - Record Class in io.github.romanhaendler.rbed: An immutable snapshot of a detected occurrence.
Event(String, long, OptionalLong, OptionalLong, boolean, boolean, Map<Channel, Aggregates>) - Constructor for record class io.github.romanhaendler.rbed.Event: Creates an instance of a Event record class.
EventCount - Class in io.github.romanhaendler.rbed: The number of Events of a given Rule that were Confirmed, History included: since the Detector started, or EventCount.within(long) a sliding window.
EventListener - Interface in io.github.romanhaendler.rbed: Receives the lifecycle of Events from a Detector.
Expression - Class in io.github.romanhaendler.rbed: A numeric value derived from the current Sample; undefined while the data it needs is not available.

F

falling() - Method in class io.github.romanhaendler.rbed.ChannelExpression: True when the latest value is less than the previous one.
forDuration(long) - Method in class io.github.romanhaendler.rbed.Rule: The preceding Condition must hold for at least millis milliseconds.
forDuration(Duration) - Method in class io.github.romanhaendler.rbed.Rule: The preceding Condition must hold for at least duration.
forSamples(int) - Method in class io.github.romanhaendler.rbed.Rule: The preceding Condition must hold for at least n consecutive Samples.

H

hashCode() - Method in record class io.github.romanhaendler.rbed.Aggregates: Returns a hash code value for this object.
hashCode() - Method in class io.github.romanhaendler.rbed.Channel
hashCode() - Method in record class io.github.romanhaendler.rbed.Event: Returns a hash code value for this object.
hashCode() - Method in record class io.github.romanhaendler.rbed.MemoryHorizon: Returns a hash code value for this object.
hashCode() - Method in record class io.github.romanhaendler.rbed.Sample: Returns a hash code value for this object.
history(Collection<Event>) - Method in class io.github.romanhaendler.rbed.Detector.Builder: Supplies Events known from before this Detector started (e.g.

I

integral() - Method in record class io.github.romanhaendler.rbed.Aggregates: Returns the value of the integral record component.
io.github.romanhaendler.rbed - module io.github.romanhaendler.rbed: Rule-based event detection in time series.
io.github.romanhaendler.rbed - package io.github.romanhaendler.rbed
is(Rule) - Method in record class io.github.romanhaendler.rbed.Event: Whether this Event was produced by the given Rule, i.e.

L

latest(Rule) - Static method in class io.github.romanhaendler.rbed.Conditions: Values of the most recent Confirmed Event of the given Rule, running or Ended, such as latest(loadLifted).max(weight).
LatestEvent - Class in io.github.romanhaendler.rbed: Values of the most recent Event of a given Rule that was Confirmed, whether still running or Ended: its Aggregates and its duration.
listener(EventListener) - Method in class io.github.romanhaendler.rbed.Detector.Builder

M

max() - Method in record class io.github.romanhaendler.rbed.Aggregates: Returns the value of the max record component.
max(Channel) - Method in class io.github.romanhaendler.rbed.LatestEvent: The maximum of a Channel over the latest Event (so far, if it is running).
maxGap(long) - Method in class io.github.romanhaendler.rbed.Rule: If consecutive Samples are more than millis apart, a Pending Event is Discarded and a Confirmed Event Ends, truncated, at the last Sample before the gap.
maxGap(Duration) - Method in class io.github.romanhaendler.rbed.Rule: See maxGap(long).
mean() - Method in record class io.github.romanhaendler.rbed.Aggregates: Returns the value of the mean record component.
mean(Channel) - Method in class io.github.romanhaendler.rbed.LatestEvent: The mean of a Channel over the latest Event (so far, if it is running).
memoryHorizon() - Method in class io.github.romanhaendler.rbed.Detector: How far back this Detector's configuration makes it look: the longest time window and the largest Sample count used by its Rules and watched Expressions, computed when it was built.
MemoryHorizon - Record Class in io.github.romanhaendler.rbed: The longest time window and the largest Sample count a Detector's Rules and watched Expressions use by configuration (see Detector.memoryHorizon()).
MemoryHorizon(long, int) - Constructor for record class io.github.romanhaendler.rbed.MemoryHorizon: Creates an instance of a MemoryHorizon record class.
millis() - Method in record class io.github.romanhaendler.rbed.MemoryHorizon: Returns the value of the millis record component.
min() - Method in record class io.github.romanhaendler.rbed.Aggregates: Returns the value of the min record component.
min(Channel) - Method in class io.github.romanhaendler.rbed.LatestEvent: The minimum of a Channel over the latest Event (so far, if it is running).
minus(double) - Method in class io.github.romanhaendler.rbed.Expression: This value minus c.
minus(Expression) - Method in class io.github.romanhaendler.rbed.Expression: This value minus other.

N

name() - Method in class io.github.romanhaendler.rbed.Channel
name() - Method in record class io.github.romanhaendler.rbed.Event: Returns the value of the name record component.
name() - Method in class io.github.romanhaendler.rbed.Rule
named(String) - Static method in class io.github.romanhaendler.rbed.Channel: A Channel whose value holds until the next value arrives.
named(String) - Static method in class io.github.romanhaendler.rbed.Rule: A Rule without Conditions yet; its name becomes the name of the Events it produces.
not() - Method in class io.github.romanhaendler.rbed.Condition: Negation; undefined stays undefined.

O

onConfirmed(Event) - Method in interface io.github.romanhaendler.rbed.EventListener: The Conditions held for the required duration; the Event counts as detected.
onDiscarded(Event) - Method in interface io.github.romanhaendler.rbed.EventListener: A Pending Event stopped holding before it was Confirmed.
onEnded(Event) - Method in interface io.github.romanhaendler.rbed.EventListener: A Confirmed Event reached its end.
onPending(Event) - Method in interface io.github.romanhaendler.rbed.EventListener: The Rule's Conditions started holding, but its required duration is not reached yet.
or(Condition) - Method in class io.github.romanhaendler.rbed.Condition: True when either is true; false when both are false; otherwise undefined.

P

plus(double) - Method in class io.github.romanhaendler.rbed.Expression: This value plus c.
plus(Expression) - Method in class io.github.romanhaendler.rbed.Expression: This value plus other.
pulse(String) - Static method in class io.github.romanhaendler.rbed.Channel: A Pulse Channel, such as one reporting deployments: its value exists only in the Sample that carries it.
push(long, Map<Channel, Double>) - Method in class io.github.romanhaendler.rbed.Detector: Processes one Sample.
push(Map<Channel, Double>) - Method in class io.github.romanhaendler.rbed.Detector: Processes one Sample of a regularly sampled series; its timestamp is derived from the sampling rate as round(index * 1000 / hz).

R

rate() - Method in class io.github.romanhaendler.rbed.ChannelExpression: Change per second between the last two values.
replayPoint() - Method in class io.github.romanhaendler.rbed.Detector: The earliest timestamp from which replaying this Detector's input into a fresh Detector (same Rules and options), with the Events that Ended before that timestamp supplied as History, reproduces this Detector exactly: the replay then continues with the same Events, callbacks, values and exceptions as this Detector.
restore(byte[]) - Method in class io.github.romanhaendler.rbed.Detector.Builder: Makes Detector.Builder.build() produce a Detector in the state of a Detector.snapshot() instead of a fresh one, ready for the next Sample.
retainedValues() - Method in class io.github.romanhaendler.rbed.Detector: The number of entries this Detector currently holds: one per Channel a Rule or watched Expression uses, one per value in each moving-average window and one per timestamp kept for count(...).within(...) (timestamps older than the window are dropped at every moment).
retentionLimit(int) - Method in class io.github.romanhaendler.rbed.Detector.Builder: Sets the Retention Limit: the maximum number of entries a single averageOverDuration window keeps (default 1,000,000), and the maximum number of timestamps kept per counted Rule for count(...).within(...).
rising() - Method in class io.github.romanhaendler.rbed.ChannelExpression: True when the latest value is greater than the previous one.
Rule - Class in io.github.romanhaendler.rbed: One or more Conditions combined with timing logic that produces Events named after the Rule.
rules(Rule...) - Method in class io.github.romanhaendler.rbed.Detector.Builder: Adds Rules, evaluated in the order they are added.

S

Sample - Record Class in io.github.romanhaendler.rbed: The values of one or more Channels at a single timestamp, for Detector.detect(java.lang.Iterable<io.github.romanhaendler.rbed.Sample>).
Sample(long, Map<Channel, Double>) - Constructor for record class io.github.romanhaendler.rbed.Sample: Creates an instance of a Sample record class.
samples() - Method in record class io.github.romanhaendler.rbed.MemoryHorizon: Returns the value of the samples record component.
samplingRate(double) - Method in class io.github.romanhaendler.rbed.Detector.Builder: Declares a regularly sampled series of hz Samples per second (at most 1000, the millisecond resolution of timestamps), so Samples are pushed without timestamps.
snapshot() - Method in class io.github.romanhaendler.rbed.Detector: Returns this Detector's complete state at the latest moment processed, as a byte array that Detector.Builder.restore turns back into a Detector.
start() - Method in record class io.github.romanhaendler.rbed.Event: Returns the value of the start record component.

T

times(double) - Method in class io.github.romanhaendler.rbed.Expression: This value times c.
times(Expression) - Method in class io.github.romanhaendler.rbed.Expression: This value times other.
timestamp() - Method in record class io.github.romanhaendler.rbed.Sample: Returns the value of the timestamp record component.
timeWeightedMean() - Method in record class io.github.romanhaendler.rbed.Aggregates: Returns the value of the timeWeightedMean record component.
toString() - Method in record class io.github.romanhaendler.rbed.Aggregates: Returns a string representation of this record class.
toString() - Method in class io.github.romanhaendler.rbed.Condition: How this Condition is written in Java, such as temp.above(80.0) or after(Maintenance).within(7776000000).not(): Channels and Rules by name, constants as double, durations in milliseconds.
toString() - Method in record class io.github.romanhaendler.rbed.Event: Returns a string representation of this record class.
toString() - Method in class io.github.romanhaendler.rbed.Expression: How this Expression is written in Java, such as temp.averageOverSamples(5), temp.minus(5.0) or count(Run).within(60000): a Channel and a Rule by their names, a constant as a double (plus(5) reads plus(5.0)), a duration in milliseconds (also when given as a Duration).
toString() - Method in record class io.github.romanhaendler.rbed.MemoryHorizon: Returns a string representation of this record class.
toString() - Method in class io.github.romanhaendler.rbed.Rule: Everything that defines this Rule's behaviour, written as in Java and in a fixed order, such as Rule.named("Hot").when(temp.above(80.0)).forSamples(3).maxGap(5000).
toString() - Method in record class io.github.romanhaendler.rbed.Sample: Returns a string representation of this record class.
totalDuration(Rule) - Static method in class io.github.romanhaendler.rbed.Conditions: The summed duration in milliseconds of all Events of the given Rule since the Detector started, History included: Ended ones in full, plus a Confirmed running one up to now.
truncatedEnd() - Method in record class io.github.romanhaendler.rbed.Event: Returns the value of the truncatedEnd record component.
truncatedStart() - Method in record class io.github.romanhaendler.rbed.Event: Returns the value of the truncatedStart record component.

U

unless(Rule...) - Method in class io.github.romanhaendler.rbed.After: No Event of any of these Rules may have been Confirmed since the most recent one Ended.

V

value(Expression) - Method in class io.github.romanhaendler.rbed.Detector: The value of a watched Expression at the latest moment processed (Sample or time advance), also after Detector.close().
values() - Method in record class io.github.romanhaendler.rbed.Sample: Returns the value of the values record component.

W

watch(Expression...) - Method in class io.github.romanhaendler.rbed.Detector.Builder: Registers Expressions whose values the built Detector reports through Detector.value(io.github.romanhaendler.rbed.Expression).
when(Condition) - Method in class io.github.romanhaendler.rbed.Rule: The Conditions under which an Event starts and, without an End Condition, continues.
within(long) - Method in class io.github.romanhaendler.rbed.After: The most recent Event must have Ended at most millis before the current Sample.
within(long) - Method in class io.github.romanhaendler.rbed.EventCount: Counts only Events Confirmed at most millis before the current moment.
within(Duration) - Method in class io.github.romanhaendler.rbed.After: See After.within(long).
within(Duration) - Method in class io.github.romanhaendler.rbed.EventCount: See EventCount.within(long).

A B C D E F H I L M N O P R S T U V W
All Classes and Interfaces|All Packages