Package org.omegat.filters3.xml.openxml

Class OpenXMLFilter

java.lang.Object

org.omegat.filters2.AbstractFilter

org.omegat.filters3.xml.openxml.OpenXMLFilter

All Implemented Interfaces:

IFilter

public class OpenXMLFilter
extends AbstractFilter

Filter for Open XML file format.

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

Method Summary

Modifier and Type	Method	Description
@Nullable Map<String,String>	changeOptions(Window parent, Map<String,String> currentOptions)	OpenXML Filter shows a modal dialog to edit its own options.
int	compareZipEntries(ZipEntry z1, ZipEntry z2)
Instance[]	getDefaultInstances()	Extensions...
String	getFileFormatName()	Human-readable Open XML filter name.
String	getInEncodingLastParsedFile()	Returns the encoding of the last parsed source file.
boolean	hasOptions()	Returns true to indicate that the OpenXML filter has options.
boolean	isFileSupported(File inFile, Map<String,String> config, FilterContext fc)	Returns true if it's an Open XML file.
boolean	isSourceEncodingVariable()	The user cannot vary source encoding.
boolean	isTargetEncodingVariable()	The user cannot vary Target encoding.
static void	loadPlugins()	Register plugin into OmegaT.
void	processFile(File inFile, @Nullable File outFile, FilterContext fc)	Processes a single OpenXML file, which is actually a ZIP file consisting of many XML files, some of which should be translated.
static void	unloadPlugins()

Methods inherited from class org.omegat.filters2.AbstractFilter

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

isBilingual, isEnabledInDefault

Constructor Details

OpenXMLFilter

public OpenXMLFilter()

Method Details

loadPlugins

public static void loadPlugins()

Register plugin into OmegaT.

unloadPlugins

public static void unloadPlugins()

isFileSupported

public boolean isFileSupported(File inFile,
 Map<String,String> config,
 FilterContext fc)

Returns true if it's an Open XML file.

Specified by:

isFileSupported in interface IFilter

Overrides:

isFileSupported in class AbstractFilter

Parameters:

inFile - Source file.

config - filter's configuration options

fc - Filter context.

Returns:

Does the filter support the file.

processFile

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

Processes a single OpenXML file, which is actually a ZIP file consisting of many XML files, some of which should be translated.

Throws:

IOException

TranslationException

compareZipEntries

public int compareZipEntries(ZipEntry z1,
 ZipEntry z2)

getFileFormatName

public String getFileFormatName()

Human-readable Open XML filter name.

Specified by:

getFileFormatName in interface IFilter

Specified by:

getFileFormatName in class AbstractFilter

Returns:

File format name

getDefaultInstances

public Instance[] getDefaultInstances()

Extensions...

Specified by:

getDefaultInstances in interface IFilter

Specified by:

getDefaultInstances in class AbstractFilter

Returns:

Default filter instances

isSourceEncodingVariable

public boolean isSourceEncodingVariable()

The user cannot vary source encoding.

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

The user cannot vary Target encoding.

Specified by:

isTargetEncodingVariable in interface IFilter

Specified by:

isTargetEncodingVariable in class AbstractFilter

Returns:

whether target encoding can be changed by the user

hasOptions

public boolean hasOptions()

Returns true to indicate that the OpenXML filter has options.

Specified by:

hasOptions in interface IFilter

Overrides:

hasOptions in class AbstractFilter

Returns:

True, because the OpenXML filter has options.

changeOptions

public @Nullable Map<String,String> changeOptions(Window parent,
 Map<String,String> currentOptions)

OpenXML Filter shows a modal dialog to edit its own options.

Parameters:

currentOptions - Current options to edit.

parent - parent window

Returns:

Updated filter options if the user confirmed the changes, and current options otherwise.

getInEncodingLastParsedFile

public 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.