org.apache.beam.sdk.transforms.windowing

Interface Trigger.TriggerInfo

All Known Subinterfaces:

Trigger.MergingTriggerInfo

Enclosing class:

Trigger

public static interface Trigger.TriggerInfo

Interface for accessing information about the trigger being executed and other triggers in the same tree.

Method Summary

Modifier and Type	Method and Description
boolean	areAllSubtriggersFinished() Returns true if all the sub-triggers of the current trigger are marked finished.
org.apache.beam.sdk.util.ExecutableTrigger	firstUnfinishedSubTrigger() Returns the first unfinished sub-trigger.
boolean	isFinished() Returns true if the current trigger is marked finished.
boolean	isFinished(int subtriggerIndex) Return true if the given subtrigger is marked finished.
boolean	isMerging() Returns true if the windowing strategy of the current PCollection is a merging WindowFn.
void	resetTree() Clears all keyed state for triggers in the current sub-tree and unsets all the associated finished bits.
void	setFinished(boolean finished) Sets the finished bit for the current trigger.
void	setFinished(boolean finished, int subTriggerIndex) Sets the finished bit for the given sub-trigger.
org.apache.beam.sdk.util.ExecutableTrigger	subTrigger(int subtriggerIndex) Access the executable version of the specified sub-trigger.
Iterable<org.apache.beam.sdk.util.ExecutableTrigger>	subTriggers() Access the executable versions of the sub-triggers of the current trigger.
Iterable<org.apache.beam.sdk.util.ExecutableTrigger>	unfinishedSubTriggers() Returns an iterable over the unfinished sub-triggers of the current trigger.

Method Detail

isMerging

boolean isMerging()

Returns true if the windowing strategy of the current PCollection is a merging WindowFn. If true, the trigger execution needs to keep enough information to support the possibility of Trigger.onMerge(org.apache.beam.sdk.transforms.windowing.Trigger.OnMergeContext) being called. If false, Trigger.onMerge(org.apache.beam.sdk.transforms.windowing.Trigger.OnMergeContext) will never be called.

subTriggers

Iterable<org.apache.beam.sdk.util.ExecutableTrigger> subTriggers()

Access the executable versions of the sub-triggers of the current trigger.

subTrigger

org.apache.beam.sdk.util.ExecutableTrigger subTrigger(int subtriggerIndex)

Access the executable version of the specified sub-trigger.

isFinished

boolean isFinished()

Returns true if the current trigger is marked finished.

isFinished

boolean isFinished(int subtriggerIndex)

Return true if the given subtrigger is marked finished.

areAllSubtriggersFinished

boolean areAllSubtriggersFinished()

Returns true if all the sub-triggers of the current trigger are marked finished.

unfinishedSubTriggers

Iterable<org.apache.beam.sdk.util.ExecutableTrigger> unfinishedSubTriggers()

Returns an iterable over the unfinished sub-triggers of the current trigger.

firstUnfinishedSubTrigger

org.apache.beam.sdk.util.ExecutableTrigger firstUnfinishedSubTrigger()

Returns the first unfinished sub-trigger.

resetTree

void resetTree()
        throws Exception

Clears all keyed state for triggers in the current sub-tree and unsets all the associated finished bits.

Throws:

Exception

setFinished

void setFinished(boolean finished)

Sets the finished bit for the current trigger.

setFinished

void setFinished(boolean finished,
                 int subTriggerIndex)

Sets the finished bit for the given sub-trigger.