Package net.sf.okapi.steps.encodingconversion

Class EncodingConversionStep

java.lang.Object

net.sf.okapi.common.pipeline.BasePipelineStep

net.sf.okapi.steps.encodingconversion.EncodingConversionStep

All Implemented Interfaces:

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

public class EncodingConversionStep
extends BasePipelineStep

Constructor Summary

Constructors

Constructor	Description
EncodingConversionStep()

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.
protected Event	handleRawDocument(Event event)	Handles the EventType.RAW_DOCUMENT event.
protected Event	handleStartBatch(Event event)	Handles the EventType.START_BATCH event.
void	setInputURI(URI inputURI)
void	setOutputEncoding(String outputEncoding)
void	setOutputURI(URI outputURI)
void	setParameters(IParameters params)	Sets new parameters for this step.

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, handleStartBatchItem, handleStartDocument, handleStartGroup, handleStartSubDocument, handleStartSubfilter, handleTextUnit, isDone, isLastOutputStep, setLastOutputStep, setSourceLocale, setTargetLocale

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

EncodingConversionStep

public EncodingConversionStep()

Method Detail

setOutputURI

public void setOutputURI(URI outputURI)

setInputURI

public void setInputURI(URI inputURI)

setOutputEncoding

public void setOutputEncoding(String outputEncoding)

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.

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.

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.

handleStartBatch

protected Event handleStartBatch(Event event)

Description copied from class: BasePipelineStep

Handles the EventType.START_BATCH event.

Overrides:

handleStartBatch in class BasePipelineStep

Parameters:

event - event to handle.

Returns:

the event returned.

handleRawDocument

protected Event handleRawDocument(Event event)

Description copied from class: BasePipelineStep

Handles the EventType.RAW_DOCUMENT event.

Overrides:

handleRawDocument in class BasePipelineStep

Parameters:

event - event to handle.

Returns:

the event returned.