|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.xml.sax.helpers.DefaultHandler file2xliff4j.XMLImporter
public class XMLImporter
The generic XML importer will convert most XML to XLIFF.
Field Summary |
---|
Fields inherited from interface file2xliff4j.Converter |
---|
BLKSIZE, formatSuffix, skeletonSuffix, startXliff, stylesTSkeletonSuffix, tSkeletonSuffix, xliffSuffix, xmlDeclaration |
Constructor Summary | |
---|---|
XMLImporter()
Constructor for the XML importer. |
Method Summary | |
---|---|
void |
characters(char[] ch,
int start,
int length)
Called whenever characters are encountered |
void |
comment(char[] text,
int start,
int length)
Method defined by the LexicalHandler interface that we *probably* don't care about. |
ConversionStatus |
convert(ConversionMode mode,
java.util.Locale language,
java.lang.String phaseName,
int maxPhase,
java.nio.charset.Charset nativeEncoding,
FileType nativeFileType,
java.lang.String inputXmlFileName,
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 inputXmlFileName,
java.lang.String baseDir,
Notifier notifier,
SegmentBoundary boundary,
java.io.StringWriter generatedFileName)
Convert an XML file to XLIFF. |
ConversionStatus |
convert(ConversionMode mode,
java.util.Locale language,
java.lang.String phaseName,
int maxPhase,
java.nio.charset.Charset nativeEncoding,
FileType nativeFileType,
java.lang.String inputXmlFileName,
java.lang.String baseDir,
Notifier notifier,
SegmentBoundary boundary,
java.io.StringWriter generatedFileName,
java.util.Set<f2xutils.XMLTuXPath> skipList)
Convert an XML file to XLIFF. |
void |
endCDATA()
Method called by the SAX parser when it encounters the end of a CDATA section. |
void |
endDocument()
When the end-of-document is encountered, write what follows the final translation unit. |
void |
endDTD()
Method defined by the LexicalHandler interface that we don't care about. |
void |
endElement(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String qualifiedName)
Method called whenever an end element is encountered |
void |
endEntity(java.lang.String name)
Method that the SAX parser calls whenever it reaches the end of an entity (e.g. |
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. |
void |
setDocumentLocator(org.xml.sax.Locator locator)
Method called by the SAX parser before it calls startDocument. |
void |
startCDATA()
Method called by the SAX parser when it encounters the start of a CDATA section. |
void |
startDocument()
Method called by the SAX parser at the beginning of document parsing. |
void |
startDTD(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId)
Method defined by the LexicalHandler interface that we don't care about. |
void |
startElement(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String qualifiedName,
org.xml.sax.Attributes atts)
Method called whenever a start element is encountered |
void |
startEntity(java.lang.String name)
Method that the SAX parser calls whenever it encounters an entity (e.g. |
Methods inherited from class org.xml.sax.helpers.DefaultHandler |
---|
endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, skippedEntity, startPrefixMapping, unparsedEntityDecl, warning |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public XMLImporter()
Method Detail |
---|
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 inputXmlFileName, java.lang.String baseDir, Notifier notifier, SegmentBoundary boundary, java.io.StringWriter generatedFileName, java.util.Set<f2xutils.XMLTuXPath> skipList) throws ConversionException
convert
in interface Converter
mode
- The mode of conversion (to or from XLIFF). The value must be
TO_XLIFF.language
- The language of the XML file to be imported.phaseName
- The name of the phase to convert. (This parameter is
currently ignored by this importer.)maxPhase
- The maximum phase number. This value is currently ignored.nativeEncoding
- The encoding of the input XML file. This value is
currently ignored, allowing the SAX parser to interpret any byte
order marks and encoding specified in the input file.nativeFileType
- The type of the input file. Must be XML.inputXmlFileName
- The name of the input XML file.baseDir
- The directory that contains the input XML file--from which
we will read the input file. This is also the directory in which the output
xliff, skeleton and format files will be written. The output files will
be named as follows:
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
- A set of potential translatable structures to omit. This
converter requires that the Set consist of XMLTuXPath objects.
ConversionException
- If a conversion exception is encountered.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 inputXmlFileName, java.lang.String baseDir, Notifier notifier, SegmentBoundary boundary, java.io.StringWriter generatedFileName) throws ConversionException
convert
in interface Converter
mode
- The mode of conversion (to or from XLIFF). The value must be
TO_XLIFF.language
- The language of the XML file to be imported.phaseName
- The name of the phase to convert. (This parameter is
currently ignored by this importer.)maxPhase
- The maximum phase number. This value is currently ignored.nativeEncoding
- The encoding of the input XML file. This value is
currently ignored, allowing the SAX parser to interpret any byte
order marks and encoding specified in the input file.nativeFileType
- The type of the input file. Must be XML.inputXmlFileName
- The name of the input XML file.baseDir
- The directory that contains the input XML file--from which
we will read the input file. This is also the directory in which the output
xliff, skeleton and format files will be written. The output files will
be named as follows:
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.
ConversionException
- If a conversion exception is encountered.@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 inputXmlFileName, java.lang.String baseDir, Notifier notifier) throws ConversionException
convert
in interface Converter
mode
- The mode of conversion (to or from XLIFF). The value must be
TO_XLIFF.language
- The language of the XML file to be imported.phaseName
- The name of the phase to convert. (This parameter is
currently ignored by this importer.)maxPhase
- The maximum phase number. This value is currently ignored.nativeEncoding
- The encoding of the input XML file. This value is
currently ignored, allowing the SAX parser to interpret any byte
order marks and encoding specified in the input file.nativeFileType
- The type of the input file. Must be XML.inputXmlFileName
- The name of the input XML file.baseDir
- The directory that contains the input XML file--from which
we will read the input file. This is also the directory in which the output
xliff, skeleton and format files will be written. The output files will
be named as follows:
notifier
- Instance of a class that implements the Notifier
interface (to send notifications in case of conversion error).
ConversionException
- If a conversion exception is encountered.public void setDocumentLocator(org.xml.sax.Locator locator)
setDocumentLocator
in interface org.xml.sax.ContentHandler
setDocumentLocator
in class org.xml.sax.helpers.DefaultHandler
locator
- A reference to a document locatorpublic void startDocument() throws org.xml.sax.SAXException
startDocument
in interface org.xml.sax.ContentHandler
startDocument
in class org.xml.sax.helpers.DefaultHandler
org.xml.sax.SAXException
- If the SAX parser needs to report errors.public void startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qualifiedName, org.xml.sax.Attributes atts) throws org.xml.sax.SAXException
startElement
in interface org.xml.sax.ContentHandler
startElement
in class org.xml.sax.helpers.DefaultHandler
namespaceURI
- The URI of the namespacelocalName
- The local name (without prefix), or the empty string if
Namespace processing is not being performed.qualifiedName
- The qualified name (with prefix), or the empty string
if qualified names are not availableatts
- The specified or defaulted attributes.
org.xml.sax.SAXException
- If the SAX parser needs to report errors.public void endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qualifiedName) throws org.xml.sax.SAXException
endElement
in interface org.xml.sax.ContentHandler
endElement
in class org.xml.sax.helpers.DefaultHandler
namespaceURI
- The URI of the namespacelocalName
- The local name (without prefix), or the empty string if Namespace processing is not being performed.qualifiedName
- The qualified name (with prefix), or the empty string if qualified names are not available
org.xml.sax.SAXException
- If the SAX parser needs to report errors.public void characters(char[] ch, int start, int length) throws org.xml.sax.SAXException
characters
in interface org.xml.sax.ContentHandler
characters
in class org.xml.sax.helpers.DefaultHandler
ch
- Array containing characters encounteredstart
- Position in array of first applicable characterlength
- How many characters are of interest?
org.xml.sax.SAXException
- If the SAX parser needs to report errors.public void endDocument() throws org.xml.sax.SAXException
endDocument
in interface org.xml.sax.ContentHandler
endDocument
in class org.xml.sax.helpers.DefaultHandler
java.lang.IOException
- If unable to flush the output streams.
org.xml.sax.SAXException
public void startEntity(java.lang.String name) throws org.xml.sax.SAXException
The inEntity instance variable is checked by the characters method of the ContentHandler (DefaultHandler) extension (above). The SAX parser calls the characters method whenever it expands an entity, passing it *only* the expansion of the entity it just encountered. Since we want to write out the unexpanded version of the entity, this (startEntity) method writes out the entity, and characters() just returns without outputting the expansion of the entity (if inEntity is true).
Note: the endEntity method (below) sets the inEntity variable to false.
startEntity
in interface org.xml.sax.ext.LexicalHandler
name
- The name of the entity (e.g. "lt", "gt", etc.--without a
leading ampersand or trailing semicolon.)
org.xml.sax.SAXException
- If the SAX parser needs to report errors.public void endEntity(java.lang.String name) throws org.xml.sax.SAXException
endEntity
in interface org.xml.sax.ext.LexicalHandler
name
- The name of the entity (e.g. "lt", "gt", etc.--without a
leading ampersand or trailing semicolon.)
org.xml.sax.SAXException
- If the SAX parser needs to report errors.public void startDTD(java.lang.String name, java.lang.String publicId, java.lang.String systemId) throws org.xml.sax.SAXException
startDTD
in interface org.xml.sax.ext.LexicalHandler
org.xml.sax.SAXException
- If the SAX parser needs to report errors.public void endDTD() throws org.xml.sax.SAXException
endDTD
in interface org.xml.sax.ext.LexicalHandler
org.xml.sax.SAXException
- If the SAX parser needs to report errors.public void startCDATA() throws org.xml.sax.SAXException
startCDATA
in interface org.xml.sax.ext.LexicalHandler
org.xml.sax.SAXException
- If the SAX parser needs to report errors.public void endCDATA() throws org.xml.sax.SAXException
endCDATA
in interface org.xml.sax.ext.LexicalHandler
org.xml.sax.SAXException
- If the SAX parser needs to report errors.public void comment(char[] text, int start, int length) throws org.xml.sax.SAXException
comment
in interface org.xml.sax.ext.LexicalHandler
text
- Array containing characters encounteredstart
- Position in array of first applicable characterlength
- How many characters are of interest?
org.xml.sax.SAXException
- If the SAX parser needs to report errors.public java.lang.Object getConversionProperty(java.lang.String property)
getConversionProperty
in interface Converter
property
- The name of the property to return.
public FileType getFileType()
getFileType
in interface Converter
public void setConversionProperty(java.lang.String property, java.lang.Object value) throws ConversionException
Note: This converter needs no format-specific properties. If any are passed, they will be silently ignored.
setConversionProperty
in interface Converter
property
- The name of the propertyvalue
- The value of the property
ConversionException
- If the property isn't recognized (and if it matters).
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |