org.omegat.filters2.moodlephp

Class MoodlePHPFilter

java.lang.Object

org.omegat.filters2.AbstractFilter

org.omegat.filters2.moodlephp.MoodlePHPFilter

All Implemented Interfaces:

IFilter

public class MoodlePHPFilter
extends AbstractFilter

Filter for support Moodle PHP files. Code adapted from the file: MozillaDTDFilter.java

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.String>	align
static java.lang.String	OPTION_REMOVE_STRINGS_UNTRANSLATED
protected static java.util.regex.Pattern	RE_ENTITY
boolean	removeStringsUntranslated If true, will remove non-translated segments in the target files

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

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 java.io.BufferedReader	createReader(java.io.File inFile, java.lang.String inEncoding) Creates a reader of an input file.
protected java.io.BufferedWriter	createWriter(java.io.File outFile, java.lang.String outEncoding) Creates a writer of the 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.
java.lang.String	getInEncodingLastParsedFile() Returns the encoding of the last parsed source file.
boolean	hasOptions() Returns true to indicate that Moodle PHP 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.
protected void	processBlock(java.lang.String block, java.io.BufferedWriter out)
protected void	processFile(java.io.BufferedReader inFile, java.io.BufferedWriter outFile, FilterContext fc) Processes a single file given a reader and a writer.

Methods inherited from class org.omegat.filters2.AbstractFilter

alignFile, changeOptions, getFuzzyMark, getHint, getInputEncoding, getOutputEncoding, getTargetFilenamePatterns, isFileSupported, 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

isBilingual

Field Detail

OPTION_REMOVE_STRINGS_UNTRANSLATED

public static final java.lang.String OPTION_REMOVE_STRINGS_UNTRANSLATED

See Also:

Constant Field Values

RE_ENTITY

protected static final java.util.regex.Pattern RE_ENTITY

align

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

removeStringsUntranslated

public boolean removeStringsUntranslated

If true, will remove non-translated segments in the target files

Constructor Detail

MoodlePHPFilter

public MoodlePHPFilter()

Method Detail

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

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

createReader

protected java.io.BufferedReader createReader(java.io.File inFile,
                                              java.lang.String inEncoding)
                                       throws java.io.UnsupportedEncodingException,
                                              java.io.IOException

Description copied from class: AbstractFilter

Creates a reader of an input file.

Overrides:

createReader in class AbstractFilter

Parameters:

inFile - The source file.

inEncoding - 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

createWriter

protected java.io.BufferedWriter createWriter(java.io.File outFile,
                                              java.lang.String outEncoding)
                                       throws java.io.UnsupportedEncodingException,
                                              java.io.IOException

Description copied from class: AbstractFilter

Creates a writer of the translated file.

Overrides:

createWriter in class AbstractFilter

Parameters:

outFile - The target file

outEncoding - 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

processFile

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

processBlock

protected void processBlock(java.lang.String block,
                            java.io.BufferedWriter out)
                     throws java.io.IOException

Throws:

java.io.IOException

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

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.

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 Moodle PHP filter has options.

Specified by:

hasOptions in interface IFilter

Overrides:

hasOptions in class AbstractFilter

Returns:

True if the filter has any options, and false otherwise.