net.sf.okapi.steps.idbasedcopy

Class IdBasedCopyStep

java.lang.Object

net.sf.okapi.common.pipeline.BasePipelineStep

net.sf.okapi.steps.idbasedcopy.IdBasedCopyStep

All Implemented Interfaces:

IPipelineStep

public class IdBasedCopyStep
extends BasePipelineStep

This step copies into a destination file (first input file) the text of a reference file (second input file) for text units that have the same id. The ids are taken from the name (TextUnit.getName()) of each text unit.

Constructor Summary

Constructors

Constructor and Description
IdBasedCopyStep()

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.
Parameters	getParameters() Gets the current parameters for this step.
protected Event	handleEndDocument(Event event) Handles the EventType.END_DOCUMENT event.
protected Event	handleStartDocument(Event event) Handles the EventType.START_DOCUMENT event.
protected Event	handleTextUnit(Event event) Handles the EventType.TEXT_UNIT event.
void	setFilterConfigurationMapper(IFilterConfigurationMapper fcMapper)
void	setParameters(IParameters params) Sets new parameters for this step.
void	setSecondInput(RawDocument secondInput)
void	setTargetLocale(LocaleId targetLocale)

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

IdBasedCopyStep

public IdBasedCopyStep()

Method Detail

setFilterConfigurationMapper

public void setFilterConfigurationMapper(IFilterConfigurationMapper fcMapper)

setTargetLocale

public void setTargetLocale(LocaleId targetLocale)

setSecondInput

public void setSecondInput(RawDocument secondInput)

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.

handleStartDocument

protected Event handleStartDocument(Event event)

Description copied from class: BasePipelineStep

Handles the EventType.START_DOCUMENT event.

Overrides:

handleStartDocument in class BasePipelineStep

Parameters:

event - event to handle.

Returns:

the event returned.

handleEndDocument

protected Event handleEndDocument(Event event)

Description copied from class: BasePipelineStep

Handles the EventType.END_DOCUMENT event.

Overrides:

handleEndDocument in class BasePipelineStep

Parameters:

event - event to handle.

Returns:

the event returned.

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.