Package org.omegat.filters3.xml

Class XMLFilter

java.lang.Object

org.omegat.filters2.AbstractFilter

org.omegat.filters3.xml.XMLFilter

All Implemented Interfaces:

IFilter, Translator

Direct Known Subclasses:

AndroidFilter, CamtasiaWindowsFilter, DocBookFilter, FlashFilter, HelpAndManualFilter, InfixFilter, L10nmgrFilter, OpenDocXMLFilter, OpenXMLXMLFilter, PropertiesFilter, RelaxNGFilter, ResXFilter, SchematronFilter, ScribusFilter, SvgFilter, TXMLFilter, Typo3Filter, VisioFilter, WiXFilter, WordpressFilter, XHTMLFilter, XLIFFFilter, XMLSpreadsheetFilter

public abstract class XMLFilter
extends AbstractFilter
implements Translator

Abstract basis filter for XML format filters: OpenDocument, DocBook etc. Ideally should allow creation of a new XML dialect filter by simply specifying translatable tags and attributes.

Field Summary

Fields inherited from class org.omegat.filters2.AbstractFilter

ENCODING_AUTO_HUMAN, TARGET_DEFAULT, TFP_EXTENSION, TFP_FILE_FILTER_NAME, TFP_FILE_SOURCE_ENCODING, TFP_FILE_TARGET_ENCODING, TFP_FILENAME, TFP_NAMEONLY, TFP_SYSTEM_HOST_NAME, TFP_SYSTEM_OS_ARCH, TFP_SYSTEM_OS_NAME, TFP_SYSTEM_OS_VERSION, TFP_SYSTEM_USER_NAME, TFP_TARGET_COUNTRY_CODE, TFP_TARGET_COUTRY_CODE, TFP_TARGET_LANG_CODE, TFP_TARGET_LANGUAGE, TFP_TARGET_LOCALE, TFP_TARGET_LOCALE_LCID, TFP_TIMESTAMP_LA, TFP_TIMESTAMP_LD, TFP_TIMESTAMP_LDD, TFP_TIMESTAMP_LH, TFP_TIMESTAMP_LHH, TFP_TIMESTAMP_LM, TFP_TIMESTAMP_LMM, TFP_TIMESTAMP_LS, TFP_TIMESTAMP_LSS, TFP_TIMESTAMP_LYYYY, TFP_TIMESTAMP_UD, TFP_TIMESTAMP_UEEE, TFP_TIMESTAMP_UEEEE, TFP_TIMESTAMP_UH, TFP_TIMESTAMP_UHH, TFP_TIMESTAMP_UM, TFP_TIMESTAMP_UMM, TFP_TIMESTAMP_UMMM

Constructor Summary

Constructors

Constructor	Description
XMLFilter(XMLDialect dialect)	Creates a new instance of XMLFilter

Method Summary

Modifier and Type	Method	Description
void	comment(@Nullable String comment)	Process comment.
BufferedReader	createReader(File inFile, String inEncoding)	Creates a special XML-encoding-aware reader of an input file.
BufferedWriter	createWriter(@Nullable File outFile, @Nullable String outEncoding)	Creates a writer of the translated file.
XMLDialect	getDialect()	Gives the dialect
@Nullable Language	getSourceLanguage()
@Nullable Language	getTargetLanguage()
boolean	isFileSupported(BufferedReader reader)	Returns whether the XML file is supported by the filter.
boolean	isInIgnored()	Returns true if the current section should be ignored by parser.
boolean	isSourceEncodingVariable()	Whether source encoding can be varied by the user.
boolean	isTargetEncodingVariable()	Target encoding can be varied by the user.
void	processFile(File inFile, @Nullable File outFile, FilterContext fc)	Processes an XML file.
void	tagEnd(String path)	Finish tag translation.
void	tagStart(String path, @Nullable Attributes atts)	Start tag translation.
void	text(@Nullable String text)	Process text.
String	translate(String entry, @Nullable List<ProtectedPart> protectedParts)	The method the Handler would call to pass translatable content to OmegaT core and receive translation.

Methods inherited from class org.omegat.filters2.AbstractFilter

alignFile, changeOptions, getDefaultInstances, getFileFormatName, getFuzzyMark, getHint, getInEncodingLastParsedFile, getTargetFilenamePatterns, hasOptions, isFileSupported, parseFile, setCallbacks, translateFile

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.omegat.filters2.IFilter

changeOptions, isBilingual, isEnabledInDefault

Constructor Details

XMLFilter

public XMLFilter(XMLDialect dialect)

Creates a new instance of XMLFilter

Method Details

getDialect

public XMLDialect getDialect()

Gives the dialect

createReader

public BufferedReader createReader(File inFile,
 String inEncoding)
                            throws IOException

Creates a special XML-encoding-aware reader of an input file.

Specified by:

createReader in interface Translator

Parameters:

inFile - The source file.

inEncoding - Encoding of the source file, if the filter supports it. Otherwise, it should be null.

Returns:

The reader of the source file.

Throws:

UnsupportedEncodingException - Thrown if JVM doesn't support the specified inEncoding.

IOException - If any I/O Error occurs upon reader creation.

createWriter

public BufferedWriter createWriter(@Nullable File outFile,
 @Nullable String outEncoding)
                            throws UnsupportedEncodingException,
IOException

Creates a writer of the translated file. Accepts null output file -- returns a writer to /dev/null in this case ;-)

Specified by:

createWriter in interface Translator

Parameters:

outFile - The target file.

outEncoding - Encoding of the target file, if the filter supports it. Otherwise, null.

Returns:

The writer for the target file.

Throws:

UnsupportedEncodingException - Thrown if JVM doesn't support the specified outEncoding

IOException - If any I/O Error occurs upon writer creation

getTargetLanguage

public @Nullable Language getTargetLanguage()

Specified by:

getTargetLanguage in interface Translator

Returns:

The target language of the project

getSourceLanguage

public @Nullable Language getSourceLanguage()

Specified by:

getSourceLanguage in interface Translator

Returns:

The source language of the project

processFile

public void processFile(File inFile,
 @Nullable File outFile,
 FilterContext fc)
                 throws IOException,
TranslationException

Processes an XML file.

Throws:

IOException

TranslationException

isSourceEncodingVariable

public boolean isSourceEncodingVariable()

Whether source encoding can be varied by the user. If XML file has no encoding declaration, UTF-8 will be used, hence returns false by default.

Specified by:

isSourceEncodingVariable in interface IFilter

Specified by:

isSourceEncodingVariable in class AbstractFilter

Returns:

false

isTargetEncodingVariable

public boolean isTargetEncodingVariable()

Target encoding can be varied by the user.

Specified by:

isTargetEncodingVariable in interface IFilter

Specified by:

isTargetEncodingVariable in class AbstractFilter

Returns:

true

translate

public String translate(String entry,
 @Nullable List<ProtectedPart> protectedParts)

The method the Handler would call to pass translatable content to OmegaT core and receive translation.

Specified by:

translate in interface Translator

isFileSupported

public boolean isFileSupported(BufferedReader reader)

Returns whether the XML file is supported by the filter.
Reads OConsts.READ_AHEAD_LIMIT and tries to detect constrained text and match constraints defined in XMLDialect against them.

tagStart

public void tagStart(String path,
 @Nullable Attributes atts)

Description copied from interface: Translator

Start tag translation.

Specified by:

tagStart in interface Translator

Parameters:

path - path in the XML

atts - attributes

tagEnd

public void tagEnd(String path)

Description copied from interface: Translator

Finish tag translation.

Specified by:

tagEnd in interface Translator

Parameters:

path - path in the XML

comment

public void comment(@Nullable String comment)

Description copied from interface: Translator

Process comment.

Specified by:

comment in interface Translator

text

public void text(@Nullable String text)

Description copied from interface: Translator

Process text.

Specified by:

text in interface Translator

isInIgnored

public boolean isInIgnored()

Description copied from interface: Translator

Returns true if the current section should be ignored by parser.

Specified by:

isInIgnored in interface Translator