ClassifierSettingsLoader Class Reference

#import <ClassifierSettingsLoader.h>

Inheritance diagram for ClassifierSettingsLoader:

Instance Methods
(instancetype _Nullable)	- initWithError:
(BOOL)	- registerClassifier:withError:
(BOOL)	- unregisterClassifier:withError:
(BOOL)	- isClassifier:registered:withError:
(BOOL)	- registerClassifierExecutor:withError:
(BOOL)	- unregisterClassifierExecutor:withError:
(BOOL)	- isClassifierExecutor:registered:withError:
Instance Methods inherited from SettingsLoader
(BOOL)	- loadSettingsFromFileAtPath:withError:
(BOOL)	- loadSettingsFromString:withError:

Detailed Description

ClassifierSettingsLoader class provides the means to load your settings into your classifiers or classifier executors to prepare to classify.

Method Documentation

initWithError:()

- (instancetype _Nullable) initWithError:

(NSError *_Nullable *_Nullable)

error

Initializes a new object immediately after memory for it has been allocated

Note

The designated initializer

Parameters

error

The error representing the reason for the failure

Returns

The initialized object

isClassifier:registered:withError:()

- (BOOL) isClassifier:		(Classifier *_Nonnull)	classifier
registered:		(BOOL *_Nonnull)	isRegistered
withError:		(NSError *_Nullable *_Nullable)	error

Checks if a classifier is already registred with this settings loader

Parameters

classifier	The classifier that needs to be checked if already registered
isRegistered	Will be set to the registered status in case the check was successful
error	The error representing the reason for the check failure

Returns

True if check was successful, false in case an error occured

isClassifierExecutor:registered:withError:()

- (BOOL) isClassifierExecutor:		(ClassifierExecutor *_Nonnull)	classifierExecutor
registered:		(BOOL *_Nonnull)	isRegistered
withError:		(NSError *_Nullable *_Nullable)	error

Checks if a classifier executor is already registred with this settings loader

Parameters

classifierExecutor	The classifier executor that needs to be checked if already registered
isRegistered	Will be set to the registered status in case the check was successful
error	The error representing the reason for the check failure

Returns

True if check was successful, false in case an error occured

registerClassifier:withError:()

- (BOOL) registerClassifier:		(Classifier *_Nonnull)	classifier
withError:		(NSError *_Nullable *_Nullable)	error

Registers a classifier with this settings loader. If any settings were previously loaded, they will be propagated to the new registered classifier.

Note

Always unregister classifier from settings loader before destroying a classifier.

Precondition

classifier is not registered

Parameters

classifier	The classifier that needs to be registered
error	The error representing the reason for the registration failure

Returns

True if registration was successful, false in case an error occured

registerClassifierExecutor:withError:()

- (BOOL) registerClassifierExecutor:		(ClassifierExecutor *_Nonnull)	classifierExecutor
withError:		(NSError *_Nullable *_Nullable)	error

Registers a classifier executor with this settings loader. If any settings were previously loaded, they will be propagated to the new registered classifier executor.

Note

Always unregister classifier executor from settings loader before destroying a classifier executor.

Precondition

classifierExecutor is not registered

Parameters

classifierExecutor	The classifier executor that needs to be registered
error	The error representing the reason for the registration failure

Returns

True if registration was successful, false in case an error occured

unregisterClassifier:withError:()

- (BOOL) unregisterClassifier:		(Classifier *_Nonnull)	classifier
withError:		(NSError *_Nullable *_Nullable)	error

Unregisters a classifier from this settings loader

Precondition

classifier is registered

Parameters

classifier	The classifier that needs to be unregistered
error	The error representing the reason for the unregister failure

Returns

True if unregister was successful, false in case an error occured

unregisterClassifierExecutor:withError:()

- (BOOL) unregisterClassifierExecutor:		(ClassifierExecutor *_Nonnull)	classifierExecutor
withError:		(NSError *_Nullable *_Nullable)	error

Unregisters a classifier executor from this settings loader

Precondition

classifierExecutor is registered

Parameters

classifierExecutor	The classifier executor that needs to be unregistered
error	The error representing the reason for the unregister failure

Returns

True if unregister was successful, false in case an error occured

---

The documentation for this class was generated from the following file:

• ClassifierSettingsLoader.h