io.engineblock.activityapi.cyclelog.filters.tristate

Interface TristateFilter<T>

All Superinterfaces:

Function<T,TristateFilter.Policy>

All Known Subinterfaces:

CycleResultTristateFilter

All Known Implementing Classes:

EnumReadableMappingFilter, InputMapper, ResultFilteringSieve, ResultFilterPhase, ResultMappingArrayFilter

public interface TristateFilter<T>
extends Function<T,TristateFilter.Policy>

A tri-state filter allows for flexible configuration of multi-phase filtering. It effectively allows a conditional behavior for filtering logic that can answer "yes", "no", and "I don't know." This can also be used to build classic bi-state filtering, such as filters that use a boolean predicate to say "keep" or "discard." Where the tri-state filtering pattern shines, however, is in the ability to combine different filtering rules to build a sophisticated filter at run-time that bi-state filtering would prevent. In contrast to the bi-state filter, the default policy that is applied when not matching an item with the predicate is to simply ignore it. This means that in order to implement both matching and discarding policies like a bi-state filter, you must do one of the following:

• Implement a default policy that overrides the "Ignore" action.
• Use both "keep" and "discard" predicates together in sequence.

The two techniques above are not mutually exclusive. In practice, tri-state filters are used to build up chains of filters which can delegate down the chain if up-stream filters do not have enough information to make a keep or discard determination. Even in chained filters will have a default policy that will override the "ignore" outcome. Filter chains that have a default "exclude" policy that overrides "ignore" policies are called "exclusive" filters. Their counterparts are "inclusive" filters. In other words, Exclusive tri-state filters include an element if and only if there was a matching include rule before any matching exclude rules or the end of the filter chain. Inclusive tri-state filters exclude an element if and only if there was a matching exclude rule before any matching include rules or the end of the filter chain.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TristateFilter.DefaultingPredicate<T>
static class	TristateFilter.MatchingPredicate<T>
static class	TristateFilter.Policy The filter action determines what action is taken for a given element that matches the predicate.

Method Summary

Modifier and Type	Method and Description
TristateFilter.Policy	apply(T cycleResult)
default Predicate<T>	toDefaultingPredicate(TristateFilter.Policy defaultPolicy) Create a predicate that will override any Ignore outcomes with the provided policy.
default Predicate<T>	toMatchingPredicate(TristateFilter.Policy matchingPolicy) Create a predicate that will return true if and only if the filter outcome matches the provided policy.

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Method Detail

apply

TristateFilter.Policy apply(T cycleResult)

Specified by:

apply in interface Function<T,TristateFilter.Policy>

toDefaultingPredicate

default Predicate<T> toDefaultingPredicate(TristateFilter.Policy defaultPolicy)

Create a predicate that will override any Ignore outcomes with the provided policy.

Parameters:

defaultPolicy - The policy that will override non-actionable outcomes

Returns:

a Predicate that can be used to filter elements

toMatchingPredicate

default Predicate<T> toMatchingPredicate(TristateFilter.Policy matchingPolicy)

Create a predicate that will return true if and only if the filter outcome matches the provided policy.

Parameters:

matchingPolicy - The policy that will signal true in the predicate.

Returns:

a Predicate that can be used to filter elements