| Package | Description |
|---|---|
| net.sf.okapi.common |
Classes commonly used across the whole Okapi Framework.
|
| net.sf.okapi.common.encoder |
Classes to implement and manage encoders for different file formats.
|
| net.sf.okapi.common.filters |
Interfaces and base classes to implement filters
|
| net.sf.okapi.common.filterwriter |
Interfaces and classes to allow the output of a document in its original
format.
|
| net.sf.okapi.common.layerprovider | |
| net.sf.okapi.common.pipeline |
Interfaces and classes to implement and manage pipelines.
|
| net.sf.okapi.common.pipelinebuilder | |
| net.sf.okapi.common.query |
Helper classes for the translation resources connectors.
|
| net.sf.okapi.common.resource |
Interfaces and classes that represent the parsed resources attached to the
events sent by a filter.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractGroupParameters |
class |
BaseParameters
Base class for properties-like parameters that implement IParameters.
|
class |
StringParameters
Parameters implementation based on
ParametersString. |
| Modifier and Type | Method and Description |
|---|---|
IParameters |
IParametersEditor.createParameters()
Creates an instance of the parameters object the editor can edit (with
the default values).
|
IParameters |
IParametersProvider.createParameters(String location)
Gets the default parameters for a given provider.
|
IParameters |
IParametersProvider.load(String location)
Loads a parameters object from a given location.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
IParametersEditor.edit(IParameters paramsObject,
boolean readOnly,
IContext context)
Edits the values for the given parameters.
|
void |
IParametersProvider.save(String location,
IParameters paramsObject)
Saves a parameters object to a given location.
|
| Modifier and Type | Class and Description |
|---|---|
static class |
XMLEncoder.Parameters
Provides encoder parameters.
|
| Modifier and Type | Method and Description |
|---|---|
protected IParameters |
EncoderManager.getDefParams() |
IParameters |
MarkdownEncoder.getParameters() |
IParameters |
XMLEncoder.getParameters() |
IParameters |
POEncoder.getParameters() |
IParameters |
DTDEncoder.getParameters() |
IParameters |
EncoderManager.getParameters() |
IParameters |
JSONEncoder.getParameters() |
IParameters |
DefaultEncoder.getParameters() |
IParameters |
PHPContentEncoder.getParameters() |
IParameters |
PropertiesEncoder.getParameters() |
IParameters |
HtmlEncoder.getParameters() |
IParameters |
OpenXMLEncoder.getParameters() |
IParameters |
IEncoder.getParameters()
Gets the parameters object with all the configuration information specific to
this encoder.
|
IParameters |
RegexEncoder.getParameters() |
| Modifier and Type | Method and Description |
|---|---|
void |
EncoderManager.setDefaultOptions(IParameters params,
String encoding,
String lineBreak)
Sets the default options for this encoder manager.
|
protected void |
EncoderManager.setDefParams(IParameters defParams) |
void |
MarkdownEncoder.setOptions(IParameters params,
String encoding,
String lineBreak) |
void |
XMLEncoder.setOptions(IParameters params,
String encoding,
String lineBreak)
Sets the options for this encoder.
|
void |
POEncoder.setOptions(IParameters params,
String encoding,
String lineBreak) |
void |
DTDEncoder.setOptions(IParameters params,
String encoding,
String lineBreak)
Sets the options for this encoder.
|
void |
EncoderManager.setOptions(IParameters params,
String encoding,
String lineBreak)
Sets the options for the encoder currently cached.
|
void |
JSONEncoder.setOptions(IParameters params,
String encoding,
String lineBreak) |
void |
DefaultEncoder.setOptions(IParameters params,
String encoding,
String lineBreak) |
void |
PHPContentEncoder.setOptions(IParameters params,
String encoding,
String lineBreak) |
void |
PropertiesEncoder.setOptions(IParameters params,
String encoding,
String lineBreak) |
void |
HtmlEncoder.setOptions(IParameters params,
String encoding,
String lineBreak) |
void |
OpenXMLEncoder.setOptions(IParameters params,
String encoding,
String lineBreak)
Sets the options for this encoder.
|
void |
IEncoder.setOptions(IParameters params,
String encoding,
String lineBreak)
Sets the options for this encoder.
|
void |
RegexEncoder.setOptions(IParameters params,
String encoding,
String lineBreak) |
| Modifier and Type | Class and Description |
|---|---|
class |
CompoundFilterParameters
Compound Filter parameters.
|
| Modifier and Type | Field and Description |
|---|---|
IParameters |
FilterConfiguration.parameters
The parameters for this configuration.
|
| Modifier and Type | Method and Description |
|---|---|
IParameters |
CompoundFilterParameters.getActiveParameters() |
IParameters |
AbstractCompoundFilter.getActiveParameters() |
IParameters |
IFilterConfigurationMapper.getCustomParameters(FilterConfiguration config)
Gets the parameters for a given custom filter configuration.
|
IParameters |
FilterConfigurationMapper.getCustomParameters(FilterConfiguration config) |
IParameters |
IFilterConfigurationMapper.getCustomParameters(FilterConfiguration config,
IFilter existingFilter)
Gets the parameters for a given custom filter configuration.
|
IParameters |
FilterConfigurationMapper.getCustomParameters(FilterConfiguration config,
IFilter existingFilter)
Gets the parameters for a given custom filter configuration.
|
IParameters |
IFilter.getParameters()
Gets the current parameters for this filter.
|
IParameters |
AbstractFilter.getParameters() |
IParameters |
SubFilter.getParameters() |
IParameters |
IFilterConfigurationMapper.getParameters(FilterConfiguration config)
Gets the parameters for a given configuration (predefined or custom).
|
IParameters |
FilterConfigurationMapper.getParameters(FilterConfiguration config) |
IParameters |
IFilterConfigurationMapper.getParameters(FilterConfiguration config,
IFilter existingFilter)
Gets the parameters for a given configuration (predefined or custom).
|
IParameters |
FilterConfigurationMapper.getParameters(FilterConfiguration config,
IFilter existingFilter) |
| Modifier and Type | Method and Description |
|---|---|
LinkedList<IParameters> |
CompoundFilterParameters.getParameters() |
| Modifier and Type | Method and Description |
|---|---|
void |
FilterConfigurationMapper.addCustomConfiguration(String configId,
IParameters parameters) |
void |
IFilterConfigurationMapper.saveCustomParameters(FilterConfiguration config,
IParameters params)
Saves the parameters of a custom configuration.
|
void |
FilterConfigurationMapper.saveCustomParameters(FilterConfiguration config,
IParameters params) |
protected void |
CompoundFilterParameters.setActiveParameters(IParameters activeParameters) |
void |
IFilter.setParameters(IParameters params)
Sets new parameters for this filter.
|
void |
AbstractFilter.setParameters(IParameters params) |
void |
AbstractCompoundFilter.setParameters(IParameters params) |
void |
SubFilter.setParameters(IParameters params) |
| Constructor and Description |
|---|
FilterConfiguration(String configId,
String mimeType,
String filterClass,
String name,
String description,
String parametersLocation,
IParameters parameters,
String extensions)
Creates a FilterConfiguration object and initializes it.
|
| Modifier and Type | Class and Description |
|---|---|
class |
Parameters |
class |
XLIFFWriterParameters
Provides a way to access the parameters for
XLIFFWriter in a single object. |
| Modifier and Type | Method and Description |
|---|---|
IParameters |
IFilterWriter.getParameters()
Gets the current parameters for this writer.
|
IParameters |
GenericFilterWriter.getParameters() |
IParameters |
ZipFilterWriter.getParameters() |
| Modifier and Type | Method and Description |
|---|---|
void |
XLIFFWriter.setParameters(IParameters params) |
void |
IFilterWriter.setParameters(IParameters params)
Sets new parameters for this writer.
|
void |
TMXFilterWriter.setParameters(IParameters params) |
void |
GenericFilterWriter.setParameters(IParameters params) |
void |
ZipFilterWriter.setParameters(IParameters params) |
| Modifier and Type | Method and Description |
|---|---|
IParameters |
LayerProvider.getParameters() |
| Modifier and Type | Method and Description |
|---|---|
void |
LayerProvider.setOptions(IParameters params,
String encoding,
String lineBreak) |
| Modifier and Type | Method and Description |
|---|---|
IParameters |
IPipelineStep.getParameters()
Gets the current parameters for this step.
|
IParameters |
BasePipelineStep.getParameters() |
| Modifier and Type | Method and Description |
|---|---|
void |
IPipelineStep.setParameters(IParameters params)
Sets new parameters for this step.
|
void |
BasePipelineStep.setParameters(IParameters params) |
| Modifier and Type | Method and Description |
|---|---|
IParameters |
XPipeline.getParameters() |
IParameters |
XPipelineStep.getParameters() |
| Modifier and Type | Method and Description |
|---|---|
void |
XPipeline.setParameters(IParameters params) |
void |
XPipelineStep.setParameters(IParameters params) |
| Constructor and Description |
|---|
XPipelineStep(Class<? extends IPipelineStep> stepClass,
IParameters parameters) |
XPipelineStep(IPipelineStep step,
IParameters parameters) |
| Modifier and Type | Method and Description |
|---|---|
IParameters |
IQuery.getParameters()
Gets the current parameters of this connector.
|
| Modifier and Type | Method and Description |
|---|---|
void |
IQuery.setParameters(IParameters params)
Sets the parameters for opening and querying this connector.
|
| Modifier and Type | Field and Description |
|---|---|
protected IParameters |
StartDocument.params |
protected IParameters |
StartSubDocument.params |
| Modifier and Type | Method and Description |
|---|---|
IParameters |
StartSubfilter.getFilterParameters() |
IParameters |
StartDocument.getFilterParameters()
Gets the current filter parameters for this document.
|
IParameters |
StartSubDocument.getFilterParameters()
Gets the current filter parameters for this sub-document.
|
| Modifier and Type | Method and Description |
|---|---|
void |
StartDocument.setFilterParameters(IParameters params)
Sets the filter parameters for this document.
|
void |
StartSubDocument.setFilterParameters(IParameters params)
Sets the filter parameters for this sub-document.
|
Copyright © 2021. All rights reserved.