Package net.sf.okapi.steps.msbatchtranslation

Class MSBatchTranslationStep

java.lang.Object

net.sf.okapi.common.pipeline.BasePipelineStep

net.sf.okapi.steps.msbatchtranslation.MSBatchTranslationStep

All Implemented Interfaces:

IPipelineStep

public class MSBatchTranslationStep
extends BasePipelineStep

Field Summary

Fields

Modifier and Type	Field	Description
static String	DOMAINVAR

Constructor Summary

Constructors

Constructor	Description
MSBatchTranslationStep()

Method Summary

Modifier and Type	Method	Description
static Event	generateAltOutput(String outFilePath, String defaultEncoding, LocaleId sourceLocale, LocaleId targetLocale, String filterConfigId)	Generates the alternative output used by several Trados Steps
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 Event	handleStartBatch(Event event)	Handles the EventType.START_BATCH event.
void	setBatchInputCount(int batchInputCount)
void	setInputRootDirectory(String inputRootDir)
void	setParameters(IParameters params)	Sets new parameters for this step.
void	setRootDirectory(String rootDir)
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, handleMultiEvent, handlePipelineParameters, handleRawDocument, handleStartBatchItem, handleStartDocument, handleStartGroup, handleStartSubDocument, handleStartSubfilter, handleTextUnit, isDone, isLastOutputStep, setLastOutputStep

Methods inherited from class java.lang.Object

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

Field Detail

DOMAINVAR

public static final String DOMAINVAR

See Also:

Constant Field Values

Constructor Detail

MSBatchTranslationStep

public MSBatchTranslationStep()

Method Detail

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.

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

setRootDirectory

public void setRootDirectory(String rootDir)

setInputRootDirectory

public void setInputRootDirectory(String inputRootDir)

setBatchInputCount

public void setBatchInputCount(int batchInputCount)

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.

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.

generateAltOutput

public static Event generateAltOutput(String outFilePath,
                                      String defaultEncoding,
                                      LocaleId sourceLocale,
                                      LocaleId targetLocale,
                                      String filterConfigId)

Generates the alternative output used by several Trados Steps

Parameters:

outFilePath - path of the new input file.

defaultEncoding - default encoding of the new file.

sourceLocale - source locale.

targetLocale - target locale.

filterConfigId - filter configuration id of the new file.

Returns:

the event created.