org.omegat.filters2.text.ilias

Class ILIASFilter

java.lang.Object

org.omegat.filters2.AbstractFilter

org.omegat.filters2.text.ilias.ILIASFilter

All Implemented Interfaces:

IFilter

public class ILIASFilter
extends AbstractFilter

Filter to support language files for ILIAS. The files are a kind of UTF8 encoded text where the lines look like module_name#:#identifier#:#string to translate where neither module_name, nor identifier can be modified but must be copied into the translated version as they are including #:# separators. The file contains a header that should be copied into the translated version. The translated stings should not contain any \n\r symbols but may include simple HTML entities such as <p> ... </p> and <br />

See Also:

docs

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.String>	align

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

Method Summary

Modifier and Type	Method and Description
protected void	alignFile(java.io.BufferedReader sourceFile, java.io.BufferedReader translatedFile, FilterContext fc) Align source file against translated file.
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.
protected boolean	isFileSupported(java.io.BufferedReader reader) Returns whether the file is supported by the filter, given the reader with file's contents.
boolean	isSourceEncodingVariable() Whether source encoding can be varied by the user.
boolean	isTargetEncodingVariable() Whether target encoding can be varied by the user.
void	processFile(java.io.BufferedReader reader, java.io.BufferedWriter outfile, FilterContext fc) Doing the processing of the file...

Methods inherited from class org.omegat.filters2.AbstractFilter

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

changeOptions, isBilingual

Field Detail

align

protected java.util.Map<java.lang.String,java.lang.String> align

Constructor Detail

ILIASFilter

public ILIASFilter()

Method Detail

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

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

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

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

processFile

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

Doing the processing of the file...

Specified by:

processFile in class AbstractFilter

Parameters:

reader -

outfile -

Throws:

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

isFileSupported

protected boolean isFileSupported(java.io.BufferedReader reader)

Description copied from class: AbstractFilter

Returns whether the file is supported by the filter, given the reader with file's contents. There exists a version of this method that takes file and encoding #isFileSupported(File, Map, FilterContext)). You should override only one of the two.

By default returns true, because this method should be overriden only by filters that differentiate input files not by extensions, but by file's content.

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

Overrides:

isFileSupported in class AbstractFilter

Parameters:

reader - The reader of the source file

Returns:

Does the filter support the file

alignFile

protected void alignFile(java.io.BufferedReader sourceFile,
                         java.io.BufferedReader translatedFile,
                         FilterContext fc)
                  throws java.lang.Exception

Description copied from class: AbstractFilter

Align source file against translated file. If this function is not overridden, then alignment in console mode will not be available for this filter. Implementations should call entryAlignCallback.addTranslation

Overrides:

alignFile in class AbstractFilter

Parameters:

sourceFile - source file

translatedFile - translated file

Throws:

java.lang.Exception