org.omegat.filters2.html2

Class HTMLFilter2

java.lang.Object

org.omegat.filters2.AbstractFilter

org.omegat.filters2.html2.HTMLFilter2

All Implemented Interfaces:

IFilter

Direct Known Subclasses:

HHCFilter2

public class HTMLFilter2
extends AbstractFilter

A filter to translate HTML and XHTML files.

Some useful discussion why HTML filter should behave like it does, happened on a bug report devoted to compressing space.

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
HTMLFilter2() Creates a new instance of HTMLFilter2

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> config) (X)HTML Filter shows a modal dialog to edit its own options.
boolean	checkDoSkipMetaTag(java.lang.String key, java.lang.String value)
boolean	checkIgnoreTags(java.lang.String key, java.lang.String value)
java.io.BufferedReader	createReader(java.io.File infile, java.lang.String encoding) Customized version of creating input reader for HTML files, aware of encoding by using EncodingAwareReader class.
java.io.BufferedWriter	createWriter(java.io.File outfile, java.lang.String encoding) Customized version of creating an output stream for HTML files, appending charset meta by using HTMLWriter class.
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	getHint() Returns the editing hint for HTML filter.
java.lang.String	getInEncodingLastParsedFile() Returns the encoding of the last parsed source file.
java.lang.String	getTargetEncoding() Returns the encoding of the html writer (if already set)
boolean	hasOptions() Returns true to indicate that (X)HTML 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.
java.lang.String	privateProcessEntry(java.lang.String entry, java.lang.String comment) Package-internal processEntry to give it to FilterVisitor
void	processFile(java.io.BufferedReader infile, java.io.BufferedWriter outfile, FilterContext fc) Processes a single file given a reader and a writer.
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, getFuzzyMark, getInputEncoding, getOutputEncoding, getTargetFilenamePatterns, isFileSupported, isFileSupported, parseFile, processEntry, processEntry, processFile, 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

HTMLFilter2

public HTMLFilter2()

Creates a new instance of HTMLFilter2

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

createReader

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

Customized version of creating input reader for HTML files, aware of encoding by using EncodingAwareReader class.

Overrides:

createReader in class AbstractFilter

Parameters:

infile - The source file.

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

Returns:

The reader for the source file

Throws:

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

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

See Also:

HTMLReader

createWriter

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

Customized version of creating an output stream for HTML files, appending charset meta by using HTMLWriter class.

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

See Also:

HTMLWriter

processFile

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

Description copied from class: AbstractFilter

Processes a single file given a reader and a writer. Generally this method should read strings from the input reader and write them to the output reader. In order to let OmegaT know what strings are translatable and to get their translation, filter should call AbstractFilter.processEntry(String) method.

Note that outFile is never null, even when the project is loading. (in this case it writes no nowhere, but anyway you may use it...)

If you need more control over processed files, override AbstractFilter.processFile(File, File, FilterContext) instead.

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.

privateProcessEntry

public java.lang.String privateProcessEntry(java.lang.String entry,
                                            java.lang.String comment)

Package-internal processEntry to give it to FilterVisitor

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

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

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

getHint

public java.lang.String getHint()

Returns the editing hint for HTML filter.

In English, the hint is as follows:
Note: Source File Encoding setting affects only the HTML files that have no encoding declaration inside. If HTML file has the encoding declaration, it will be used disregarding any value you set in this dialog.

Specified by:

getHint in interface IFilter

Overrides:

getHint in class AbstractFilter

Returns:

The hint for editing the filter in a non-geek language.

hasOptions

public boolean hasOptions()

Returns true to indicate that (X)HTML filter has options.

Specified by:

hasOptions in interface IFilter

Overrides:

hasOptions in class AbstractFilter

Returns:

True, because (X)HTML 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> config)

(X)HTML Filter shows a modal dialog to edit its own options.

Parameters:

currentOptions - Current options to edit.

Returns:

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

getTargetEncoding

public java.lang.String getTargetEncoding()

Returns the encoding of the html writer (if already set)

Returns:

the target encoding

checkDoSkipMetaTag

public boolean checkDoSkipMetaTag(java.lang.String key,
                                  java.lang.String value)

checkIgnoreTags

public boolean checkIgnoreTags(java.lang.String key,
                               java.lang.String value)

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.