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

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	changeOptions(java.awt.Window parent, java.util.Map<java.lang.String,java.lang.String> currentOptions) OpenXML Filter shows a modal dialog to edit its own options.
int	compareZipEntries(java.util.zip.ZipEntry z1, java.util.zip.ZipEntry z2)
Instance[]	getDefaultInstances() Extensions...
java.lang.String	getFileFormatName() Human-readable Open XML filter name.
java.lang.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(java.io.File inFile, java.util.Map<java.lang.String,java.lang.String> config, FilterContext fc) Returns true if it's an Open XML file.
boolean	isSourceEncodingVariable() Source encoding cannot be varied by the user.
boolean	isTargetEncodingVariable() Target encoding cannot be varied by the user.
protected void	processFile(java.io.BufferedReader inFile, java.io.BufferedWriter outFile, FilterContext fc) Not implemented.
void	processFile(java.io.File inFile, java.io.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.
protected boolean	requirePrevNextFields() Method can be overridden to return true, in case you want previous and next segment to be included in the search for a translation, when alternative translations are provided by the user.

Methods inherited from class org.omegat.filters2.AbstractFilter

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

Constructor Detail

OpenXMLFilter

public OpenXMLFilter()

Method Detail

requirePrevNextFields

protected boolean requirePrevNextFields()

Description copied from class: AbstractFilter

Method can be overridden to return true, in case you want previous and next segment to be included in the search for a translation, when alternative translations are provided by the user. (normally, only the filename is used) Technically it means that parsing happens in two passes and prev/next segments will be linked, so it comes with a cost

Overrides:

requirePrevNextFields in class AbstractFilter

isFileSupported

public boolean isFileSupported(java.io.File inFile,
                               java.util.Map<java.lang.String,java.lang.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(java.io.File inFile,
                        java.io.File outFile,
                        FilterContext fc)
                 throws java.io.IOException,
                        TranslationException

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

Overrides:

processFile in class AbstractFilter

Parameters:

inFile - The source file.

outFile - The target file.

fc - Filter context.

Throws:

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

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

compareZipEntries

public int compareZipEntries(java.util.zip.ZipEntry z1,
                             java.util.zip.ZipEntry z2)

getFileFormatName

public java.lang.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()

Source encoding cannot be varied by the user.

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

Target encoding cannot be varied by the user.

Specified by:

isTargetEncodingVariable in interface IFilter

Specified by:

isTargetEncodingVariable in class AbstractFilter

Returns:

whether target encoding can be changed by the user

processFile

protected void processFile(java.io.BufferedReader inFile,
                           java.io.BufferedWriter outFile,
                           FilterContext fc)
                    throws java.io.IOException,
                           TranslationException

Not implemented.

Specified by:

processFile in class AbstractFilter

Parameters:

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

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 java.util.Map<java.lang.String,java.lang.String> changeOptions(java.awt.Window parent,
                                                                      java.util.Map<java.lang.String,java.lang.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 user confirmed the changes, and current options otherwise.

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.