file2xliff4j
Class RTFImporter

java.lang.Object
  file2xliff4j.OdfImporter
      file2xliff4j.OOoTextImporter
          file2xliff4j.RTFImporter

All Implemented Interfaces:

Converter

public class RTFImporter
extends OOoTextImporter
implements Converter

The RTFImporter is used to import RTF documents, converting them to XLIFF.

Author:

Shane Perry <shane@lingotek.com>

Field Summary

Fields inherited from interface file2xliff4j.Converter

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

Constructor Summary

RTFImporter()
Constructor for the word importer

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 a RTF document to XLIFF, creating xliff, skeleton and format files as output.
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 a RTF document to XLIFF, creating xliff, skeleton and format files as output.
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

RTFImporter

public RTFImporter()

Constructor for the word importer

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 a RTF document to XLIFF, creating xliff, skeleton and format files as output.

In the present implementation, the RTFImporter uses OpenOffice.org to convert the RTF Document to an OpenOffice.org OpenDocument Text (odt) document, then calls upon its superclass (OOoTextImporter) to complete the conversion of the resulting file to XLIFF.

Specified by:

convert in interface Converter

Overrides:

convert in class OOoTextImporter

Parameters:

mode - The mode of conversion (TO_XLIFF in this case).

language - The language of the input file.

phaseName - The target phase-name. This value is ignored.

maxPhase - The maximum phase number. This value is ignored.

nativeEncoding - The encoding of the input file. This parameter is ignored for RTF documents.

nativeFileType - The type of the original native file. This parameter provides the value for the datatype attribute of the XLIFF's file element. For this importer, use RTF.

nativeFileName - The name of the input file. (It will likely be a file whose filename ends in ".rtf")

baseDir - The directory that contains the input doc file--from which we will read the input file. This is also the directory in which the output xliff, skeleton and format files (and any other intermediate or temporary files) will be written.

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

boundary - The boundary on which to segment translation units (e.g., on paragraph or sentence boundaries)

generatedFileName - If non-null, the converter will write the name of the file (without parent directories) to which the generated XLIFF 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 a RTF document to XLIFF, creating xliff, skeleton and format files as output.

In the present implementation, the RTFImporter uses OpenOffice.org to convert the RTF Document to an OpenOffice.org OpenDocument Text (odt) document, then calls upon its superclass (OOoTextImporter) to complete the conversion of the resulting file to XLIFF.

Specified by:

convert in interface Converter

Overrides:

convert in class OOoTextImporter

Parameters:

mode - The mode of conversion (TO_XLIFF in this case).

language - The language of the input file.

phaseName - The target phase-name. This value is ignored.

maxPhase - The maximum phase number. This value is ignored.

nativeEncoding - The encoding of the input file. This parameter is ignored for RTF documents.

nativeFileType - The type of the original native file. This parameter provides the value for the datatype attribute of the XLIFF's file element. For this importer, use RTF.

nativeFileName - The name of the input file. (It will likely be a file whose filename ends in ".rtf")

baseDir - The directory that contains the input doc file--from which we will read the input file. This is also the directory in which the output xliff, skeleton and format files (and any other intermediate or temporary files) will be written.

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

boundary - The boundary on which to segment translation units (e.g., on paragraph or sentence boundaries)

generatedFileName - If non-null, the converter will write the name of the file (without parent directories) to which the generated XLIFF 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 a RTF document to XLIFF, creating xliff, skeleton and format files as output.

In the present implementation, the RTFImporter uses OpenOffice.org to convert the RTF Document to an OpenOffice.org OpenDocument Text (odt) document, then calls upon its superclass (OOoTextImporter) to complete the conversion of the resulting file to XLIFF.

Specified by:

convert in interface Converter

Overrides:

convert in class OOoTextImporter

Parameters:

mode - The mode of conversion (TO_XLIFF in this case).

language - The language of the input file.

phaseName - The target phase-name. This value is ignored.

maxPhase - The maximum phase number. This value is ignored.

nativeEncoding - The encoding of the input file. This parameter is ignored for RTF documents.

nativeFileType - The type of the original native file. This parameter provides the value for the datatype attribute of the XLIFF's file element. For this importer, use RTF.

nativeFileName - The name of the input file. (It will likely be a file whose filename ends in ".rtf")

baseDir - The directory that contains the input doc file--from which we will read the input file. This is also the directory in which the output xliff, skeleton and format files (and any other intermediate or temporary files) will be written.

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

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

Overrides:

getConversionProperty in class OOoTextImporter

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

Overrides:

getFileType in class OOoTextImporter

Returns:

the RTF 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

Overrides:

setConversionProperty in class OOoTextImporter

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).