Package net.sf.okapi.lib.serialization.step

Class OriginalDocumentTextUnitFlatMergerStep

java.lang.Object

net.sf.okapi.common.pipeline.BasePipelineStep

net.sf.okapi.lib.serialization.step.OriginalDocumentTextUnitFlatMergerStep

All Implemented Interfaces:

IPipelineStep

public class OriginalDocumentTextUnitFlatMergerStep
extends BasePipelineStep

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

Author:

jimh

Constructor Summary

Constructors

Constructor	Description
OriginalDocumentTextUnitFlatMergerStep()
OriginalDocumentTextUnitFlatMergerStep(SkeletonMergerWriter skelMergerWriter)

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Gets a short localizable description of what this step does.
IFilter	getFilter()
String	getName()	Gets the localizable name of 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	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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

OriginalDocumentTextUnitFlatMergerStep

public OriginalDocumentTextUnitFlatMergerStep()

OriginalDocumentTextUnitFlatMergerStep

public OriginalDocumentTextUnitFlatMergerStep(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 -

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.

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 -