GBProcessor Class Reference
| Inherits from | NSObject |
| Declared in | GBProcessor.h GBProcessor.m |
Overview
Handles processing of parsed data from any given GBStore.
Processing phase is where parsed raw data is prepared for output. The most prominent part is processing comment raw values by validating and preparing links, formatting etc.
Tasks
Initialization & disposal
-
+ processorWithSettingsProvider:Returns autoreleased processor that work with the givenGBApplicationSettingsProviderimplementor. -
– initWithSettingsProvider:Initializes the processor to work with the givenGBApplicationSettingsProviderimplementor.
Processing handling
-
– processObjectsFromStore:Processes all objects from the given store.
Class Methods
processorWithSettingsProvider:
Returns autoreleased processor that work with the given GBApplicationSettingsProvider implementor.
+ (id)processorWithSettingsProvider:(id)settingsProviderParameters
- settingsProvider
- Application-wide settings provider to use for checking parameters.
Return Value
Returns initialized instance or nil if initialization fails.
Exceptions
- NSException
- Thrown if the given application is
nil.
Declared In
GBProcessor.hInstance Methods
initWithSettingsProvider:
Initializes the processor to work with the given GBApplicationSettingsProvider implementor.
- (id)initWithSettingsProvider:(id)settingsProviderParameters
- settingsProvider
- Application-wide settings provider to use for checking parameters.
Return Value
Returns initialized instance or nil if initialization fails.
Discussion
This is the designated initializer.
Exceptions
- NSException
- Thrown if the given application is
nil.
Declared In
GBProcessor.hprocessObjectsFromStore:
Processes all objects from the given store.
- (void)processObjectsFromStore:(id)storeParameters
- store
- The store that contains all parsed objects.
Discussion
This is the main processing method. It is intended to be invoked from the top level application code. It accepts a GBStore with parsed objects and processes all registered objects to make them ready for output. All object's and their data is recursively descended so every object that needs processing is handled properly!
If any kind of inconsistency is detected in source code, a warning is logged and processing continues. This allows us to extract as much information as possible, while ignoring problems.
Exceptions
- NSException
- Thrown if a serious problem is detected which prevents us from processing.
Declared In
GBProcessor.h