Package net.sf.okapi.steps.batchtranslation

Class BatchTranslationStep

java.lang.Object

net.sf.okapi.common.pipeline.BasePipelineStep

net.sf.okapi.steps.batchtranslation.BatchTranslationStep

All Implemented Interfaces:

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

public class BatchTranslationStep
extends BasePipelineStep

Constructor Summary

Constructors

Constructor	Description
BatchTranslationStep()

Method Summary

Modifier and Type	Method	Description
int	getBatchInputCount()
String	getDescription()	Gets a short localizable description of what this step does.
IFilterConfigurationMapper	getFilterConfigurationMapper()
String	getInputRootDirectory()
String	getName()	Gets the localizable name of this step.
Parameters	getParameters()	Gets the current parameters for this step.
String	getRootDirectory()
protected Event	handleEndBatchItem(Event event)	Handles the EventType.END_BATCH_ITEM event.
protected Event	handleRawDocument(Event event)	Handles the EventType.RAW_DOCUMENT event.
protected Event	handleStartBatch(Event event)	Handles the EventType.START_BATCH event.
protected Event	handleStartBatchItem(Event event)	Handles the EventType.START_BATCH_ITEM event.
void	setBatchInputCount(int batchInputCount)
void	setFilterConfigurationMapper(IFilterConfigurationMapper fcMapper)
void	setInputRootDirectory(String inputRootDir)
void	setParameters(IParameters params)	Sets new parameters for this step.
void	setRootDirectory(String rootDir)

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

cancel, destroy, getHelpLocation, getSourceLocale, getTargetLocale, handleCustom, handleDocumentPart, handleEndBatch, handleEndDocument, handleEndGroup, handleEndSubDocument, handleEndSubfilter, handleEvent, handleMultiEvent, handlePipelineParameters, 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

BatchTranslationStep

public BatchTranslationStep()

Method Detail

setFilterConfigurationMapper

public void setFilterConfigurationMapper(IFilterConfigurationMapper fcMapper)

getFilterConfigurationMapper

public IFilterConfigurationMapper getFilterConfigurationMapper()

setRootDirectory

public void setRootDirectory(String rootDir)

getRootDirectory

public String getRootDirectory()

setInputRootDirectory

public void setInputRootDirectory(String inputRootDir)

getInputRootDirectory

public String getInputRootDirectory()

setBatchInputCount

public void setBatchInputCount(int batchInputCount)

getBatchInputCount

public int getBatchInputCount()

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.

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.

handleStartBatchItem

protected Event handleStartBatchItem(Event event)

Description copied from class: BasePipelineStep

Handles the EventType.START_BATCH_ITEM event.

Overrides:

handleStartBatchItem in class BasePipelineStep

Parameters:

event - event to handle.

Returns:

the event returned.

handleEndBatchItem

protected Event handleEndBatchItem(Event event)

Description copied from class: BasePipelineStep

Handles the EventType.END_BATCH_ITEM event.

Overrides:

handleEndBatchItem 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.

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.