Package org.omegat.filters2.mozlang

Class MozillaLangFilter

java.lang.Object

org.omegat.filters2.AbstractFilter

org.omegat.filters2.mozlang.MozillaLangFilter

All Implemented Interfaces:

IFilter

public class MozillaLangFilter
extends AbstractFilter

Filter for support Mozilla lang files. Filter for lang files. Something about the format described on https://sourceforge.net/p/omegat/feature-requests/962/ https://developer.mozilla.org/en-US/docs/Web_Localizability/Localization_formats http://bedrock.readthedocs.org/en/latest/l10n.html Code adapted from the files: PoFilter.java and SrtFilter.java

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

Method Summary

Modifier and Type	Method	Description
java.io.BufferedReader	createReader(java.io.File infile, java.lang.String encoding)	Creating an input stream to read the source .lang file.
java.io.BufferedWriter	createWriter(java.io.File outfile, java.lang.String encoding)	Creating an output stream to save a localized .lang file.
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.
java.lang.String	getInEncodingLastParsedFile()	Returns the encoding of the last parsed source file.
boolean	hasOptions()	Returns true to indicate that Text filter has options.
boolean	isBilingual()	Indicates whether the filter is bilingual, and thus can be used as external TM (i.e.
boolean	isSourceEncodingVariable()	Whether source encoding can be varied by the user.
boolean	isTargetEncodingVariable()	Whether target encoding can be varied by the user.
void	processFile(java.io.File inFile, java.io.File outFile, FilterContext fc)

Methods inherited from class org.omegat.filters2.AbstractFilter

alignFile, changeOptions, getFuzzyMark, getHint, getTargetFilenamePatterns, 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, isEnabledInDefault

Constructor Detail

MozillaLangFilter

public MozillaLangFilter()

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

getDefaultInstances

public Instance[] getDefaultInstances()

Description copied from class: AbstractFilter

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.

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

createReader

public java.io.BufferedReader createReader(java.io.File infile,
                                           java.lang.String encoding)
                                    throws java.io.UnsupportedEncodingException,
                                           java.io.IOException

Creating an input stream to read the source .lang file.

NOTE: Mozilla lang files use always UTF-8 encoding without BOM.

Throws:

java.io.UnsupportedEncodingException

java.io.IOException

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 .lang file.

NOTE: Mozilla lang files use always UTF-8 encoding without BOM.

Throws:

java.io.UnsupportedEncodingException

java.io.IOException

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:

whether source encoding can be changed by the user

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:

whether target encoding can be changed by the user

getInEncodingLastParsedFile

public java.lang.String getInEncodingLastParsedFile()

Description copied from interface: IFilter

Returns the encoding of the last parsed source file.

Specified by:

getInEncodingLastParsedFile in interface IFilter

Overrides:

getInEncodingLastParsedFile in class AbstractFilter

Returns:

the encoding of the last parsed source file, or null when no file has been parsed yet.

processFile

public void processFile(java.io.File inFile,
                        java.io.File outFile,
                        FilterContext fc)
                 throws java.io.IOException,
                        TranslationException

Throws:

java.io.IOException

TranslationException

hasOptions

public boolean hasOptions()

Returns true to indicate that Text filter has options.

Specified by:

hasOptions in interface IFilter

Overrides:

hasOptions in class AbstractFilter

Returns:

False, because the LANG filter has not options.

isBilingual

public boolean isBilingual()

Description copied from interface: IFilter

Indicates whether the filter is bilingual, and thus can be used as external TM (i.e. files can be added to the /tm/ folder of an OmegaT project). Bilingual filters will supply both source strings and translation strings to IParseCallback.addEntry().

Returns:

true if the filter is bilingual