net.sf.okapi.lib.merge.step

Class OriginalDocumentXliffMergerStep

java.lang.Object

net.sf.okapi.common.pipeline.BasePipelineStep

net.sf.okapi.lib.merge.step.OriginalDocumentXliffMergerStep

All Implemented Interfaces:

IPipelineStep

public class OriginalDocumentXliffMergerStep
extends BasePipelineStep

Tkit merger which re-filters the original source file to provide the skeleton for merging. Uses lib-merge SkeletonMergerWriter and TextUnitMerger.

Author:

jimh

Constructor Summary

Constructors

Constructor and Description
OriginalDocumentXliffMergerStep()
OriginalDocumentXliffMergerStep(SkeletonMergerWriter skelMergerWriter)

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel processing on this pipeline.
void	destroy() Executes any cleanup code for this step.
String	getDescription() Gets a short localizable description of what this step does.
IFilter	getFilter()
String	getName() Gets the localizable name of this step.
Parameters	getParameters() Gets the current parameters for this step.
SkeletonMergerWriter	getSkelMergerWriter() Get the current SkeletonMergerWriter
protected Event	handleRawDocument(Event event) Handles the EventType.RAW_DOCUMENT event.
void	setFilter(IFilter filter)
void	setFilterConfigurationMapper(IFilterConfigurationMapper fcMapper) The IFilterConfigurationMapper set in the PipelineDriver
void	setOutputEncoding(String outputEncoding)
void	setParameters(IParameters params) Sets new parameters for this step.
void	setSecondInput(RawDocument secondInput) This is the original source document
void	setSkelMergerWriter(SkeletonMergerWriter skelMergerWriter) Set t SkeletonMergerWriter.
void	setTargetLocales(List<LocaleId> targetLocales) Target locales.

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

getHelpLocation, getSourceLocale, getTargetLocale, handleCustom, handleDocumentPart, handleEndBatch, handleEndBatchItem, handleEndDocument, handleEndGroup, handleEndSubDocument, handleEndSubfilter, handleEvent, handleMultiEvent, handlePipelineParameters, handleStartBatch, handleStartBatchItem, handleStartDocument, handleStartGroup, handleStartSubDocument, handleStartSubfilter, handleTextUnit, isDone, isLastOutputStep, setLastOutputStep, setSourceLocale, setTargetLocale

Methods inherited from class java.lang.Object

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

Constructor Detail

OriginalDocumentXliffMergerStep

public OriginalDocumentXliffMergerStep()

OriginalDocumentXliffMergerStep

public OriginalDocumentXliffMergerStep(SkeletonMergerWriter skelMergerWriter)

Method Detail

getName

public String getName()

Description copied from interface: IPipelineStep

Gets the localizable name of this step.

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.

Returns:

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

setOutputEncoding

public void setOutputEncoding(String outputEncoding)

setTargetLocales

public void setTargetLocales(List<LocaleId> targetLocales)

Target locales. Currently only the first locale in the list is used.

Parameters:

targetLocales -

setSecondInput

public void setSecondInput(RawDocument secondInput)

This is the original source document

Parameters:

secondInput - Original source document

setFilterConfigurationMapper

public void setFilterConfigurationMapper(IFilterConfigurationMapper fcMapper)

The IFilterConfigurationMapper set in the PipelineDriver

Parameters:

fcMapper -

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.

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.

cancel

public void cancel()

Description copied from interface: IPipelineStep

Cancel processing on this pipeline. Each IPipelineStep is responsible to implement a cancel method that will interrupt long running operations

Specified by:

cancel in interface IPipelineStep

Overrides:

cancel in class BasePipelineStep

destroy

public void destroy()

Description copied from interface: IPipelineStep

Executes any cleanup code for this step. Called once at the end of the pipeline lifecycle.

Specified by:

destroy in interface IPipelineStep

Overrides:

destroy in class BasePipelineStep

getFilter

public IFilter getFilter()

Returns:

the filter

setFilter

public void setFilter(IFilter filter)

Parameters:

filter - the filter to set

getSkelMergerWriter

public SkeletonMergerWriter getSkelMergerWriter()

Get the current SkeletonMergerWriter

Returns:

the skeletonMergerWriter

setSkelMergerWriter

public void setSkelMergerWriter(SkeletonMergerWriter skelMergerWriter)

Set t SkeletonMergerWriter. Must call before handleRawDocument. Use this method to update TextUnitMerger Parameters SkeletonMergerWriter.setParameters(IParameters)

Parameters:

skelMergerWriter -