51Degrees Pipeline .NET  4.1

51Degrees Pipeline for .NET

FiftyOne.Pipeline.Core.Data.EvidenceKeyFilterAggregator Class Reference

Detailed Description

This implementation of IEvidenceKeyFilter 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 ()
Constructor More...
void  AddFilter (IEvidenceKeyFilter filter)
Add a child filter to this aggregator. More...
override bool  Include (string key)
Check if the specified evidence key is included by this filter. More...
override? int  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)
Constructor The filter will be case-insensitive. More...
 EvidenceKeyFilterWhitelist (List< string > whitelist, IEqualityComparer< string > comparer)
Constructor More...
 EvidenceKeyFilterWhitelist (Dictionary< string, int > whitelist)
Constructor The filter will be case-insensitive. More...
 EvidenceKeyFilterWhitelist (Dictionary< string, int > whitelist, IEqualityComparer< string > comparer)
Constructor More...

Constructor & Destructor Documentation

◆ EvidenceKeyFilterAggregator()

FiftyOne.Pipeline.Core.Data.EvidenceKeyFilterAggregator.EvidenceKeyFilterAggregator ( )

Constructor

Member Function Documentation

◆ AddFilter()

void FiftyOne.Pipeline.Core.Data.EvidenceKeyFilterAggregator.AddFilter ( IEvidenceKeyFilter   filter )

Add a child filter to this aggregator.

Parameters
filter - The filter to add.

◆ Include()

override bool FiftyOne.Pipeline.Core.Data.EvidenceKeyFilterAggregator.Include ( string   key )
virtual

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

Parameters
key - The evidence key to check.
Returns
True if the key is included and false if not.

Reimplemented from FiftyOne.Pipeline.Core.Data.EvidenceKeyFilterWhitelist.

◆ Order()

override? int FiftyOne.Pipeline.Core.Data.EvidenceKeyFilterAggregator.Order ( string   key )
virtual

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 included by the filter.

Reimplemented from FiftyOne.Pipeline.Core.Data.EvidenceKeyFilterWhitelist.