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

Protected Attributes

final Map< String, Integer > whitelist

final Comparator< String > comparator

Constructor & Destructor Documentation

◆ EvidenceKeyFilterWhitelist() [1/4]

fiftyone.pipeline.core.data.EvidenceKeyFilterWhitelist.EvidenceKeyFilterWhitelist

(

List< String >

whitelist

)

Construct a new instance using the list of evidence keys provided.

By default, all keys will have the same order of precedence.

Parameters: whitelist - evidence keys to add to the whitelist

◆ EvidenceKeyFilterWhitelist() [2/4]

fiftyone.pipeline.core.data.EvidenceKeyFilterWhitelist.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.

By default, all keys will have the same order of precedence.

Parameters: whitelist - evidence keys to add to the whitelist; comparator - the string comparator to use on the keys

◆ EvidenceKeyFilterWhitelist() [3/4]

fiftyone.pipeline.core.data.EvidenceKeyFilterWhitelist.EvidenceKeyFilterWhitelist

(

Map< String, Integer >

whitelist

)

Construct a new instance using the map of evidence keys and order of precedence provided.

The order of precedence of each key is given by the value of the key/value pair.

Parameters: whitelist - evidence keys to add to the whitelist

◆ EvidenceKeyFilterWhitelist() [4/4]

fiftyone.pipeline.core.data.EvidenceKeyFilterWhitelist.EvidenceKeyFilterWhitelist	(	Map< String, Integer >	whitelist,
		Comparator< String >	comparator
	)

Construct a new instance using the map of evidence keys and order of precedence provided.

The order of precedence of each key is given by the value of the key/value pair.

Parameters: whitelist - evidence keys to add to the whitelist; comparator - the string comparator to use on the keys

Member Function Documentation

◆ getWhitelist()

Map<String, Integer> fiftyone.pipeline.core.data.EvidenceKeyFilterWhitelist.getWhitelist

(

)

Get the internal list of whitelisted evidence keys along with their order of precedence as an unmodifiable map.

Returns: internal whitelist

◆ include()

boolean fiftyone.pipeline.core.data.EvidenceKeyFilterWhitelist.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.EvidenceKeyFilterWhitelist.order

(