org.omegat.filters3.xml.resx

Class ResXFilter

java.lang.Object

org.omegat.filters2.AbstractFilter

org.omegat.filters3.xml.XMLFilter

org.omegat.filters3.xml.resx.ResXFilter

All Implemented Interfaces:

IFilter

public class ResXFilter
extends XMLFilter

Filter for ResX files.

Field Summary

Fields inherited from class org.omegat.filters2.AbstractFilter

ENCODING_AUTO_HUMAN, entryAlignCallback, entryParseCallback, entryTranslateCallback, inEncodingLastParsedFile, processOptions, 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 and Description
ResXFilter() Creates a new instance of ResXFilter

Method Summary

Modifier and Type	Method and Description
Instance[]	getDefaultInstances() The default list of filter instances that this filter class has.
java.lang.String	getFileFormatName() Human-readable name of the File Format this filter supports.
boolean	isSourceEncodingVariable() Either the encoding can be read, or it is UTF-8.
boolean	isTargetEncodingVariable() Yes, ResX may be written out in a variety of encodings.
void	tagEnd(java.lang.String path) Finish tag translation.
void	tagStart(java.lang.String path, org.xml.sax.Attributes atts) Start tag translation.
void	text(java.lang.String text) Process text.
java.lang.String	translate(java.lang.String entry, java.util.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.filters3.xml.XMLFilter

comment, createReader, createWriter, getDialect, getSourceLanguage, getTargetLanguage, isFileSupported, isInIgnored, processFile, processFile

Methods inherited from class org.omegat.filters2.AbstractFilter

alignFile, alignFile, changeOptions, getFuzzyMark, getHint, getInEncodingLastParsedFile, getInputEncoding, getOutputEncoding, getTargetFilenamePatterns, hasOptions, isFileSupported, parseFile, processEntry, processEntry, requirePrevNextFields, setCallbacks, translateFile

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.omegat.filters2.IFilter

changeOptions, isBilingual

Constructor Detail

ResXFilter

public ResXFilter()

Creates a new instance of ResXFilter

Method Detail

getFileFormatName

public java.lang.String getFileFormatName()

Human-readable name of the File Format this filter supports.

Specified by:

getFileFormatName in interface IFilter

Specified by:

getFileFormatName in class AbstractFilter

Returns:

File format name

getDefaultInstances

public Instance[] getDefaultInstances()

The default list of filter instances that this filter class has. One filter class may have different filter instances, different by source file mask, encoding of the source file etc.

There is one pattern for when no source language or source culture are present in the filename, one for when only a source language is present and one for when both source language and source culture are present. In all three cases, the source language and/or source culture are eaten from the filename, assuming the source language/culture use '.' (dot) as the separator.

Note that the user may change the instances freely.

Specified by:

getDefaultInstances in interface IFilter

Specified by:

getDefaultInstances in class AbstractFilter

Returns:

Default filter instances

isSourceEncodingVariable

public boolean isSourceEncodingVariable()

Either the encoding can be read, or it is UTF-8.

Specified by:

isSourceEncodingVariable in interface IFilter

Overrides:

isSourceEncodingVariable in class XMLFilter

Returns:

false

isTargetEncodingVariable

public boolean isTargetEncodingVariable()

Yes, ResX may be written out in a variety of encodings.

Specified by:

isTargetEncodingVariable in interface IFilter

Overrides:

isTargetEncodingVariable in class XMLFilter

Returns:

true

tagStart

public void tagStart(java.lang.String path,
                     org.xml.sax.Attributes atts)

Start tag translation.

Overrides:

tagStart in class XMLFilter

Parameters:

path - path in the XML

atts - attributes

tagEnd

public void tagEnd(java.lang.String path)

Finish tag translation.

Overrides:

tagEnd in class XMLFilter

Parameters:

path - path in the XML

text

public void text(java.lang.String text)

Process text.

Overrides:

text in class XMLFilter

translate

public java.lang.String translate(java.lang.String entry,
                                  java.util.List<ProtectedPart> protectedParts)

Description copied from class: XMLFilter

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

Overrides:

translate in class XMLFilter