Package net.sf.okapi.steps.diffleverage

Class DiffLeverageStep

java.lang.Object

net.sf.okapi.common.pipeline.BasePipelineStep

net.sf.okapi.steps.diffleverage.DiffLeverageStep

All Implemented Interfaces:

IPipelineStep

public class DiffLeverageStep
extends BasePipelineStep

Contextually match source "paragraphs" (full content of the TextUnit source) between two documents using a standard diff algorithm (http://en.wikipedia.org/wiki/Diff). The result is a new document with the translations from the old document copied into it. This allows translations between different document versions to be preserved while still maintaining the newer source document modifications.

Adds these Annotations:

AltTranslationsAnnotation on the target container. DiffMatchAnnotation on the target container (only applied if diffOnly is true)

Author:

HARGRAVEJE

Constructor Summary

Constructors

Constructor	Description
DiffLeverageStep()

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	handleDocumentPart(Event event)	Handles the EventType.DOCUMENT_PART event.
protected Event	handleEndBatch(Event event)	Handles the EventType.END_BATCH event.
protected Event	handleEndDocument(Event event)	Handles the EventType.END_DOCUMENT event.
protected Event	handleEndGroup(Event event)	Handles the EventType.END_GROUP event.
protected Event	handleEndSubDocument(Event event)	Handles the EventType.END_SUBDOCUMENT 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	handleStartDocument(Event event)	Handles the EventType.START_DOCUMENT event.
protected Event	handleStartGroup(Event event)	Handles the EventType.START_GROUP event.
protected Event	handleStartSubDocument(Event event)	Handles the EventType.START_SUBDOCUMENT event.
protected Event	handleTextUnit(Event event)	Handles the EventType.TEXT_UNIT event.
boolean	isDone()	Steps that can generate Events such as IFilters return false until no more events can be created.
void	setFilterConfigurationMapper(IFilterConfigurationMapper fcMapper)
void	setParameters(IParameters params)	Sets new parameters for this step.
void	setSecondInput(RawDocument secondInput)	This is the old document (previously translated)
void	setSourceLocale(LocaleId sourceLocale)	Delegate to concrete class
void	setTargetLocale(LocaleId targetLocale)	Target locale.
void	setTertiaryInput(RawDocument tertiaryInput)	If set this is the old target that will be paragraph aligned with the old source.

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

cancel, destroy, getHelpLocation, getSourceLocale, getTargetLocale, handleCustom, handleEndBatchItem, handleEndSubfilter, handleEvent, handleMultiEvent, handlePipelineParameters, handleStartBatchItem, handleStartSubfilter, isLastOutputStep, setLastOutputStep

Methods inherited from class java.lang.Object

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

Constructor Detail

DiffLeverageStep

public DiffLeverageStep()

Method Detail

setFilterConfigurationMapper

public void setFilterConfigurationMapper(IFilterConfigurationMapper fcMapper)

Parameters:

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

Parameters:

sourceLocale -

setTargetLocale

public void setTargetLocale(LocaleId targetLocale)

Target locale.

Specified by:

setTargetLocale in interface IPipelineStep

Overrides:

setTargetLocale in class BasePipelineStep

Parameters:

targetLocale -

setSecondInput

public void setSecondInput(RawDocument secondInput)

This is the old document (previously translated)

Parameters:

secondInput -

setTertiaryInput

public void setTertiaryInput(RawDocument tertiaryInput)

If set this is the old target that will be paragraph aligned with the old source.

Parameters:

tertiaryInput -

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.

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.

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.

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.

handleStartSubDocument

protected Event handleStartSubDocument(Event event)

Description copied from class: BasePipelineStep

Handles the EventType.START_SUBDOCUMENT event.

Overrides:

handleStartSubDocument in class BasePipelineStep

Parameters:

event - event to handle.

Returns:

the event returned.

handleEndSubDocument

protected Event handleEndSubDocument(Event event)

Description copied from class: BasePipelineStep

Handles the EventType.END_SUBDOCUMENT event.

Overrides:

handleEndSubDocument in class BasePipelineStep

Parameters:

event - event to handle.

Returns:

the event returned.

handleStartGroup

protected Event handleStartGroup(Event event)

Description copied from class: BasePipelineStep

Handles the EventType.START_GROUP event.

Overrides:

handleStartGroup in class BasePipelineStep

Parameters:

event - event to handle.

Returns:

the event returned.

handleEndGroup

protected Event handleEndGroup(Event event)

Description copied from class: BasePipelineStep

Handles the EventType.END_GROUP event.

Overrides:

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

handleDocumentPart

protected Event handleDocumentPart(Event event)

Description copied from class: BasePipelineStep

Handles the EventType.DOCUMENT_PART event.

Overrides:

handleDocumentPart in class BasePipelineStep

Parameters:

event - event to handle.

Returns:

the event returned.

isDone

public boolean isDone()

Description copied from interface: IPipelineStep

Steps that can generate Events such as IFilters return false until no more events can be created. Steps which do not create Events always return true.

Specified by:

isDone in interface IPipelineStep

Overrides:

isDone in class BasePipelineStep

Returns:

false if can generate more events, true otherwise.