Detailed Description

This evidence filter will only include keys that are in a list that is specified at construction time.

Inheritance diagram for FiftyOne.Pipeline.Core.Data.EvidenceKeyFilterWhitelist:

Collaboration diagram for FiftyOne.Pipeline.Core.Data.EvidenceKeyFilterWhitelist:

Public Member Functions

	EvidenceKeyFilterWhitelist (List< string > inclusionList) Constructor The filter will be case-insensitive. More...
	EvidenceKeyFilterWhitelist (List< string > inclusionList, IEqualityComparer< string > comparer) Constructor More...
	EvidenceKeyFilterWhitelist (Dictionary< string, int > inclusionList) Constructor The filter will be case-insensitive. More...
	EvidenceKeyFilterWhitelist (Dictionary< string, int > inclusionList, IEqualityComparer< string > comparer) Constructor More...
virtual bool	Include (string key) Check if the specified evidence key is included by this filter. More...
virtual ? int	Order (string key) Get the order of precedence of the specified key More...

Public Attributes

IEqualityComparer< string >

Comparer => _comparer

Get the equality comparer that is used to determine if a supplied string key is in the inclusion list or not. More...

Protected Attributes

Dictionary< string, int >	_inclusionList The dictionary containing all keys to be included by the filter and the order of precedence. More...
IEqualityComparer< string >	_comparer The equality comparer that is used to determine if a supplied string key is in the inclusion list or not. More...

Properties

IReadOnlyDictionary< string, int >

Whitelist [get]

Get the keys in the inclusion list as a read only dictionary. More...

Constructor & Destructor Documentation

◆ EvidenceKeyFilterWhitelist() [1/4]

FiftyOne.Pipeline.Core.Data.EvidenceKeyFilterWhitelist.EvidenceKeyFilterWhitelist

(

List< string >

inclusionList

)

Constructor The filter will be case-insensitive.

For a case-sensitive filter use the overload that takes an IEqualityComparer<T>.

Parameters: inclusionList - The list of evidence keys that is filter will include. By default, all keys will have the same order of precedence.

◆ EvidenceKeyFilterWhitelist() [2/4]

FiftyOne.Pipeline.Core.Data.EvidenceKeyFilterWhitelist.EvidenceKeyFilterWhitelist	(	List< string >	inclusionList,
		IEqualityComparer< string >	comparer
	)

Constructor

Parameters: inclusionList - The list of evidence keys that is filter will include. By default, all keys will have the same order of precedence.; comparer - Comparator to use when comparing the keys.

◆ EvidenceKeyFilterWhitelist() [3/4]

FiftyOne.Pipeline.Core.Data.EvidenceKeyFilterWhitelist.EvidenceKeyFilterWhitelist

(

Dictionary< string, int >

inclusionList

)

Constructor The filter will be case-insensitive.

For a case-sensitive filter use the overload that takes an IEqualityComparer<T>.

Parameters: inclusionList - The dictionary of evidence keys that is filter will include. The order of precedence of each key is given by the value of the key/value pair.

◆ EvidenceKeyFilterWhitelist() [4/4]

FiftyOne.Pipeline.Core.Data.EvidenceKeyFilterWhitelist.EvidenceKeyFilterWhitelist	(	Dictionary< string, int >	inclusionList,
		IEqualityComparer< string >	comparer
	)

Constructor

Parameters: inclusionList - The dictionary of evidence keys that is filter will include. The order of precedence of each key is given by the value of the key/value pair.; comparer - Comparator to use when comparing the keys.

Member Function Documentation

◆ Include()

virtual bool FiftyOne.Pipeline.Core.Data.EvidenceKeyFilterWhitelist.Include

(

string

key

)

virtual

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.IEvidenceKeyFilter.

Reimplemented in FiftyOne.Pipeline.Core.Data.EvidenceKeyFilterAggregator.

◆ Order()

virtual ? int FiftyOne.Pipeline.Core.Data.EvidenceKeyFilterWhitelist.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 in the inclusion list.

Implements FiftyOne.Pipeline.Core.Data.IEvidenceKeyFilter.

Reimplemented in FiftyOne.Pipeline.Core.Data.EvidenceKeyFilterAggregator.

Member Data Documentation

◆ _comparer

IEqualityComparer<string> FiftyOne.Pipeline.Core.Data.EvidenceKeyFilterWhitelist._comparer

protected

Initial value:

=

StringComparer.OrdinalIgnoreCase

The equality comparer that is used to determine if a supplied string key is in the inclusion list or not.

By default, a case insensitive comparison is used.

◆ _inclusionList

Dictionary<string, int> FiftyOne.Pipeline.Core.Data.EvidenceKeyFilterWhitelist._inclusionList

protected

The dictionary containing all keys to be included by the filter and the order of precedence.

◆ Comparer

IEqualityComparer<string> FiftyOne.Pipeline.Core.Data.EvidenceKeyFilterWhitelist.Comparer => _comparer

Get the equality comparer that is used to determine if a supplied string key is in the inclusion list or not.

Property Documentation

◆ Whitelist

IReadOnlyDictionary<string, int> FiftyOne.Pipeline.Core.Data.EvidenceKeyFilterWhitelist.Whitelist

get

Get the keys in the inclusion list as a read only dictionary.

51Degrees Pipeline .NET 4.4

FiftyOne.Pipeline.Core.Data.EvidenceKeyFilterWhitelist Class Reference