Package net.sf.okapi.steps.formatconversion

Class FormatConversionStep

java.lang.Object

net.sf.okapi.common.pipeline.BasePipelineStep

net.sf.okapi.steps.formatconversion.FormatConversionStep

All Implemented Interfaces:

AutoCloseable, Function<Stream<Event>,Stream<Event>>, IPipelineStep

public class FormatConversionStep
extends BasePipelineStep

Constructor Summary

Constructors

Constructor	Description
FormatConversionStep()

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Gets a short localizable description of what this step does.
String	getName()	Gets the localizable name of this step.
Parameters	getParameters()	Gets the current parameters for this step.
Event	handleEvent(Event event)	Processes each event sent though the pipeline.
protected void	processTextUnit(Event event)
void	setExecutionContext(ExecutionContext context)
void	setInputURI(URI inputURI)
void	setOutputURI(URI outputURI)
void	setParameters(IParameters params)	Sets new parameters for this step.
void	setRootDirectory(String rootDir)
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, handleMultiEvent, handlePipelineParameters, handleRawDocument, handleStartBatch, handleStartBatchItem, handleStartDocument, handleStartGroup, handleStartSubDocument, handleStartSubfilter, handleTextUnit, isDone, isLastOutputStep, setLastOutputStep, setSourceLocale

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, compose

Methods inherited from interface net.sf.okapi.common.pipeline.IPipelineStep

apply, close, handleStream

Constructor Detail

FormatConversionStep

public FormatConversionStep()

Method Detail

setInputURI

public void setInputURI(URI inputURI)

setOutputURI

public void setOutputURI(URI outputURI)

setTargetLocale

public void setTargetLocale(LocaleId targetLocale)

Specified by:

setTargetLocale in interface IPipelineStep

Overrides:

setTargetLocale in class BasePipelineStep

setRootDirectory

public void setRootDirectory(String rootDir)

setExecutionContext

public void setExecutionContext(ExecutionContext context)

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.

getName

public String getName()

Description copied from interface: IPipelineStep

Gets the localizable name of this step.

Returns:

the localizable name of this step.

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.

getParameters

public Parameters 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.

handleEvent

public Event handleEvent(Event event)

Description copied from interface: IPipelineStep

Processes each event sent though the pipeline.

Specified by:

handleEvent in interface IPipelineStep

Overrides:

handleEvent in class BasePipelineStep

Parameters:

event - the event to process.

Returns:

the event to pass down the pipeline.

processTextUnit

protected void processTextUnit(Event event)