file2xliff4j
Class PlaintextExporter

java.lang.Object
  file2xliff4j.PlaintextExporter

All Implemented Interfaces:

Converter

public class PlaintextExporter
extends java.lang.Object
implements Converter

Class to export an XLIFF target to plaintext document in the same format as the original plaintext source document.

Author:

Weldon Whipple <weldon@lingotek.com>

Field Summary

Fields inherited from interface file2xliff4j.Converter

BLKSIZE, formatSuffix, skeletonSuffix, startXliff, stylesTSkeletonSuffix, tSkeletonSuffix, xliffSuffix, xmlDeclaration

Constructor Summary

PlaintextExporter()
Creates a new instance of PlaintextExporter

Method Summary

ConversionStatus	convert(ConversionMode mode, java.util.Locale language, java.lang.String phaseName, int maxPhase, java.nio.charset.Charset nativeEncoding, FileType nativeFileType, java.lang.String nativeFileName, java.lang.String baseDir, Notifier notifier) Deprecated.
ConversionStatus	convert(ConversionMode mode, java.util.Locale language, java.lang.String phaseName, int maxPhase, java.nio.charset.Charset nativeEncoding, FileType nativeFileType, java.lang.String nativeFileName, java.lang.String baseDir, Notifier notifier, SegmentBoundary boundary, java.io.StringWriter generatedFileName) Convert one set of targets (in the translation units of an XLIFF file) back to the original plaintext format.
ConversionStatus	convert(ConversionMode mode, java.util.Locale language, java.lang.String phaseName, int maxPhase, java.nio.charset.Charset nativeEncoding, FileType nativeFileType, java.lang.String nativeFileName, java.lang.String baseDir, Notifier notifier, SegmentBoundary boundary, java.io.StringWriter generatedFileName, java.util.Set<f2xutils.XMLTuXPath> skipList) Convert one set of targets (in the translation units of an XLIFF file) back to the original plaintext format.
java.lang.Object	getConversionProperty(java.lang.String property) Return an object representing a format-specific (and converter-specific) property.
FileType	getFileType() Return the file type that this converter handles.
void	setConversionProperty(java.lang.String property, java.lang.Object value) Set a format-specific property that might affect the way that the conversion occurs.

Methods inherited from class java.lang.Object

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

Constructor Detail

PlaintextExporter

public PlaintextExporter()

Creates a new instance of PlaintextExporter

Method Detail

convert

public ConversionStatus convert(ConversionMode mode,
                                java.util.Locale language,
                                java.lang.String phaseName,
                                int maxPhase,
                                java.nio.charset.Charset nativeEncoding,
                                FileType nativeFileType,
                                java.lang.String nativeFileName,
                                java.lang.String baseDir,
                                Notifier notifier,
                                SegmentBoundary boundary,
                                java.io.StringWriter generatedFileName)
                         throws ConversionException

Convert one set of targets (in the translation units of an XLIFF file) back to the original plaintext format. Use (besides the XLIFF file) the skeleton file that was generated when the XLIFF file was created. (Note: Because plaintext files--as defined by this converter--contain no formatting, no format file is used by this converter.)

Specified by:

convert in interface Converter

Parameters:

mode - The mode of conversion (to or from XLIFF). Must be from XLIFF for this converter.

language - The language of the XLIFF targets to use in constructing the plaintext document. The language is used in constructing a unique name for the output file. For example, if ja_JP is specified, the output file name will include the substring ja_JP in its name.

phaseName - The name of the phase to export. If this parameter's value is not null, it is matched against the value of the optional phase-name attribute of the target elements of the XLIFF document. If null, no check is made against a phase-name attribute.

If the phase name string consists entirely of numeric digit(s) equivalent to an integer with value greater than 1 but less than or equal to maxPhase (see next parameter) search for targets with lower numbered phase names.

maxPhase - The maximum phase number. If phaseName is specified as "0" and maxPhase is a non-negative integer, search for the highest "numbered" phase, starting at maxPhase, and searching down to phase "1".

nativeEncoding - This parameter--the encoding of the original native plaintext file--is ignored by this converter. (UTF-8 will always be used in the exported target-language document, to handle cases where a restrictive encoding [ISO-8859-1, for example--which handles only Western European languages] in a source document is incapable of representing characters in a target language [Japanese, for example].)

nativeFileType - This parameter is ignored. The native file type is always plaintext.

nativeFileName - The name of the original source-language file that was previously converted to XLIFF. It is used to determine the name of the XLIFF file (<nativeFileName>.xliff) and the skeleton file (<nativeFileName>.skeleton). It is also used in constructing the file name of the output plaintext file.

baseDir - The directory (in the file system) from which input files (XLIFF and skeleton files) will be read, and to which the output file will be written.

notifier - Instance of a class that implements the Notifier interface (to send notifications in case of conversion error).

boundary - (Ignored. The boundary on which to segment translation units (e.g., on paragraph or sentence boundaries) is meaningful only for importers--converters that generate XLIFF from documents.)

generatedFileName - If non-null, the converter will write the name of the file (without parent directories) to which the generated output file was written.

Returns:

Indicator of the status of the conversion.

Throws:

ConversionException - If a conversion exception is encountered.

convert

public ConversionStatus convert(ConversionMode mode,
                                java.util.Locale language,
                                java.lang.String phaseName,
                                int maxPhase,
                                java.nio.charset.Charset nativeEncoding,
                                FileType nativeFileType,
                                java.lang.String nativeFileName,
                                java.lang.String baseDir,
                                Notifier notifier,
                                SegmentBoundary boundary,
                                java.io.StringWriter generatedFileName,
                                java.util.Set<f2xutils.XMLTuXPath> skipList)
                         throws ConversionException

Convert one set of targets (in the translation units of an XLIFF file) back to the original plaintext format. Use (besides the XLIFF file) the skeleton file that was generated when the XLIFF file was created. (Note: Because plaintext files--as defined by this converter--contain no formatting, no format file is used by this converter.)

Specified by:

convert in interface Converter

Parameters:

mode - The mode of conversion (to or from XLIFF). Must be from XLIFF for this converter.

language - The language of the XLIFF targets to use in constructing the plaintext document. The language is used in constructing a unique name for the output file. For example, if ja_JP is specified, the output file name will include the substring ja_JP in its name.

phaseName - The name of the phase to export. If this parameter's value is not null, it is matched against the value of the optional phase-name attribute of the target elements of the XLIFF document. If null, no check is made against a phase-name attribute.

If the phase name string consists entirely of numeric digit(s) equivalent to an integer with value greater than 1 but less than or equal to maxPhase (see next parameter) search for targets with lower numbered phase names.

maxPhase - The maximum phase number. If phaseName is specified as "0" and maxPhase is a non-negative integer, search for the highest "numbered" phase, starting at maxPhase, and searching down to phase "1".

nativeEncoding - This parameter--the encoding of the original native plaintext file--is ignored by this converter. (UTF-8 will always be used in the exported target-language document, to handle cases where a restrictive encoding [ISO-8859-1, for example--which handles only Western European languages] in a source document is incapable of representing characters in a target language [Japanese, for example].)

nativeFileType - This parameter is ignored. The native file type is always plaintext.

nativeFileName - The name of the original source-language file that was previously converted to XLIFF. It is used to determine the name of the XLIFF file (<nativeFileName>.xliff) and the skeleton file (<nativeFileName>.skeleton). It is also used in constructing the file name of the output plaintext file.

baseDir - The directory (in the file system) from which input files (XLIFF and skeleton files) will be read, and to which the output file will be written.

notifier - Instance of a class that implements the Notifier interface (to send notifications in case of conversion error).

boundary - (Ignored. The boundary on which to segment translation units (e.g., on paragraph or sentence boundaries) is meaningful only for importers--converters that generate XLIFF from documents.)

generatedFileName - If non-null, the converter will write the name of the file (without parent directories) to which the generated output file was written.

skipList - (Not used by this converter.)

Returns:

Indicator of the status of the conversion.

Throws:

ConversionException - If a conversion exception is encountered.

convert

@Deprecated
public ConversionStatus convert(ConversionMode mode,
                                           java.util.Locale language,
                                           java.lang.String phaseName,
                                           int maxPhase,
                                           java.nio.charset.Charset nativeEncoding,
                                           FileType nativeFileType,
                                           java.lang.String nativeFileName,
                                           java.lang.String baseDir,
                                           Notifier notifier)
                         throws ConversionException

Deprecated.

Convert one set of targets (in the translation units of an XLIFF file) back to the original plaintext format. Use (besides the XLIFF file) the skeleton file that was generated when the XLIFF file was created. (Note: Because plaintext files--as defined by this converter--contain no formatting, no format file is used by this converter.)

Specified by:

convert in interface Converter

Parameters:

mode - The mode of conversion (to or from XLIFF). Must be from XLIFF for this converter.

language - The language of the XLIFF targets to use in constructing the plaintext document. The language is used in constructing a unique name for the output file. For example, if ja_JP is specified, the output file name will include the substring ja_JP in its name.

phaseName - The name of the phase to export. If this parameter's value is not null, it is matched against the value of the optional phase-name attribute of the target elements of the XLIFF document. If null, no check is made against a phase-name attribute.

If the phase name string consists entirely of numeric digit(s) equivalent to an integer with value greater than 1 but less than or equal to maxPhase (see next parameter) search for targets with lower numbered phase names.

maxPhase - The maximum phase number. If phaseName is specified as "0" and maxPhase is a non-negative integer, search for the highest "numbered" phase, starting at maxPhase, and searching down to phase "1".

nativeEncoding - This parameter--the encoding of the original native plaintext file--is ignored by this converter. (UTF-8 will always be used in the exported target-language document, to handle cases where a restrictive encoding [ISO-8859-1, for example--which handles only Western European languages] in a source document is incapable of representing characters in a target language [Japanese, for example].)

nativeFileType - This parameter is ignored. The native file type is always plaintext.

nativeFileName - The name of the original source-language file that was previously converted to XLIFF. It is used to determine the name of the XLIFF file (<nativeFileName>.xliff) and the skeleton file (<nativeFileName>.skeleton). It is also used in constructing the file name of the output plaintext file.

baseDir - The directory (in the file system) from which input files (XLIFF and skeleton files) will be read, and to which the output file will be written.

notifier - Instance of a class that implements the Notifier

Returns:

Indicator of the status of the conversion.

Throws:

ConversionException - If a conversion exception is encountered.

getConversionProperty

public java.lang.Object getConversionProperty(java.lang.String property)

Return an object representing a format-specific (and converter-specific) property.

Specified by:

getConversionProperty in interface Converter

Parameters:

property - The name of the property to return.

Returns:

An Object that represents the property's value.

getFileType

public FileType getFileType()

Return the file type that this converter handles. (For importers, this means the file type that it imports to XLIFF; for exporters, it is the file type that ie exports to (from XLIFF).

Specified by:

getFileType in interface Converter

Returns:

the PLAINTEXT file type.

setConversionProperty

public void setConversionProperty(java.lang.String property,
                                  java.lang.Object value)
                           throws ConversionException

Set a format-specific property that might affect the way that the conversion occurs.

Note: This converter needs no format-specific properties. If any are passed, they will be silently ignored.

Specified by:

setConversionProperty in interface Converter

Parameters:

property - The name of the property

value - The value of the property

Throws:

ConversionException - If the property isn't recognized (and if it matters).