\r\n

51Degrees Pipeline .NET  4.1Newer Version 4.4

51Degrees Pipeline for .NET

Search

Documentation

• FiftyOne
• Pipeline
• Core
• Data
• EvidenceKeyFilterWhitelist

FiftyOne.Pipeline.Core.Data.EvidenceKeyFilterWhitelist Class Reference

Detailed Description

This evidence filter will only include keys that are on a whitelist 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 > whitelist) Constructor More...
	EvidenceKeyFilterWhitelist (List< string > whitelist, IEqualityComparer< string > comparer) Constructor More...
	EvidenceKeyFilterWhitelist (Dictionary< string, int > whitelist) Constructor More...
	EvidenceKeyFilterWhitelist (Dictionary< string, int > whitelist, 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...

Protected Attributes

Dictionary< string, int >	_whitelist The dictionary containing all keys in the whitelist 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 whitelist or not. More...

Properties

IReadOnlyDictionary< string, int >	Whitelist [get] Get the keys in the white list as a read only dictionary. More...
IEqualityComparer< string >	Comparer [get] Get the equality comparer that is used to determine if a supplied string key is in the whitelist or not. More...

Constructor & Destructor Documentation

◆ EvidenceKeyFilterWhitelist() [1/4]

FiftyOne.Pipeline.Core.Data.EvidenceKeyFilterWhitelist.EvidenceKeyFilterWhitelist

(

List< string >

whitelist

)

Constructor

Parameters

whitelist - 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 >	whitelist,
		IEqualityComparer< string >	comparer
	)

Constructor

Parameters

whitelist - 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 >

whitelist

)

Constructor

Parameters

whitelist - 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 >	whitelist,
		IEqualityComparer< string >	comparer
	)

Constructor

Parameters

whitelist - 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 white 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

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

◆ _whitelist

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

protected

The dictionary containing all keys in the whitelist and the order of precedence.

Property Documentation

◆ Comparer

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

get

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

◆ Whitelist

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

get

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

On This Page

• Public Member Functions
• Protected Attributes
• Properties
• List of all members

Generated by doxygen 1.8.15