file2xliff4j
Class WinRcImporter

java.lang.Object
  file2xliff4j.WinRcImporter

All Implemented Interfaces:

Converter

public class WinRcImporter
extends java.lang.Object
implements Converter

Import a Microsoft Windows rc (resource) file.

Author:

Weldon Whipple <weldon@lingotek.com>

Field Summary

Fields inherited from interface file2xliff4j.Converter

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

Constructor Summary

WinRcImporter()
Create a Microsoft Windows rc file 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 Microsoft Windoes rc file to XLIFF, creating XLIFF and a skeleton file 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 Microsoft Windoes rc file to XLIFF, creating XLIFF and a skeleton file 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.
static java.nio.charset.Charset	readRcEncoding(java.lang.String rcFileName) Passed the name of a Windows RC file, try to determine its encoding.
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

WinRcImporter

public WinRcImporter()

Create a Microsoft Windows rc file 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 Microsoft Windoes rc file to XLIFF, creating XLIFF and a skeleton file as output.

Specified by:

convert in interface Converter

Parameters:

mode - The mode of conversion (to or from XLIFF). It should be ConversionMode.TO_XLIFF in this case.

language - The language of the translatable strings in the rc file.

nativeEncoding - The encoding of the rc file. If this parameter is null, the importer will attempt to determine the encoding from the rc file itself.

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

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

nativeFileType - The type of the original native file. This value is ignored (It is assumed to be WINRC.)

nativeFileName - The name of the Windows rc file.

baseDir - The directory that contains the input rc file--from which we will read the input file. This is also the directory to which the output xliff and skeleton files are written. The output files will be named as follows:

• <nativeFileName>.xliff
• <nativeFileName>.skeleton

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). This value is ignored. (Each string becomes one segment in the XLIFF.)

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 Microsoft Windoes rc file to XLIFF, creating XLIFF and a skeleton file as output.

Specified by:

convert in interface Converter

Parameters:

mode - The mode of conversion (to or from XLIFF). It should be ConversionMode.TO_XLIFF in this case.

language - The language of the translatable strings in the rc file.

nativeEncoding - The encoding of the rc file. If this parameter is null, the importer will attempt to determine the encoding from the rc file itself.

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

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

nativeFileType - The type of the original native file. This value is ignored (It is assumed to be WINRC.)

nativeFileName - The name of the Windows rc file.

baseDir - The directory that contains the input rc file--from which we will read the input file. This is also the directory to which the output xliff and skeleton files are written. The output files will be named as follows:

• <nativeFileName>.xliff
• <nativeFileName>.skeleton

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). This value is ignored. (Each string becomes one segment in the XLIFF.)

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 Microsoft Windoes rc file to XLIFF, creating XLIFF and a skeleton file as output.

Specified by:

convert in interface Converter

Parameters:

mode - The mode of conversion (to or from XLIFF). It should be ConversionMode.TO_XLIFF in this case.

language - The language of the translatable strings in the rc file.

nativeEncoding - The encoding of the rc file. If this parameter is null, the importer will attempt to determine the encoding from the rc file itself.

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

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

nativeFileType - The type of the original native file. This value is ignored (It is assumed to be WINRC.)

nativeFileName - The name of the Windows rc file.

baseDir - The directory that contains the input rc file--from which we will read the input file. This is also the directory to which the output xliff and skeleton files are written. The output files will be named as follows:

• <nativeFileName>.xliff
• <nativeFileName>.skeleton

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

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 Windows RC type.

readRcEncoding

public static java.nio.charset.Charset readRcEncoding(java.lang.String rcFileName)
                                               throws ConversionException

Passed the name of a Windows RC file, try to determine its encoding.

Parameters:

rcFileName - The name of a Windows RC file--fully qualified

Returns:

The encoding the file uses (or null if not apparent).

Throws:

ConversionException - if an error is encountered.

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