See: Description
| Interface | Description |
|---|---|
| IContext |
Common set of methods to provide context information.
|
| IEmbeddableParametersEditor |
Common way to embed in a dialog box an editor to modify the
parameters of a component.
|
| IHelp |
Common way of calling the help topics, regardless of the underlying system
(for example: eclipse application or simple Java application).
|
| ILoadsResources | |
| IParameterDescriptor |
Provides the different information common to all types of parameters used
to configure steps, filters, and other okapi components.
|
| IParameters |
Common way for a component to expose its
parameters in a generic way.
|
| IParametersEditor |
Common way to call in an editor to modify the parameters of
a component.
|
| IParametersEditorMapper |
Common set of methods to manage parameters editors and editor description providers.
|
| IParametersProvider |
Common way to get access to the parameters of a given component.
|
| IPredefinedLocales |
An extensive list of
LocaleIds predefined for easy access. |
| IResource |
Common set of features all the types of resources associated with events have.
|
| ISegmenter |
Common methods to provide segmentation facility to extracted content.
|
| ISimplifierRulesParameters |
Implemented by
IFilter IParameters to provide code simplifier rule support. |
| ISkeleton |
Represents a skeleton object.
|
| IUserPrompt |
An interface for prompting the user for confirmation before continuing.
|
| IWaitDialog |
Provides a generic way to open a dialog box and wait for a simple
input from the user.
|
| LocalePair |
A source and target locale pair.
|
| Sanitiser<T> |
A sanitiser.
|
| Sanitiser.Filter<T> |
Sanitiser's filter.
|
| Class | Description |
|---|---|
| AbstractGroupParameters | |
| Base64 | Deprecated
Use the
Base64, available since JDK 8 |
| BaseContext |
Basic implementation of the
IContext interface. |
| BaseParameters |
Base class for properties-like parameters that implement IParameters.
|
| BOMAwareInputStream |
Helper class to detect and skip BOM in InputStream, including for UTF-8.
|
| BOMNewlineEncodingDetector |
Helper class to detect byte-order-mark and other easily guessed of encodings, as well as the type of line-break used
in a given input.
|
| ClassInfo |
Stores a class name and its class-loader, for dynamic loading.
|
| ClassUtil |
Collection of helper functions for working with classes.
|
| ConfigurationString |
String-based representation of a configuration file.
|
| DecodeUtil | |
| DefaultEntityResolver |
Helper class that implement a default EntityResolver.
|
| DefaultFilenameFilter |
Implements a default filename filter that supports filtering by wild-cards like ("myFile*.*").
|
| DefaultLocalePair |
A default locale pair.
|
| Event |
Represents an event generated by a filter that implements IFilter.
|
| ExecutionContext |
A class to encapsulate information about execution details such as
the name of the application, the current UI parent, etc.
|
| FileUtil |
Helper methods for manipulating files.
|
| HashCodeUtil |
Collected methods which allow easy implementation of
hashCode. |
| HTMLCharacterEntities |
Helper class to handle HTML character entities.
|
| IdGenerator |
Provides a common way to generate sequential ID that are unique for a given
root.
|
| LCIDUtil |
Converts Microsoft's LCID to Okapi LocaleId back and forth.
|
| ListUtil |
Helper methods to manipulate lists.
|
| LocaleFilter |
Provides ways to work with sets of
LocaleId objects and regular expressions. |
| LocaleId |
Holds the normalized identifier for a given language/locale.
|
| MimeTypeMapper |
Provides definitions for common MIME types and mappings from file extensions
to MIME type.
|
| Namespaces |
Defines commonly used namespaces and default prefixes.
|
| NSContextManager |
Helper class to manage XML namespaces.
|
| ParameterDescriptor |
Default implementation of the
IParameterDescriptor interface. |
| ParametersDescription |
Groups in a single objects all the parameter descriptors associated with
a given object such as a step or a filter.
|
| ParametersEditorMapper |
Common set of methods to manage parameters editors.
|
| ParametersString |
String-based representation of a set of parameters.
|
| Range |
Represents a range: a start and end position.
|
| RegexUtil |
Collection of helper function for working with regular expressions.
|
| RenumberingUtil | |
| ResourceUtil | |
| ReversedIterator<T> |
Create a reversed iterator for a list compatible with foreach.
|
| StreamUtil |
Various manipulations of streams, files, etc.
|
| StringParameters |
Parameters implementation based on
ParametersString. |
| StringSanitiser |
A string sanitiser.
|
| StringSanitiser.DoubleParsingFilter |
A double parsing filter.
|
| StringSanitiser.IntegerParsingFilter |
An integer parsing filter.
|
| StringSanitiser.TrimmingFilter |
A trimming filter.
|
| StringUtil |
Helper methods to manipulate strings.
|
| UnicodeBOMWriter |
An UnicodeBOMWriter is a thin wrapper around
OutputStreamWriter,
except that it adds a BOM (Byte Order Mark) at the beginning; |
| UserConfiguration |
Simple class to store user-specific properties of an application in the user folder.
|
| UserPrompt |
A CLI implementation of
IUserPrompt. |
| Util |
Collection of various all-purpose helper functions.
|
| XmlInputStreamReader | |
| XMLWriter |
Helper class to write XML documents.
|
| ZipUtil |
| Enum | Description |
|---|---|
| BOMNewlineEncodingDetector.NewlineType |
Defines type friendly newline types.
|
| EventType |
The type of events used when working with the pipeline and its associated
interfaces such as
IFilter or
IFilterWriter. |
| LocaleFilter.FilterType |
Type of locale filter.
|
| Util.SUPPORTED_OS |
Enumeration of supported OSes
|
| Annotation Type | Description |
|---|---|
| EditorFor |
Annotation to use on classes implementing one of the interfaces
allowing to edit parameters, to indicate which parameters class
the editor supports or describes.
|
| ReferenceParameter |
Java annotation for indicating a parameter that is a reference to an external resource.
|
| UsingParameters |
Annotation to use on plug-in classes such as the implementations
of IFilter or IPipelineStep to indicate what parameters class
they use.
|
Classes commonly used across the whole Okapi Framework.
This package includes various classes and helper classes that are used by other packages of the framework.
Copyright © 2022. All rights reserved.