org.omegat.filters2.text

Class TextFilter

java.lang.Object

org.omegat.filters2.AbstractFilter

org.omegat.filters2.text.TextFilter

All Implemented Interfaces:

IFilter

public class TextFilter
extends AbstractFilter

Filter to support plain text files (in various encodings).

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ISO88592
static java.lang.String	OPTION_LINE_LENGTH Length at which a line break should occur in target documents
static java.lang.String	OPTION_MAX_LINE_LENGTH Maximum line length in target documents
static java.lang.String	OPTION_SEGMENT_ON
static java.lang.String	SEGMENT_BREAKS Text filter should segmentOn text into paragraphs on line breaks.
static java.lang.String	SEGMENT_EMPTYLINES Default.
static java.lang.String	SEGMENT_NEVER Text filter should not segmentOn text into paragraphs.

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

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) Show change options dialog for able to change options.
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.
boolean	hasOptions() Returns true to indicate that Text 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.
static void	loadPlugins() Register plugin into OmegaT.
void	processFile(java.io.BufferedReader in, java.io.BufferedWriter out, 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.
static void	unloadPlugins()

Methods inherited from class org.omegat.filters2.AbstractFilter

alignFile, alignFile, changeOptions, createReader, createWriter, getFuzzyMark, getHint, getInEncodingLastParsedFile, 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

Field Detail

ISO88592

public static final java.lang.String ISO88592

See Also:

Constant Field Values

SEGMENT_BREAKS

public static final java.lang.String SEGMENT_BREAKS

Text filter should segmentOn text into paragraphs on line breaks.

See Also:

Constant Field Values

SEGMENT_EMPTYLINES

public static final java.lang.String SEGMENT_EMPTYLINES

Default. Text filter should segmentOn text into paragraphs on empty lines.

See Also:

Constant Field Values

SEGMENT_NEVER

public static final java.lang.String SEGMENT_NEVER

Text filter should not segmentOn text into paragraphs.

See Also:

Constant Field Values

OPTION_SEGMENT_ON

public static final java.lang.String OPTION_SEGMENT_ON

See Also:

Constant Field Values

OPTION_LINE_LENGTH

public static final java.lang.String OPTION_LINE_LENGTH

Length at which a line break should occur in target documents

See Also:

Constant Field Values

OPTION_MAX_LINE_LENGTH

public static final java.lang.String OPTION_MAX_LINE_LENGTH

Maximum line length in target documents

See Also:

Constant Field Values

Constructor Detail

TextFilter

public TextFilter()

Method Detail

loadPlugins

public static void loadPlugins()

Register plugin into OmegaT.

unloadPlugins

public static void unloadPlugins()

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

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

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

processFile

public void processFile(java.io.BufferedReader in,
                        java.io.BufferedWriter out,
                        FilterContext fc)
                 throws java.io.IOException

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:

in - Reader of the source file. It's the result of calling AbstractFilter.createReader(File,String).

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

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)

Description copied from interface: IFilter

Show change options dialog for able to change options.

Parameters:

parent - parent window

config - old options

Returns:

new options or null if options not changed

hasOptions

public boolean hasOptions()

Returns true to indicate that Text filter has options.

Specified by:

hasOptions in interface IFilter

Overrides:

hasOptions in class AbstractFilter

Returns:

True, because Text filter has options.