net.sf.okapi.steps.whitespacecorrection

Class WhitespaceCorrectionStep

java.lang.Object

net.sf.okapi.common.pipeline.BasePipelineStep

net.sf.okapi.steps.whitespacecorrection.WhitespaceCorrectionStep

All Implemented Interfaces:

IPipelineStep

public class WhitespaceCorrectionStep
extends BasePipelineStep

Provides a general whitespace correction step.

Field Summary

Fields

Modifier and Type	Field and Description
protected LocaleId	sourceLocale
protected LocaleId	targetLocale

Constructor Summary

Constructors

Constructor and Description
WhitespaceCorrectionStep()

Method Summary

Modifier and Type	Method and Description
String	getDescription() Gets a short localizable description of what this step does.
String	getName() Gets the localizable name of this step.
WhitespaceCorrectionStepParameters	getParameters() Gets the current parameters for this step.
protected Event	handleTextUnit(Event event) Handles the EventType.TEXT_UNIT event.
void	setParameters(IParameters params) Sets new parameters for this step.
void	setSourceLocale(LocaleId sourceLocale) Delegate to concrete class
void	setTargetLocale(LocaleId targetLocale)

Methods inherited from class net.sf.okapi.common.pipeline.BasePipelineStep

cancel, destroy, getHelpLocation, getSourceLocale, getTargetLocale, handleCustom, handleDocumentPart, handleEndBatch, handleEndBatchItem, handleEndDocument, handleEndGroup, handleEndSubDocument, handleEndSubfilter, handleEvent, handleMultiEvent, handlePipelineParameters, handleRawDocument, handleStartBatch, handleStartBatchItem, handleStartDocument, handleStartGroup, handleStartSubDocument, handleStartSubfilter, isDone, isLastOutputStep, setLastOutputStep

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

sourceLocale

protected LocaleId sourceLocale

targetLocale

protected LocaleId targetLocale

Constructor Detail

WhitespaceCorrectionStep

public WhitespaceCorrectionStep()

Method Detail

getName

public String getName()

Description copied from interface: IPipelineStep

Gets the localizable name of this step.

Returns:

the localizable name of this step.

getDescription

public String getDescription()

Description copied from interface: IPipelineStep

Gets a short localizable description of what this step does.

Returns:

the text of a short description of what this step does.

getParameters

public WhitespaceCorrectionStepParameters getParameters()

Description copied from interface: IPipelineStep

Gets the current parameters for this step.

Specified by:

getParameters in interface IPipelineStep

Overrides:

getParameters in class BasePipelineStep

Returns:

the current parameters for this step or null if there are no parameters.

setParameters

public void setParameters(IParameters params)

Description copied from interface: IPipelineStep

Sets new parameters for this step.

Specified by:

setParameters in interface IPipelineStep

Overrides:

setParameters in class BasePipelineStep

Parameters:

params - the new parameters to use.

setSourceLocale

public void setSourceLocale(LocaleId sourceLocale)

Description copied from interface: IPipelineStep

Delegate to concrete class

Specified by:

setSourceLocale in interface IPipelineStep

Overrides:

setSourceLocale in class BasePipelineStep

setTargetLocale

public void setTargetLocale(LocaleId targetLocale)

Specified by:

setTargetLocale in interface IPipelineStep

Overrides:

setTargetLocale in class BasePipelineStep

handleTextUnit

protected Event handleTextUnit(Event event)

Description copied from class: BasePipelineStep

Handles the EventType.TEXT_UNIT event.

Overrides:

handleTextUnit in class BasePipelineStep

Parameters:

event - event to handle.

Returns:

the event returned.