Package net.sf.okapi.steps.rainbowkit.common

Interface IPackageWriter

All Superinterfaces:

AutoCloseable, IFilterWriter

All Known Implementing Classes:

BasePackageWriter, OmegaTPackageWriter, OntramPackageWriter, POPackageWriter, RTFPackageWriter, TablePackageWriter, TransifexPackageWriter, XLIFF2PackageWriter, XLIFF2TerminologyPackageWriter, XLIFFPackageWriter, XLIFFRTFPackageWriter

public interface IPackageWriter
extends IFilterWriter

Provides a common writer to create a translation package.

Method Summary

Modifier and Type	Method	Description
IParameters	getParameters()	Gets the current parameters for this writer.
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 outputEncoding, ISkeletonWriter skelWriter)
void	setParameters(IParameters params)	Sets new parameters for this writer.
void	setSupporstOneOutputPerInput(boolean supporstOneOutputPerInput)

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

cancel, close, getEncoderManager, getName, getSkeletonWriter, handleEvent, setOptions, setOutput, setOutput

Method Detail

setParameters

void setParameters(IParameters params)

Description copied from interface: IFilterWriter

Sets new parameters for this writer.

Specified by:

setParameters in interface IFilterWriter

Parameters:

params - The new parameters to use.

getParameters

IParameters getParameters()

Description copied from interface: IFilterWriter

Gets the current parameters for this writer.

Specified by:

getParameters in interface IFilterWriter

Returns:

The current parameters for this writer.

setBatchInformation

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

setDocumentInformation

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

setSupporstOneOutputPerInput

void setSupporstOneOutputPerInput(boolean supporstOneOutputPerInput)