Package net.sf.okapi.steps.idaligner

Class IdBasedAlignerStep

java.lang.Object

net.sf.okapi.common.pipeline.BasePipelineStep

net.sf.okapi.steps.idaligner.IdBasedAlignerStep

All Implemented Interfaces:

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

public class IdBasedAlignerStep
extends BasePipelineStep

Align two TextUnits based on matching ids. The ids are taken from the name (TextUnit#getName) or id (TextUnit#getId) of each TextUnit, depending on configuration. Any IFilter that produces a name for its TextUnits will work with this aligner. Expects filtered Events as input and returns a new (aligned) bi-lingual TextUnit Event. Optionally produce a TMX file in the specified output path.

Author:

Greg Perkins, HargraveJE

Constructor Summary

Constructors

Constructor	Description
IdBasedAlignerStep()

Method Summary

Modifier and Type	Method	Description
String	getDescription()
String	getName()
Parameters	getParameters()
protected Event	handleEndBatch(Event event)
protected Event	handleEndDocument(Event event)
protected Event	handleStartBatch(Event event)
protected Event	handleStartDocument(Event event)
protected Event	handleTextUnit(Event sourceEvent)
void	setExecutionContext(ExecutionContext context)
void	setFilterConfigurationMapper(IFilterConfigurationMapper fcMapper)
void	setParameters(IParameters params)
void	setSecondInput(RawDocument secondInput)
void	setSourceLocale(LocaleId sourceLocale)
void	setTargetLocale(LocaleId targetLocale)

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

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

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

IdBasedAlignerStep

public IdBasedAlignerStep()

Method Detail

setFilterConfigurationMapper

public void setFilterConfigurationMapper(IFilterConfigurationMapper fcMapper)

setSourceLocale

public void setSourceLocale(LocaleId sourceLocale)

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

setSecondInput

public void setSecondInput(RawDocument secondInput)

setExecutionContext

public void setExecutionContext(ExecutionContext context)

getDescription

public String getDescription()

getName

public String getName()

getParameters

public Parameters getParameters()

Specified by:

getParameters in interface IPipelineStep

Overrides:

getParameters in class BasePipelineStep

setParameters

public void setParameters(IParameters params)

Specified by:

setParameters in interface IPipelineStep

Overrides:

setParameters in class BasePipelineStep

handleStartBatch

protected Event handleStartBatch(Event event)

Overrides:

handleStartBatch in class BasePipelineStep

handleEndBatch

protected Event handleEndBatch(Event event)

Overrides:

handleEndBatch in class BasePipelineStep

handleStartDocument

protected Event handleStartDocument(Event event)

Overrides:

handleStartDocument in class BasePipelineStep

handleEndDocument

protected Event handleEndDocument(Event event)

Overrides:

handleEndDocument in class BasePipelineStep

handleTextUnit

protected Event handleTextUnit(Event sourceEvent)

Overrides:

handleTextUnit in class BasePipelineStep