Package net.sf.okapi.steps.sentencealigner

Class SentenceAlignerStep

java.lang.Object

net.sf.okapi.common.pipeline.BasePipelineStep

net.sf.okapi.steps.sentencealigner.SentenceAlignerStep

All Implemented Interfaces:

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

public class SentenceAlignerStep
extends BasePipelineStep
implements IObserver

Align sentences between source and target paragraphs (TextUnits) and produce a TMX file with aligned sentences. This IPipelineStep (via configuration) can also output aligned (multilingual TextUnits)

Author:

HARGRAVEJE

Constructor Summary

Constructors

Constructor	Description
SentenceAlignerStep()

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	handleEndBatch(Event event)	Handles the EventType.END_BATCH event.
protected Event	handleEndDocument(Event event)	Handles the EventType.END_DOCUMENT event.
protected Event	handlePipelineParameters(Event sourceEvent)	Handles the EventType#PIPELINE_PARAMETERS event.
protected Event	handleStartBatch(Event event)	Handles the EventType.START_BATCH event.
protected Event	handleStartDocument(Event event)	Handles the EventType.START_DOCUMENT event.
protected Event	handleTextUnit(Event sourceEvent)	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	setSourceLocale(LocaleId sourceLocale)	Delegate to concrete class
void	setTargetLocale(LocaleId targetLocale)
void	update(IObservable o, Object event)	This method is called whenever the observed object is changed.

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

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

SentenceAlignerStep

public SentenceAlignerStep()

Method Detail

setFilterConfigurationMapper

public void setFilterConfigurationMapper(IFilterConfigurationMapper fcMapper)

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

setSecondInput

public void setSecondInput(RawDocument secondInput)

getName

public String getName()

Description copied from interface: IPipelineStep

Gets the localizable name of this step.

Specified by:

getName in interface IPipelineStep

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.

Specified by:

getDescription in interface IPipelineStep

Returns:

the text of a short description of what this step does.

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.

handleEndBatch

protected Event handleEndBatch(Event event)

Description copied from class: BasePipelineStep

Handles the EventType.END_BATCH event.

Overrides:

handleEndBatch in class BasePipelineStep

Parameters:

event - event to handle.

Returns:

the event returned.

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 sourceEvent)

Description copied from class: BasePipelineStep

Handles the EventType.TEXT_UNIT event.

Overrides:

handleTextUnit in class BasePipelineStep

Parameters:

sourceEvent - event to handle.

Returns:

the event returned.

handlePipelineParameters

protected Event handlePipelineParameters(Event sourceEvent)

Description copied from class: BasePipelineStep

Handles the EventType#PIPELINE_PARAMETERS event. This method relies on the configuration parameters set in each step to set the corresponding values.

Overrides:

handlePipelineParameters in class BasePipelineStep

Parameters:

sourceEvent - event to handle.

Returns:

the event returned.

update

public void update(IObservable o,
                   Object event)

Description copied from interface: IObserver

This method is called whenever the observed object is changed.

Specified by:

update in interface IObserver

Parameters:

o - the object to be observed.

event - additional arguments.