file2xliff4j
Class XulDtdImporter

java.lang.Object
  file2xliff4j.XulDtdImporter

All Implemented Interfaces:

Converter

public class XulDtdImporter
extends java.lang.Object
implements Converter

Import to XLIFF a Document Type Definition (DTD) file that declares entities for use in XML User Interface Language (XUL) localization.

See XUL Tutorial:Localization for more information about the DTD's this importer handles.

On Linux, the DTDs this converter converts are located in a jar file located at (for example):

 /usr/lib[64]/firefox-1.5.0.7/extensions/langpack-ll-CC@firefox.mozilla.org/chrome/ll-CC.jar
 

where ll-CC represents an ISO language code.

Within the ll-CC.jar file, DTDs are located in the about/browser directory.

Author:

Weldon Whipple <weldon@lingotek.com>

Field Summary

Fields inherited from interface file2xliff4j.Converter

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

Constructor Summary

XulDtdImporter()
Create an XulDtdImporter

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) Extract the entity declarations from a DTD, generating 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) Extract the entity declarations from a DTD, generating 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.
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

XulDtdImporter

public XulDtdImporter()

Create an XulDtdImporter

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

Extract the entity declarations from a DTD, generating 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 input file.

nativeEncoding - The encoding of the properties file. This value is ignored. (Standard UTF-8 is assumed.)

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

nativeFileName - The name of the input properties file.

baseDir - The directory that contains the input properties file--from which we will read the input file. This is also the directory in 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 property 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

Extract the entity declarations from a DTD, generating 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 input file.

nativeEncoding - The encoding of the properties file. This value is ignored. (Standard UTF-8 is assumed.)

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

nativeFileName - The name of the input properties file.

baseDir - The directory that contains the input properties file--from which we will read the input file. This is also the directory in 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 property 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.

Extract the entity declarations from a DTD, generating 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 input file.

nativeEncoding - The encoding of the properties file. This value is ignored. (Standard UTF-8 is assumed.)

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

nativeFileName - The name of the input properties file.

baseDir - The directory that contains the input properties file--from which we will read the input file. This is also the directory in 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 Java Properties (Resource Bundle) 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).