net.sf.okapi.lib.merge.merge

Class SkeletonMergerWriter

java.lang.Object

net.sf.okapi.lib.merge.merge.SkeletonMergerWriter

All Implemented Interfaces:

AutoCloseable, IFilterWriter

public class SkeletonMergerWriter
extends Object
implements IFilterWriter

Basic class for skeleton-based merging. Override for specific behaviors.

Takes a skeleton file and Events from a translated document. Translated segments are merged into the skeleton TextUnit events and written out using the default IFilterWriter

Author:

jimh

Constructor Summary

Constructors

Constructor and Description
SkeletonMergerWriter()
SkeletonMergerWriter(IFilter skeletonFilter, IFilterWriter writer, ITextUnitMerger textUnitMerger) Use specific IFilter and IFilterWriter implementations

Method Summary

Modifier and Type	Method and Description
void	cancel()
void	close()
EncoderManager	getEncoderManager()
String	getName()
Parameters	getParameters()
ISkeletonWriter	getSkeletonWriter()
Event	handleEvent(Event event)
protected void	processEndDocument() There are no more TextUnits.
protected void	processStartDocument() Use the skeleton StartDocument event to initialize the IFilterWriter.
protected void	processTextUnit(Event event) Take the translated TextUnit and match it up with its corresponding skeleton version.
protected Event	processUntilTextUnit() Get events in the original document until the next text unit.
void	setFilter(IFilter skeletonFilter) Set the IFilter needed to process the skeleton file (normally the original document)
void	setOptions(LocaleId targetLocale, String defaultEncoding)
void	setOutput(OutputStream output)
void	setOutput(String path)
void	setParameters(IParameters params)
void	setWriter(IFilterWriter writer) Set the IFilterWriter used to write out the skeleton events.

Methods inherited from class java.lang.Object

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

Constructor Detail

SkeletonMergerWriter

public SkeletonMergerWriter()

SkeletonMergerWriter

public SkeletonMergerWriter(IFilter skeletonFilter,
                            IFilterWriter writer,
                            ITextUnitMerger textUnitMerger)

Use specific IFilter and IFilterWriter implementations

Parameters:

skeletonFilter - - IFilter used to read skeleton, can be serialized events or original source file. ASSUME FILTER OPEN ALREADY CALLED

writer - - override the writer specified in the skeleton StartDocument event. Can use null value for writer to use the default writer.

textUnitMerger - user created ITextUnitMerger

Method Detail

getName

public String getName()

Specified by:

getName in interface IFilterWriter

setOptions

public void setOptions(LocaleId targetLocale,
                       String defaultEncoding)

Specified by:

setOptions in interface IFilterWriter

setOutput

public void setOutput(String path)

Specified by:

setOutput in interface IFilterWriter

setOutput

public void setOutput(OutputStream output)

Specified by:

setOutput in interface IFilterWriter

handleEvent

public Event handleEvent(Event event)

Specified by:

handleEvent in interface IFilterWriter

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface IFilterWriter

getParameters

public Parameters getParameters()

Specified by:

getParameters in interface IFilterWriter

setParameters

public void setParameters(IParameters params)

Specified by:

setParameters in interface IFilterWriter

cancel

public void cancel()

Specified by:

cancel in interface IFilterWriter

getEncoderManager

public EncoderManager getEncoderManager()

Specified by:

getEncoderManager in interface IFilterWriter

getSkeletonWriter

public ISkeletonWriter getSkeletonWriter()

Specified by:

getSkeletonWriter in interface IFilterWriter

processStartDocument

protected void processStartDocument()

Use the skeleton StartDocument event to initialize the IFilterWriter. Initialize the ITextUnitMerger

processTextUnit

protected void processTextUnit(Event event)

Take the translated TextUnit and match it up with its corresponding skeleton version. Call ITextUnitMerger to merge the translated segments into the skeleton TextUnit

Parameters:

event - - the translated version of the ITextUnit event

processUntilTextUnit

protected Event processUntilTextUnit()

Get events in the original document until the next text unit. Any event before is passed to the writer.

Returns:

the event of the next text unit, or null if no next text unit is found.

processEndDocument

protected void processEndDocument()

There are no more TextUnits. Read the remaining skeleton events and write them out.

setWriter

public void setWriter(IFilterWriter writer)

Set the IFilterWriter used to write out the skeleton events. This will override the internal writer as defined by StartDocument in the skeleton.

Must be called immediately after construction!!

Parameters:

writer - - IFilterWriter used to write out the skeleton events

setFilter

public void setFilter(IFilter skeletonFilter)

Set the IFilter needed to process the skeleton file (normally the original document)

Parameters:

skeletonFilter -