org.omegat.filters2.po

Class PoFilter

java.lang.Object

org.omegat.filters2.AbstractFilter

org.omegat.filters2.po.PoFilter

All Implemented Interfaces:

IFilter

public class PoFilter
extends AbstractFilter

Filter to support po files (in various encodings). Format described on http://www.gnu.org/software/hello/manual/gettext/PO-Files.html Filter is not thread-safe ! Filter uses msgctx field as path, and plural index as suffix of path.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.regex.Pattern	COMMENT_EXTRACTED
protected static java.util.regex.Pattern	COMMENT_FUZZY
protected static java.util.regex.Pattern	COMMENT_FUZZY_MSGID
protected static java.util.regex.Pattern	COMMENT_FUZZY_OTHER
protected static java.util.regex.Pattern	COMMENT_NOWRAP
protected static java.util.regex.Pattern	COMMENT_REFERENCE
protected static java.util.regex.Pattern	COMMENT_TRANSLATOR
protected static java.util.regex.Pattern	MSG_CTX
protected static java.util.regex.Pattern	MSG_FUZZY
protected static java.util.regex.Pattern	MSG_ID
protected static java.util.regex.Pattern	MSG_OTHER
protected static java.util.regex.Pattern	MSG_STR
static java.lang.String	OPTION_ALLOW_BLANK
static java.lang.String	OPTION_ALLOW_EDITING_BLANK_SEGMENT
static java.lang.String	OPTION_AUTO_FILL_IN_PLURAL_STATEMENT
static java.lang.String	OPTION_FORMAT_MONOLINGUAL
static java.lang.String	OPTION_SKIP_HEADER
protected static java.util.regex.Pattern	PLURAL_FORMS
protected static java.util.regex.Pattern	R1
protected static java.util.regex.Pattern	R2
protected static java.util.regex.Pattern	R3
protected static java.util.regex.Pattern	R4

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

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.
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.
protected void	eol(java.lang.String s)
protected void	flushTranslation(org.omegat.filters2.po.PoFilter.MODE currentMode, FilterContext fc)
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	getFuzzyMark() Define fuzzy mark prefix for source which will be stored in TM.
boolean	hasOptions() Returns true to indicate that Text filter has options.
boolean	isBilingual() Indicates whether the filter is bilingual, and thus can be used as external TM (i.e.
boolean	isSourceEncodingVariable() Whether source encoding can be varied by the user.
boolean	isTargetEncodingVariable() Whether target encoding can be varied by the user.
protected void	parseHeader(java.lang.String header, FilterContext fc)
protected void	parseOrAlign(int pair)
protected void	parseOrAlign(java.lang.String source, java.lang.String translation, java.lang.String comments, java.lang.String pathSuffix)
void	processFile(java.io.BufferedReader in, java.io.BufferedWriter out, FilterContext fc) Processes a single file given a reader and a writer.
void	processFile(java.io.File inFile, java.io.File outFile, FilterContext fc) Processes a single file given an input and output files (output file may be null while loading files).

Methods inherited from class org.omegat.filters2.AbstractFilter

alignFile, changeOptions, createReader, createWriter, getHint, getInEncodingLastParsedFile, getInputEncoding, getOutputEncoding, getTargetFilenamePatterns, isFileSupported, isFileSupported, parseFile, processEntry, processEntry, requirePrevNextFields, setCallbacks, translateFile

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OPTION_ALLOW_BLANK

public static final java.lang.String OPTION_ALLOW_BLANK

See Also:

Constant Field Values

OPTION_ALLOW_EDITING_BLANK_SEGMENT

public static final java.lang.String OPTION_ALLOW_EDITING_BLANK_SEGMENT

See Also:

Constant Field Values

OPTION_SKIP_HEADER

public static final java.lang.String OPTION_SKIP_HEADER

See Also:

Constant Field Values

OPTION_AUTO_FILL_IN_PLURAL_STATEMENT

public static final java.lang.String OPTION_AUTO_FILL_IN_PLURAL_STATEMENT

See Also:

Constant Field Values

OPTION_FORMAT_MONOLINGUAL

public static final java.lang.String OPTION_FORMAT_MONOLINGUAL

See Also:

Constant Field Values

COMMENT_FUZZY

protected static final java.util.regex.Pattern COMMENT_FUZZY

COMMENT_FUZZY_OTHER

protected static final java.util.regex.Pattern COMMENT_FUZZY_OTHER

COMMENT_FUZZY_MSGID

protected static final java.util.regex.Pattern COMMENT_FUZZY_MSGID

COMMENT_NOWRAP

protected static final java.util.regex.Pattern COMMENT_NOWRAP

COMMENT_TRANSLATOR

protected static final java.util.regex.Pattern COMMENT_TRANSLATOR

COMMENT_EXTRACTED

protected static final java.util.regex.Pattern COMMENT_EXTRACTED

COMMENT_REFERENCE

protected static final java.util.regex.Pattern COMMENT_REFERENCE

MSG_ID

protected static final java.util.regex.Pattern MSG_ID

MSG_STR

protected static final java.util.regex.Pattern MSG_STR

MSG_CTX

protected static final java.util.regex.Pattern MSG_CTX

MSG_OTHER

protected static final java.util.regex.Pattern MSG_OTHER

PLURAL_FORMS

protected static final java.util.regex.Pattern PLURAL_FORMS

MSG_FUZZY

protected static final java.util.regex.Pattern MSG_FUZZY

R1

protected static final java.util.regex.Pattern R1

R2

protected static final java.util.regex.Pattern R2

R3

protected static final java.util.regex.Pattern R3

R4

protected static final java.util.regex.Pattern R4

Constructor Detail

PoFilter

public PoFilter()

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

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

getFuzzyMark

public java.lang.String getFuzzyMark()

Description copied from class: AbstractFilter

Define fuzzy mark prefix for source which will be stored in TM. It's 'fuzzy' by default, but each filter can redefine it.

Specified by:

getFuzzyMark in interface IFilter

Overrides:

getFuzzyMark in class AbstractFilter

Returns:

fuzzy mark prefix

processFile

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

Description copied from class: AbstractFilter

Processes a single file given an input and output files (output file may be null while loading files). This method can be used to create a filter that works with the source/target files directly, rather than using BufferedReader/BufferedWriter.

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.

If you override this method and do all the processing here, you should simply implement #processFile(BufferedReader,BufferedWriter) with a stub.

Default implementation calls AbstractFilter.createReader(File,String) to create a reader, new BufferedWriter(new StringWriter()) to create a writer for null output file, or AbstractFilter.createWriter(File,String) to create a writer if output file is not null; then calls #processFile(BufferedReader,BufferedWriter) to process source file, and then closes reader and writer.

Overrides:

processFile in class AbstractFilter

Parameters:

inFile - The source file.

outFile - The target file.

fc - Filter context.

Throws:

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

TranslationException - Should be thrown when processed file has any format defects.

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

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.

eol

protected void eol(java.lang.String s)
            throws java.io.IOException

Throws:

java.io.IOException

parseOrAlign

protected void parseOrAlign(int pair)

parseOrAlign

protected void parseOrAlign(java.lang.String source,
                            java.lang.String translation,
                            java.lang.String comments,
                            java.lang.String pathSuffix)

Parameters:

source -

translation -

comments -

pathSuffix - suffix for path to distinguish plural forms. It will be empty for first one, and [1],[2],... for next

parseHeader

protected void parseHeader(java.lang.String header,
                           FilterContext fc)

flushTranslation

protected void flushTranslation(org.omegat.filters2.po.PoFilter.MODE currentMode,
                                FilterContext fc)
                         throws java.io.IOException

Throws:

java.io.IOException

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 the PO filter has options.

isBilingual

public boolean isBilingual()

Description copied from interface: IFilter

Indicates whether the filter is bilingual, and thus can be used as external TM (i.e. files can be added to the /tm/ folder of an OmegaT project). Bilingual filters will supply both source strings and translation strings to IParseCallback.addEntry().

Returns:

true if the filter is bilingual