51Degrees Pipeline Java  4.1

51Degrees Pipeline for Java

fiftyone.pipeline.core.data.EvidenceKeyFilterAggregator Class Reference

Detailed Description

This implementation of EvidenceKeyFilter aggregates multiple other filters using a logical OR approach.

I.e. if any one of the child filters would allow the inclusion of an evidence key then this aggregator will allow it as well, even if none of the other child filters do.

Inheritance diagram for fiftyone.pipeline.core.data.EvidenceKeyFilterAggregator:

[legend]

Collaboration diagram for fiftyone.pipeline.core.data.EvidenceKeyFilterAggregator:

[legend]

Public Member Functions

 EvidenceKeyFilterAggregator ()
Construct a new empty instance where the evidence keys are case insensitive.
void  addFilter (EvidenceKeyFilter filter)
Add a child filter to this aggregator. More...
boolean  include (String key)
Check if the specified evidence key is included by this filter. More...
Integer  order (String key)
Get the order of precedence of the specified key. More...

Public Member Functions inherited from fiftyone.pipeline.core.data.EvidenceKeyFilterWhitelist

 EvidenceKeyFilterWhitelist (List< String > whitelist)
Construct a new instance using the list of evidence keys provided. More...
 EvidenceKeyFilterWhitelist (List< String > whitelist, Comparator< String > comparator)
Construct a new instance using the list of evidence keys provided and a custom string comparator to use when calling the include(String) method. More...
 EvidenceKeyFilterWhitelist (Map< String, Integer > whitelist)
Construct a new instance using the map of evidence keys and order of precedence provided. More...
 EvidenceKeyFilterWhitelist (Map< String, Integer > whitelist, Comparator< String > comparator)
Construct a new instance using the map of evidence keys and order of precedence provided. More...
Map< String, Integer >  getWhitelist ()
Get the internal list of whitelisted evidence keys along with their order of precedence as an unmodifiable map. More...
boolean  include (String key)
Check if the specified evidence key is included by this filter. More...
Integer  order (String key)
Get the order of precedence of the specified key. More...

Member Function Documentation

◆ addFilter()

void fiftyone.pipeline.core.data.EvidenceKeyFilterAggregator.addFilter ( EvidenceKeyFilter   filter )

Add a child filter to this aggregator.

Parameters
filter - child filter to add

◆ include()

boolean fiftyone.pipeline.core.data.EvidenceKeyFilterAggregator.include ( String   key )

Check if the specified evidence key is included by this filter.

Parameters
key - the key to check
Returns
true if the key is included and false if not

Implements fiftyone.pipeline.core.data.EvidenceKeyFilter.

◆ order()

Integer fiftyone.pipeline.core.data.EvidenceKeyFilterAggregator.order ( String   key )

Get the order of precedence of the specified key.

Parameters
key - the key to check
Returns
the order, where lower values indicate a higher order of precedence. Null if the key is not in the white list

Implements fiftyone.pipeline.core.data.EvidenceKeyFilter.