com.fluxtion.ext.declarative.api.stream

Class AbstractFilterWrapper<T>

java.lang.Object

com.fluxtion.ext.declarative.api.stream.AbstractFilterWrapper<T>

Type Parameters:

T -

All Implemented Interfaces:

FilterWrapper<T>, Wrapper<T>

public abstract class AbstractFilterWrapper<T>
extends Object
implements FilterWrapper<T>

A base class for stream functions.

Author:

V12 Technology Ltd.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	alwaysReset
protected boolean	notifyOnChangeOnly
protected boolean	resetImmediate

Fields inherited from interface com.fluxtion.ext.declarative.api.Wrapper

counter

Constructor Summary

Constructors

Constructor and Description
AbstractFilterWrapper()

Method Summary

Modifier and Type	Method and Description
Wrapper<T>	alwaysReset(boolean alwaysReset) Reset a stateful node after every execution cycle, without the need for a an external Wrapper.resetNotifier(java.lang.Object).
Wrapper<T>	immediateReset(boolean immediateReset) Controls reset timing policy for stateful nodes.
boolean	isAlwaysReset()
boolean	isNotifyOnChangeOnly()
boolean	isResetImmediate()
Wrapper<T>	notifyOnChange(boolean notifyOnChange) Controls the notification policy of event notification to child nodes for this stream node.
void	setAlwaysReset(boolean alwaysReset)
void	setNotifyOnChangeOnly(boolean notifyOnChangeOnly)
void	setResetImmediate(boolean resetImmediate)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.fluxtion.ext.declarative.api.FilterWrapper

elseStream

Methods inherited from interface com.fluxtion.ext.declarative.api.Wrapper

console, event, eventClass, filter, filter, forEach, forEach, id, map, map, mapDouble, mapInt, mapLong, notiferMerge, notifierOverride, publishAndReset, push, resetNotifier

Field Detail

notifyOnChangeOnly

protected boolean notifyOnChangeOnly

resetImmediate

protected boolean resetImmediate

alwaysReset

protected boolean alwaysReset

Constructor Detail

AbstractFilterWrapper

public AbstractFilterWrapper()

Method Detail

notifyOnChange

public Wrapper<T> notifyOnChange(boolean notifyOnChange)

Description copied from interface: Wrapper

Controls the notification policy of event notification to child nodes for this stream node. The default policy is to invoke child nodes when the return of the parent event method is true. NotifyOnChange notifies the child only when the parent node return of the previous cycle is false and this one is true.

This can be useful if a single notification of a breach is required and subsequent continued breaches are swallowed, for example this can prevent logging spamming when combined with filters.

Specified by:

notifyOnChange in interface Wrapper<T>

Parameters:

notifyOnChange - false = notify always. true = notify on change only

Returns:

The current node

immediateReset

public Wrapper<T> immediateReset(boolean immediateReset)

Description copied from interface: Wrapper

Controls reset timing policy for stateful nodes. Stateful nodes are reset with Wrapper.resetNotifier(java.lang.Object) or Wrapper.alwaysReset(boolean). The timing policy has the following behaviour:

• true - the stateful node will be reset before any child nodes are invoked on the execution path
• false: - the stateful node will be reset after the final node on the execution path

Specified by:

immediateReset in interface Wrapper<T>

Parameters:

immediateReset - reset timing policy

Returns:

alwaysReset

public Wrapper<T> alwaysReset(boolean alwaysReset)

Description copied from interface: Wrapper

Reset a stateful node after every execution cycle, without the need for a an external Wrapper.resetNotifier(java.lang.Object).

• true - the stateful node will be reset after every execution cycle
• false: - the stateful node will only be reset with Wrapper.resetNotifier(java.lang.Object)

Specified by:

alwaysReset in interface Wrapper<T>

Parameters:

alwaysReset - - reset policy for stateful nodes

Returns:

isNotifyOnChangeOnly

public boolean isNotifyOnChangeOnly()

setNotifyOnChangeOnly

public void setNotifyOnChangeOnly(boolean notifyOnChangeOnly)

isResetImmediate

public boolean isResetImmediate()

setResetImmediate

public void setResetImmediate(boolean resetImmediate)

isAlwaysReset

public boolean isAlwaysReset()

setAlwaysReset

public void setAlwaysReset(boolean alwaysReset)