org.omegat.filters2.text.bundles

Class ResourceBundleFilter

java.lang.Object

org.omegat.filters2.AbstractFilter

org.omegat.filters2.text.bundles.ResourceBundleFilter

All Implemented Interfaces:

IFilter

public class ResourceBundleFilter
extends AbstractFilter

Filter to support Java Resource Bundles - the files that are used to I18ze Java applications.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.String>	align
static java.lang.String	DEFAULT_TARGET_ENCODING
static java.lang.String	DO_NOT_TRANSLATE_COMMENT Key=value pairs with a preceding comment containing this string are not translated, and are output verbatim.
static java.lang.String	OPTION_DONT_UNESCAPE_U_LITERALS
static java.lang.String	OPTION_REMOVE_STRINGS_UNTRANSLATED

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
ResourceBundleFilter()

Method Summary

Modifier and Type	Method and Description
protected void	alignFile(java.io.BufferedReader sourceFile, java.io.BufferedReader translatedFile, FilterContext fc) Align source file against translated file.
java.util.Map<java.lang.String,java.lang.String>	changeOptions(java.awt.Window parent, java.util.Map<java.lang.String,java.lang.String> config) Show change options dialog for able to change options.
java.io.BufferedWriter	createWriter(java.io.File outfile, java.lang.String encoding) Creating an output stream to save a localized resource bundle.
Instance[]	getDefaultInstances() The default encoding is OConsts.ASCII
java.lang.String	getFileFormatName() Human-readable name of the File Format this filter supports.
protected java.lang.String	getOutputEncoding(FilterContext fc) Get the output encoding.
boolean	hasOptions() Returns true to indicate that Java Resource Bundles filter has options.
boolean	isSourceEncodingVariable() Whether source encoding can be varied by the user.
boolean	isTargetEncodingVariable() Whether target encoding can be varied by the user.
protected java.lang.String	normalizeInputLine(java.lang.String line) Processes an input line for use in OmegaT by doing the following: Converts ASCII-encoded \\uxxxx chars to normal characters.
protected java.lang.String	process(java.lang.String key, java.lang.String value, java.lang.String c)
void	processFile(java.io.BufferedReader reader, java.io.BufferedWriter outfile, FilterContext fc) Doing the processing of the file...

Methods inherited from class org.omegat.filters2.AbstractFilter

alignFile, changeOptions, createReader, getFuzzyMark, getHint, getInEncodingLastParsedFile, getInputEncoding, getTargetFilenamePatterns, isFileSupported, isFileSupported, parseFile, processEntry, processEntry, processFile, 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

isBilingual

Field Detail

DO_NOT_TRANSLATE_COMMENT

public static final java.lang.String DO_NOT_TRANSLATE_COMMENT

Key=value pairs with a preceding comment containing this string are not translated, and are output verbatim.

TODO: Make this optional

See Also:

Constant Field Values

OPTION_REMOVE_STRINGS_UNTRANSLATED

public static final java.lang.String OPTION_REMOVE_STRINGS_UNTRANSLATED

See Also:

Constant Field Values

OPTION_DONT_UNESCAPE_U_LITERALS

public static final java.lang.String OPTION_DONT_UNESCAPE_U_LITERALS

See Also:

Constant Field Values

DEFAULT_TARGET_ENCODING

public static final java.lang.String DEFAULT_TARGET_ENCODING

align

protected java.util.Map<java.lang.String,java.lang.String> align

Constructor Detail

ResourceBundleFilter

public ResourceBundleFilter()

Method Detail

getFileFormatName

public java.lang.String getFileFormatName()

Description copied from class: AbstractFilter

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

isSourceEncodingVariable

public boolean isSourceEncodingVariable()

Description copied from class: AbstractFilter

Whether source encoding can be varied by the user.

True means that OmegaT should handle all the encoding mess.

Return false to state that your filter doesn't need encoding management provided by OmegaT, because it either autodetects the encoding based on file contents (like HTML filter does) or the encoding is fixed (like in OpenOffice files).

Specified by:

isSourceEncodingVariable in interface IFilter

Specified by:

isSourceEncodingVariable in class AbstractFilter

Returns:

true, because it is possible to change source encoding

isTargetEncodingVariable

public boolean isTargetEncodingVariable()

Description copied from class: AbstractFilter

Whether target encoding can be varied by the user.

True means that OmegaT should handle all the encoding mess.

Return false to state that your filter doesn't need encoding management provided by OmegaT, because the encoding is fixed (like in OpenOffice files), or for some other reason.

Specified by:

isTargetEncodingVariable in interface IFilter

Specified by:

isTargetEncodingVariable in class AbstractFilter

Returns:

true, because it is possible to change target encoding

getDefaultInstances

public Instance[] getDefaultInstances()

The default encoding is OConsts.ASCII

Specified by:

getDefaultInstances in interface IFilter

Specified by:

getDefaultInstances in class AbstractFilter

Returns:

Default filter instances

createWriter

public java.io.BufferedWriter createWriter(java.io.File outfile,
                                           java.lang.String encoding)
                                    throws java.io.UnsupportedEncodingException,
                                           java.io.IOException

Creating an output stream to save a localized resource bundle.

NOTE: the name of localized resource bundle is different from the name of original one. e.g. "Bundle.properties" -> Russian = "Bundle_ru.properties"

Overrides:

createWriter in class AbstractFilter

Parameters:

outfile - The target file

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

Returns:

The writer for the target file

Throws:

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

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

getOutputEncoding

protected java.lang.String getOutputEncoding(FilterContext fc)

Description copied from class: AbstractFilter

Get the output encoding. If it's not set in the FilterContext (setting is "<auto>") and the filter allows (AbstractFilter.isTargetEncodingVariable()):

• Reuse the input encoding if it's Unicode
• If the input was not Unicode, fall back to UTF-8.

The result may be null.

Overrides:

getOutputEncoding in class AbstractFilter

Returns:

normalizeInputLine

protected java.lang.String normalizeInputLine(java.lang.String line)
                                       throws java.io.IOException,
                                              TranslationException

Processes an input line for use in OmegaT by doing the following:

• Converts ASCII-encoded \\uxxxx chars to normal characters.
• Converts \r, \n and \t to CR, line feed and tab.
• But! Keeps a backspace in '\ ', '\=', '\:', etc. (non-trimmable space or non-key-value-breaking equals).

Throws:

java.io.IOException

TranslationException

processFile

public void processFile(java.io.BufferedReader reader,
                        java.io.BufferedWriter outfile,
                        FilterContext fc)
                 throws java.io.IOException,
                        TranslationException

Doing the processing of the file...

Specified by:

processFile in class AbstractFilter

Parameters:

reader - Reader of the source file. It's the result of calling AbstractFilter.createReader(File,String).

outfile - Writer of the target file on compilation (the result of calling AbstractFilter.createWriter(File, String)), or a fictive writer to /dev/null.

Throws:

java.io.IOException - In case of any I/O error.

TranslationException - Should be thrown when processed file has any format defects.

process

protected java.lang.String process(java.lang.String key,
                                   java.lang.String value,
                                   java.lang.String c)

alignFile

protected void alignFile(java.io.BufferedReader sourceFile,
                         java.io.BufferedReader translatedFile,
                         FilterContext fc)
                  throws java.lang.Exception

Description copied from class: AbstractFilter

Align source file against translated file. If this function is not overridden, then alignment in console mode will not be available for this filter. Implementations should call entryAlignCallback.addTranslation

Overrides:

alignFile in class AbstractFilter

Parameters:

sourceFile - source file

translatedFile - translated file

Throws:

java.lang.Exception

changeOptions

public java.util.Map<java.lang.String,java.lang.String> changeOptions(java.awt.Window parent,
                                                                      java.util.Map<java.lang.String,java.lang.String> config)

Description copied from interface: IFilter

Show change options dialog for able to change options.

Parameters:

parent - parent window

config - old options

Returns:

new options or null if options not changed

hasOptions

public boolean hasOptions()

Returns true to indicate that Java Resource Bundles filter has options.

Specified by:

hasOptions in interface IFilter

Overrides:

hasOptions in class AbstractFilter

Returns:

True if the filter has any options, and false otherwise.