org.omegat.filters2.hhc

Class HHCFilter2

java.lang.Object

org.omegat.filters2.AbstractFilter

org.omegat.filters2.html2.HTMLFilter2

org.omegat.filters2.hhc.HHCFilter2

All Implemented Interfaces:

IFilter

public class HHCFilter2
extends HTMLFilter2

A filter to translate HHC and HHK files.

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

Method Summary

Modifier and Type	Method and Description
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 HHC filter.
boolean	hasOptions() Returns true to indicate that a filter has options.
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.html2.HTMLFilter2

changeOptions, checkDoSkipMetaTag, checkIgnoreTags, createReader, createWriter, getInEncodingLastParsedFile, getTargetEncoding, isSourceEncodingVariable, isTargetEncodingVariable, privateProcessEntry

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

HHCFilter2

public HHCFilter2()

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 HTMLFilter2

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.

Overrides:

processFile in class HTMLFilter2

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.

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

Overrides:

getFileFormatName in class HTMLFilter2

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

Overrides:

getDefaultInstances in class HTMLFilter2

Returns:

Default filter instances

getHint

public java.lang.String getHint()

Returns the editing hint for HHC filter.

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

Specified by:

getHint in interface IFilter

Overrides:

getHint in class HTMLFilter2

Returns:

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

hasOptions

public boolean hasOptions()

Returns true to indicate that a filter has options.

Specified by:

hasOptions in interface IFilter

Overrides:

hasOptions in class HTMLFilter2

Returns:

False, because HHC filter has no options.