Package org.omegat.filters4

Class AbstractZipFilter

java.lang.Object

org.omegat.filters2.AbstractFilter

org.omegat.filters4.AbstractZipFilter

All Implemented Interfaces:

IFilter

Direct Known Subclasses:

MsOfficeFileFilter, SdlProject

public abstract class AbstractZipFilter
extends AbstractFilter

Filter for a file format which is an archive containing XML.

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

Method Summary

Modifier and Type	Method	Description
boolean	isFileSupported(File inFile, Map<String,String> config, FilterContext context)	Returns whether the file is supported by the filter, given the file and possible file's encoding ( null encoding means autodetect).
boolean	isSourceEncodingVariable()	Whether source encoding can be varied by the user.
boolean	isTargetEncodingVariable()	Whether target encoding can be varied by the user.
void	processFile(File inFile, File outFile, FilterContext fc)	Processes a ZIP file.
static String	readZipEntryContent(ZipInputStream zipInputStream)	Read the content of the entry from the ZipInputStream as a string.

Methods inherited from class org.omegat.filters2.AbstractFilter

alignFile, changeOptions, getDefaultInstances, getFileFormatName, getFuzzyMark, getHint, getInEncodingLastParsedFile, getTargetFilenamePatterns, hasOptions, 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, isBilingual, isEnabledInDefault

Method Details

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 autodetect 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

isFileSupported

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

Description copied from class: AbstractFilter

Returns whether the file is supported by the filter, given the file and possible file's encoding ( null encoding means autodetect). Default implementation creates a reader and calls AbstractFilter.isFileSupported(BufferedReader). You should override only one of the two.

For example, DocBook files have .xml extension, as possibly many other XML files, so the filter should check a DTD of the document.

Specified by:

isFileSupported in interface IFilter

Overrides:

isFileSupported in class AbstractFilter

Parameters:

inFile - Source file.

config - filter's configuration options

context - Filter context.

Returns:

Does the filter support the file.

processFile

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

Processes a ZIP file.

Throws:

IOException

TranslationException

readZipEntryContent

public static String readZipEntryContent(ZipInputStream zipInputStream)
                                  throws IOException

Read the content of the entry from the ZipInputStream as a string.

Parameters:

zipInputStream - The ZipInputStream to read from.

Returns:

The content of the input stream as a string.

Throws:

IOException