net.sf.okapi.steps.rainbowkit.common

Class BasePackageWriter

java.lang.Object

net.sf.okapi.steps.rainbowkit.common.BasePackageWriter

All Implemented Interfaces:

AutoCloseable, IFilterWriter, IPackageWriter

Direct Known Subclasses:

OntramPackageWriter, POPackageWriter, RTFPackageWriter, TablePackageWriter, TransifexPackageWriter, XLIFF2PackageWriter, XLIFFPackageWriter

public abstract class BasePackageWriter
extends Object
implements IPackageWriter

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	copiedTargetsLikeApproved
protected int	docId
protected String	extractionType
protected String	inputRootDir
protected Manifest	manifest
protected Parameters	params
protected String	rootDir
protected ISkeletonWriter	skelWriter
protected boolean	supporstOneOutputPerInput
protected String	tempTmxPathAlternates
protected String	tempTmxPathApproved
protected String	tempTmxPathLeverage
protected String	tempTmxPathUnApproved
protected boolean	tmxInfoAlreadySet
protected String	tmxPathAlternates
protected String	tmxPathApproved
protected String	tmxPathLeverage
protected String	tmxPathUnApproved
protected TMXWriter	tmxWriterAlternates
protected TMXWriter	tmxWriterApproved
protected TMXWriter	tmxWriterLeverage
protected TMXWriter	tmxWriterUnApproved
protected boolean	useLetterCodes
protected boolean	zeroBasedLetterCodes

Constructor Summary

Constructors

Constructor and Description
BasePackageWriter(String extractionType)

Method Summary

Modifier and Type	Method and Description
void	cancel()
protected void	copySupportMaterial()
protected Event	creatRawDocumentEventSet(String inputPath, String defaultEncoding, LocaleId srcLoc, LocaleId trgLoc)
EncoderManager	getEncoderManager()
String	getMainOutputPath()
Parameters	getParameters()
ISkeletonWriter	getSkeletonWriter()
Event	handleEvent(Event event)
protected void	initializeTMXWriters()
protected void	processDocumentPart(Event event)
protected void	processEndBatch()
protected void	processEndBatchItem()
protected abstract Event	processEndDocument(Event event)
protected void	processEndGroup(Event event)
protected void	processEndSubDocument(Event event)
protected void	processRawDocument(Event event)
protected void	processStartBatch()
protected void	processStartBatchItem()
protected void	processStartDocument(Event event)
protected void	processStartGroup(Event event)
protected void	processStartSubDocument(Event event)
protected abstract void	processTextUnit(Event event)
void	setBatchInformation(String packageRoot, LocaleId srcLoc, LocaleId trgLoc, String inputRootDir, String rootDir, String packageId, String projectId, String creatorParams, String tempPackageRoot)
void	setDocumentInformation(String relativeInputPath, String filterConfigId, String filterParameters, String inputEncoding, String relativeTargetPath, String targetEncoding, ISkeletonWriter skelWriter)
void	setOptions(LocaleId locale, String defaultEncoding)
void	setOutput(OutputStream output)
void	setOutput(String path)
void	setParameters(IParameters params)
void	setSupporstOneOutputPerInput(boolean supporstOneOutputPerInput)
protected void	setTMXInfo(boolean generate, String pathApproved, boolean useLetterCodes, boolean zerobasedletterCodes, boolean overwrite)
protected void	writeTMXEntries(ITextUnit tu)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.okapi.common.filterwriter.IFilterWriter

close, getName

Field Detail

params

protected Parameters params

manifest

protected Manifest manifest

docId

protected int docId

extractionType

protected String extractionType

skelWriter

protected ISkeletonWriter skelWriter

supporstOneOutputPerInput

protected boolean supporstOneOutputPerInput

inputRootDir

protected String inputRootDir

rootDir

protected String rootDir

tmxWriterApproved

protected TMXWriter tmxWriterApproved

tmxPathApproved

protected String tmxPathApproved

tempTmxPathApproved

protected String tempTmxPathApproved

tmxWriterUnApproved

protected TMXWriter tmxWriterUnApproved

tmxPathUnApproved

protected String tmxPathUnApproved

tempTmxPathUnApproved

protected String tempTmxPathUnApproved

tmxWriterAlternates

protected TMXWriter tmxWriterAlternates

tmxPathAlternates

protected String tmxPathAlternates

tempTmxPathAlternates

protected String tempTmxPathAlternates

tmxWriterLeverage

protected TMXWriter tmxWriterLeverage

tmxPathLeverage

protected String tmxPathLeverage

tempTmxPathLeverage

protected String tempTmxPathLeverage

copiedTargetsLikeApproved

protected boolean copiedTargetsLikeApproved

useLetterCodes

protected boolean useLetterCodes

zeroBasedLetterCodes

protected boolean zeroBasedLetterCodes

tmxInfoAlreadySet

protected boolean tmxInfoAlreadySet

Constructor Detail

BasePackageWriter

public BasePackageWriter(String extractionType)

Method Detail

getParameters

public Parameters getParameters()

Specified by:

getParameters in interface IFilterWriter

Specified by:

getParameters in interface IPackageWriter

setParameters

public void setParameters(IParameters params)

Specified by:

setParameters in interface IFilterWriter

Specified by:

setParameters in interface IPackageWriter

setBatchInformation

public void setBatchInformation(String packageRoot,
                                LocaleId srcLoc,
                                LocaleId trgLoc,
                                String inputRootDir,
                                String rootDir,
                                String packageId,
                                String projectId,
                                String creatorParams,
                                String tempPackageRoot)

Specified by:

setBatchInformation in interface IPackageWriter

getMainOutputPath

public String getMainOutputPath()

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

handleEvent

public Event handleEvent(Event event)

Specified by:

handleEvent in interface IFilterWriter

setOptions

public void setOptions(LocaleId locale,
                       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

processStartBatch

protected void processStartBatch()

setTMXInfo

protected void setTMXInfo(boolean generate,
                          String pathApproved,
                          boolean useLetterCodes,
                          boolean zerobasedletterCodes,
                          boolean overwrite)

initializeTMXWriters

protected void initializeTMXWriters()

processEndBatch

protected void processEndBatch()

processStartBatchItem

protected void processStartBatchItem()

processEndBatchItem

protected void processEndBatchItem()

processRawDocument

protected void processRawDocument(Event event)

setDocumentInformation

public void setDocumentInformation(String relativeInputPath,
                                   String filterConfigId,
                                   String filterParameters,
                                   String inputEncoding,
                                   String relativeTargetPath,
                                   String targetEncoding,
                                   ISkeletonWriter skelWriter)

Specified by:

setDocumentInformation in interface IPackageWriter

processStartDocument

protected void processStartDocument(Event event)

processEndDocument

protected abstract Event processEndDocument(Event event)

processStartSubDocument

protected void processStartSubDocument(Event event)

processEndSubDocument

protected void processEndSubDocument(Event event)

processStartGroup

protected void processStartGroup(Event event)

processEndGroup

protected void processEndGroup(Event event)

processDocumentPart

protected void processDocumentPart(Event event)

processTextUnit

protected abstract void processTextUnit(Event event)

writeTMXEntries

protected void writeTMXEntries(ITextUnit tu)

setSupporstOneOutputPerInput

public void setSupporstOneOutputPerInput(boolean supporstOneOutputPerInput)

Specified by:

setSupporstOneOutputPerInput in interface IPackageWriter

creatRawDocumentEventSet

protected Event creatRawDocumentEventSet(String inputPath,
                                         String defaultEncoding,
                                         LocaleId srcLoc,
                                         LocaleId trgLoc)

copySupportMaterial

protected void copySupportMaterial()