Okapi Framework - Interface Specifications

IMPORTANT NOTICE - Apr-30-2009:
This .NET implementation of Okapi is no longer actively developed.
Instead, a NEW JAVA IMPLEMENTATION IS AVAILABLE and is being actively developed.
The material on this Web site is for archive propose. Some applications of the old .NET implementation (e.g. Olifant) will be maintained to some degree until they have a replacement in the Java project.

High-Level Interfaces

The Okapi Framework defines a few high-level interfaces as formal specifications. They are:

Interface	Documentation	Description
ILog	- Specification - .NET implementation	The Log interface is used when a component needs to provide some kind of feedback during the course of its execution. For example, when processing an input file, a filter may need to give warning information about the input being processed that is outside the scope of text extraction. The log could also be used for interrupting the process interactively.
IFilter	- Specification - .NET implementation	The Filter interface is used to process input in a given format and provide the translatable text items to the caller through the IFilterItem interface.
IFilterItem	- Specification - .NET implementation	The Filter Item interface is used to transport the parsed data. It also provides a wide set of function to manipulate text items with inline codes.
ILocalizationDirectives	- Specification - .NET implementation	The Localization Directives interface is used mostly to pass localization directives from a main filter to another filter, so the context of the main filter can be used when processing a specific section of the input with another filter.
IUtilitySet	- Specification - .NET implementation	The Utility Set interface is used to access a set of utilities through a single interface.

Dependencies:

IUtilitySet uses ILog
            uses IFilter uses ILog
                         uses IFilterItem
                         uses ILocalizationDirectives