AbstractFilter (OmegaT 5.7.0 API)

java.lang.Object
- org.omegat.filters2.AbstractFilter

All Implemented Interfaces:

IFilter

Direct Known Subclasses:

DokuWikiFilter, HTMLFilter2, ILIASFilter, INIFilter, LatexFilter, MagentoFilter, MoodlePHPFilter, MozillaDTDFilter, MozillaFTLFilter, MozillaLangFilter, OpenDocFilter, OpenXMLFilter, PdfFilter, PoFilter, RcFilter, ResourceBundleFilter, SrtFilter, TextFilter, XMLFilter, XtagFilter
```
public abstract class AbstractFilter
extends java.lang.Object
implements IFilter
```
The base class for all filters (aka file handlers). Each filter should extend this class or one of its descendants.
The process how the filter works is the following:
1. Source text is extracted.
2. Tags are converted into shortcuts and these shortcuts are temporarily stored
3. Source text with shortened tags is sent to OmegaT core
4. Core returns a translation (or the same text if there's no translation)
5. Tags shortcuts are expanded in translated text
6. Translated text is written into the output file

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ENCODING_AUTO_HUMAN` This value represents to the user that the encoding is determined by the filter itself.
`protected IAlignCallback`	`entryAlignCallback` Callback for align.
`protected IParseCallback`	`entryParseCallback` Callback for parse.
`protected ITranslateCallback`	`entryTranslateCallback` Callback for translate.
`protected java.lang.String`	`inEncodingLastParsedFile`
`protected java.util.Map<java.lang.String,java.lang.String>`	`processOptions` Options for processing time.
`static java.lang.String`	`TARGET_DEFAULT` The default output filename pattern.
`static java.lang.String`	`TFP_EXTENSION` The original file extension.
`static java.lang.String`	`TFP_FILE_FILTER_NAME`
`static java.lang.String`	`TFP_FILE_SOURCE_ENCODING` File properties.
`static java.lang.String`	`TFP_FILE_TARGET_ENCODING`
`static java.lang.String`	`TFP_FILENAME` The original filename (with extension).
`static java.lang.String`	`TFP_NAMEONLY` The original filename without extension.
`static java.lang.String`	`TFP_SYSTEM_HOST_NAME`
`static java.lang.String`	`TFP_SYSTEM_OS_ARCH`
`static java.lang.String`	`TFP_SYSTEM_OS_NAME` Workstation properties.
`static java.lang.String`	`TFP_SYSTEM_OS_VERSION`
`static java.lang.String`	`TFP_SYSTEM_USER_NAME`
`static java.lang.String`	`TFP_TARGET_COUNTRY_CODE` country "YY" only
`static java.lang.String`	`TFP_TARGET_COUTRY_CODE` Old spelling of the variable for country "YY" only
`static java.lang.String`	`TFP_TARGET_LANG_CODE` language "XX" only
`static java.lang.String`	`TFP_TARGET_LANGUAGE` "XX-YY", the TMX/XML language code
`static java.lang.String`	`TFP_TARGET_LOCALE` "xx_YY", locale code
`static java.lang.String`	`TFP_TARGET_LOCALE_LCID` Microsoft.
`static java.lang.String`	`TFP_TIMESTAMP_LA` System time at generation time in various patterns.
`static java.lang.String`	`TFP_TIMESTAMP_LD`
`static java.lang.String`	`TFP_TIMESTAMP_LDD`
`static java.lang.String`	`TFP_TIMESTAMP_LH`
`static java.lang.String`	`TFP_TIMESTAMP_LHH`
`static java.lang.String`	`TFP_TIMESTAMP_LM`
`static java.lang.String`	`TFP_TIMESTAMP_LMM`
`static java.lang.String`	`TFP_TIMESTAMP_LS`
`static java.lang.String`	`TFP_TIMESTAMP_LSS`
`static java.lang.String`	`TFP_TIMESTAMP_LYYYY`
`static java.lang.String`	`TFP_TIMESTAMP_UD`
`static java.lang.String`	`TFP_TIMESTAMP_UEEE`
`static java.lang.String`	`TFP_TIMESTAMP_UEEEE`
`static java.lang.String`	`TFP_TIMESTAMP_UH`
`static java.lang.String`	`TFP_TIMESTAMP_UHH`
`static java.lang.String`	`TFP_TIMESTAMP_UM`
`static java.lang.String`	`TFP_TIMESTAMP_UMM`
`static java.lang.String`	`TFP_TIMESTAMP_UMMM`

Constructor Summary

Constructors
Constructor and Description

AbstractFilter()

Constructors
Constructor and Description
`AbstractFilter()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
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.
`void`	`alignFile(java.io.File inFile, java.io.File outFile, java.util.Map<java.lang.String,java.lang.String> config, FilterContext fc, IAlignCallback callback)` Align source and translated files.
`java.util.Map<java.lang.String,java.lang.String>`	`changeOptions(java.awt.Dialog parent, java.util.Map<java.lang.String,java.lang.String> config)` Deprecated.
`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.
`abstract Instance[]`	`getDefaultInstances()` The default list of filter instances that this filter class has.
`abstract 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.
`java.lang.String`	`getHint()` Returns the hint displayed while the user edits the filter, and when she adds/edits the instance of this filter.
`java.lang.String`	`getInEncodingLastParsedFile()` Returns the encoding of the last parsed source file.
`protected java.lang.String`	`getInputEncoding(FilterContext fc, java.io.File inFile)` Get the input encoding.
`protected java.lang.String`	`getOutputEncoding(FilterContext fc)` Get the output encoding.
`static java.util.List<java.lang.String>`	`getTargetFilenamePatterns()`
`boolean`	`hasOptions()` OmegaT calls this to see whether the filter has any options.
`protected boolean`	`isFileSupported(java.io.BufferedReader reader)` Returns whether the file is supported by the filter, given the reader with file's contents.
`boolean`	`isFileSupported(java.io.File inFile, java.util.Map<java.lang.String,java.lang.String> config, FilterContext fc)` Returns whether the file is supported by the filter, given the file and possible file's encoding ( `null` encoding means autodetect).
`abstract boolean`	`isSourceEncodingVariable()` Whether source encoding can be varied by the user.
`abstract boolean`	`isTargetEncodingVariable()` Whether target encoding can be varied by the user.
`void`	`parseFile(java.io.File inFile, java.util.Map<java.lang.String,java.lang.String> config, FilterContext fc, IParseCallback callback)` Parse single file.
`protected java.lang.String`	`processEntry(java.lang.String entry)` Call this method to: Instruct OmegaT what source strings are translatable.
`protected java.lang.String`	`processEntry(java.lang.String entry, java.lang.String comment)` Call this method to: Instruct OmegaT what source strings are translatable.
`protected abstract void`	`processFile(java.io.BufferedReader inFile, java.io.BufferedWriter outFile, FilterContext fc)` Processes a single file given a reader and a writer.
`protected 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).
`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.
`void`	`setCallbacks(IParseCallback parseCallback, ITranslateCallback translateCallback)` Set both callbacks.
`void`	`translateFile(java.io.File inFile, java.io.File outFile, java.util.Map<java.lang.String,java.lang.String> config, FilterContext fc, ITranslateCallback callback)` Create translated file.

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
  - ENCODING_AUTO_HUMAN
```
public static final java.lang.String ENCODING_AUTO_HUMAN
```
    This value represents to the user that the encoding is determined by the filter itself. "In code" the null is used to represent automatic encoding selection.
  - TFP_FILENAME
```
public static final java.lang.String TFP_FILENAME
```
    The original filename (with extension).
    
    See Also:
    
    Constant Field Values
  - TFP_NAMEONLY
```
public static final java.lang.String TFP_NAMEONLY
```
    The original filename without extension.
    
    See Also:
    
    Constant Field Values
  - TFP_EXTENSION
```
public static final java.lang.String TFP_EXTENSION
```
    The original file extension.
    
    See Also:
    
    Constant Field Values
  - TFP_TARGET_LOCALE
```
public static final java.lang.String TFP_TARGET_LOCALE
```
    "xx_YY", locale code
    
    See Also:
    
    Constant Field Values
  - TFP_TARGET_LANGUAGE
```
public static final java.lang.String TFP_TARGET_LANGUAGE
```
    "XX-YY", the TMX/XML language code
    
    See Also:
    
    Constant Field Values
  - TFP_TARGET_LANG_CODE
```
public static final java.lang.String TFP_TARGET_LANG_CODE
```
    language "XX" only
    
    See Also:
    
    Constant Field Values
  - TFP_TARGET_COUNTRY_CODE
```
public static final java.lang.String TFP_TARGET_COUNTRY_CODE
```
    country "YY" only
    
    See Also:
    
    Constant Field Values
  - TFP_TARGET_COUTRY_CODE
```
public static final java.lang.String TFP_TARGET_COUTRY_CODE
```
    Old spelling of the variable for country "YY" only
    
    See Also:
    
    Constant Field Values
  - TFP_TIMESTAMP_LA
```
public static final java.lang.String TFP_TIMESTAMP_LA
```
    System time at generation time in various patterns.
    
    See Also:
    
    Constant Field Values
  - TFP_TIMESTAMP_LD
```
public static final java.lang.String TFP_TIMESTAMP_LD
```
    See Also:
    
    Constant Field Values
  - TFP_TIMESTAMP_LDD
```
public static final java.lang.String TFP_TIMESTAMP_LDD
```
    See Also:
    
    Constant Field Values
  - TFP_TIMESTAMP_LH
```
public static final java.lang.String TFP_TIMESTAMP_LH
```
    See Also:
    
    Constant Field Values
  - TFP_TIMESTAMP_LHH
```
public static final java.lang.String TFP_TIMESTAMP_LHH
```
    See Also:
    
    Constant Field Values
  - TFP_TIMESTAMP_LM
```
public static final java.lang.String TFP_TIMESTAMP_LM
```
    See Also:
    
    Constant Field Values
  - TFP_TIMESTAMP_LMM
```
public static final java.lang.String TFP_TIMESTAMP_LMM
```
    See Also:
    
    Constant Field Values
  - TFP_TIMESTAMP_LS
```
public static final java.lang.String TFP_TIMESTAMP_LS
```
    See Also:
    
    Constant Field Values
  - TFP_TIMESTAMP_LSS
```
public static final java.lang.String TFP_TIMESTAMP_LSS
```
    See Also:
    
    Constant Field Values
  - TFP_TIMESTAMP_LYYYY
```
public static final java.lang.String TFP_TIMESTAMP_LYYYY
```
    See Also:
    
    Constant Field Values
  - TFP_TIMESTAMP_UD
```
public static final java.lang.String TFP_TIMESTAMP_UD
```
    See Also:
    
    Constant Field Values
  - TFP_TIMESTAMP_UEEE
```
public static final java.lang.String TFP_TIMESTAMP_UEEE
```
    See Also:
    
    Constant Field Values
  - TFP_TIMESTAMP_UEEEE
```
public static final java.lang.String TFP_TIMESTAMP_UEEEE
```
    See Also:
    
    Constant Field Values
  - TFP_TIMESTAMP_UH
```
public static final java.lang.String TFP_TIMESTAMP_UH
```
    See Also:
    
    Constant Field Values
  - TFP_TIMESTAMP_UHH
```
public static final java.lang.String TFP_TIMESTAMP_UHH
```
    See Also:
    
    Constant Field Values
  - TFP_TIMESTAMP_UM
```
public static final java.lang.String TFP_TIMESTAMP_UM
```
    See Also:
    
    Constant Field Values
  - TFP_TIMESTAMP_UMM
```
public static final java.lang.String TFP_TIMESTAMP_UMM
```
    See Also:
    
    Constant Field Values
  - TFP_TIMESTAMP_UMMM
```
public static final java.lang.String TFP_TIMESTAMP_UMMM
```
    See Also:
    
    Constant Field Values
  - TFP_SYSTEM_OS_NAME
```
public static final java.lang.String TFP_SYSTEM_OS_NAME
```
    Workstation properties.
    
    See Also:
    
    Constant Field Values
  - TFP_SYSTEM_OS_VERSION
```
public static final java.lang.String TFP_SYSTEM_OS_VERSION
```
    See Also:
    
    Constant Field Values
  - TFP_SYSTEM_OS_ARCH
```
public static final java.lang.String TFP_SYSTEM_OS_ARCH
```
    See Also:
    
    Constant Field Values
  - TFP_SYSTEM_USER_NAME
```
public static final java.lang.String TFP_SYSTEM_USER_NAME
```
    See Also:
    
    Constant Field Values
  - TFP_SYSTEM_HOST_NAME
```
public static final java.lang.String TFP_SYSTEM_HOST_NAME
```
    See Also:
    
    Constant Field Values
  - TFP_FILE_SOURCE_ENCODING
```
public static final java.lang.String TFP_FILE_SOURCE_ENCODING
```
    File properties.
    
    See Also:
    
    Constant Field Values
  - TFP_FILE_TARGET_ENCODING
```
public static final java.lang.String TFP_FILE_TARGET_ENCODING
```
    See Also:
    
    Constant Field Values
  - TFP_FILE_FILTER_NAME
```
public static final java.lang.String TFP_FILE_FILTER_NAME
```
    See Also:
    
    Constant Field Values
  - TFP_TARGET_LOCALE_LCID
```
public static final java.lang.String TFP_TARGET_LOCALE_LCID
```
    Microsoft.
    
    See Also:
    
    Constant Field Values
  - inEncodingLastParsedFile
```
protected java.lang.String inEncodingLastParsedFile
```
  - entryParseCallback
```
protected IParseCallback entryParseCallback
```
    Callback for parse.
  - entryTranslateCallback
```
protected ITranslateCallback entryTranslateCallback
```
    Callback for translate.
  - entryAlignCallback
```
protected IAlignCallback entryAlignCallback
```
    Callback for align.
  - processOptions
```
protected java.util.Map<java.lang.String,java.lang.String> processOptions
```
    Options for processing time.
  - TARGET_DEFAULT
```
public static final java.lang.String TARGET_DEFAULT
```
    The default output filename pattern.
    It is equal to "${filename}", which means that the name of the translated file should be the same as the name of the input file.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractFilter
```
public AbstractFilter()
```
- Method Detail
  - getTargetFilenamePatterns
```
public static java.util.List<java.lang.String> getTargetFilenamePatterns()
```
  - getFileFormatName
```
public abstract java.lang.String getFileFormatName()
```
    Human-readable name of the File Format this filter supports.
    
    Specified by:
    
    getFileFormatName in interface IFilter
    
    Returns:
    
    File format name
  - getDefaultInstances
```
public abstract Instance[] getDefaultInstances()
```
    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
    
    Returns:
    
    Default filter instances
  - isSourceEncodingVariable
```
public abstract boolean isSourceEncodingVariable()
```
    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
    
    Returns:
    
    whether source encoding can be changed by the user
  - isTargetEncodingVariable
```
public abstract boolean isTargetEncodingVariable()
```
    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
    
    Returns:
    
    whether target encoding can be changed by the user
  - isFileSupported
```
protected boolean isFileSupported(java.io.BufferedReader reader)
```
    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.
    
    Parameters:
    
    reader - The reader of the source file
    
    Returns:
    
    Does the filter support the file
  - isFileSupported
```
public boolean isFileSupported(java.io.File inFile,
                               java.util.Map<java.lang.String,java.lang.String> config,
                               FilterContext fc)
```
    Returns whether the file is supported by the filter, given the file and possible file's encoding ( null encoding means autodetect). Default implementation creates a reader and calls isFileSupported(BufferedReader). You should override only one of the two.
    For example, DocBook files have .xml extension, as possibly many other XML files, so the filter should check a DTD of the document.
    
    Specified by:
    
    isFileSupported in interface IFilter
    
    Parameters:
    
    inFile - Source file.
    
    fc - Filter context.
    
    config - filter's configuration options
    
    Returns:
    
    Does the filter support the file.
  - getFuzzyMark
```
public java.lang.String getFuzzyMark()
```
    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
    
    Returns:
    
    fuzzy mark prefix
  - getHint
```
public java.lang.String getHint()
```
    Returns the hint displayed while the user edits the filter, and when she adds/edits the instance of this filter. The hint may be any string, preferably in a non-geek language.
    
    Specified by:
    
    getHint in interface IFilter
    
    Returns:
    
    The hint for editing the filter in a non-geek language.
  - hasOptions
```
public boolean hasOptions()
```
    OmegaT calls this to see whether the filter has any options. By default returns false, so filter authors should override this to tell OmegaT core that this filter has options.
    
    Specified by:
    
    hasOptions in interface IFilter
    
    Returns:
    
    True if the filter has any options, and false otherwise.
  - changeOptions
```
@Deprecated
public java.util.Map<java.lang.String,java.lang.String> changeOptions(java.awt.Dialog parent,
                                                                                  java.util.Map<java.lang.String,java.lang.String> config)
```
    Deprecated.
    
    Show change options dialog for able to change options.
    Deprecated; please use IFilter.changeOptions(Window, Map) instead.
    
    Specified by:
    
    changeOptions in interface IFilter
    
    Parameters:
    
    parent - parent window
    
    config - old options
    
    Returns:
    
    new options or null if options not changed
  - createReader
```
protected java.io.BufferedReader createReader(java.io.File inFile,
                                              java.lang.String inEncoding)
                                       throws java.io.UnsupportedEncodingException,
                                              java.io.IOException,
                                              TranslationException
```
    Creates a reader of an input file.
    
    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
    
    TranslationException - Should be thrown when processed file has any format defects.
  - createWriter
```
protected java.io.BufferedWriter createWriter(java.io.File outFile,
                                              java.lang.String outEncoding)
                                       throws java.io.UnsupportedEncodingException,
                                              java.io.IOException
```
    Creates a writer of the translated file.
    
    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 abstract void processFile(java.io.BufferedReader inFile,
                                    java.io.BufferedWriter outFile,
                                    FilterContext fc)
                             throws java.io.IOException,
                                    TranslationException
```
    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 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 processFile(File, File, FilterContext) instead.
    
    Parameters:
    
    inFile - Reader of the source file. It's the result of calling createReader(File,String).
    
    outFile - Writer of the target file on compilation (the result of calling createWriter(File, String)), or a fictive writer to /dev/null.
    
    Throws:
    
    TranslationException - Should be thrown when processed file has any format defects.
    
    java.io.IOException - In case of any I/O error.
  - processFile
```
protected void processFile(java.io.File inFile,
                           java.io.File outFile,
                           FilterContext fc)
                    throws java.io.IOException,
                           TranslationException
```
    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 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 createReader(File,String) to create a reader, new BufferedWriter(new StringWriter()) to create a writer for null output file, or 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.
    
    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.
  - getInputEncoding
```
protected java.lang.String getInputEncoding(FilterContext fc,
                                            java.io.File inFile)
                                     throws java.io.IOException
```
    Get the input encoding. If it's not set in the FilterContext (setting is "<auto>") and the filter allows (isSourceEncodingVariable()), try to detect it. The result may be null.
    
    Parameters:
    
    fc -
    
    inFile -
    
    Returns:
    
    Throws:
    
    java.io.IOException
  - getOutputEncoding
```
protected java.lang.String getOutputEncoding(FilterContext fc)
```
    Get the output encoding. If it's not set in the FilterContext (setting is "<auto>") and the filter allows (isTargetEncodingVariable()):
    - Reuse the input encoding if it's Unicode
    - If the input was not Unicode, fall back to UTF-8.
    The result may be null.
    Parameters:
    
    fc -
    
    Returns:
  - parseFile
```
public final void parseFile(java.io.File inFile,
                            java.util.Map<java.lang.String,java.lang.String> config,
                            FilterContext fc,
                            IParseCallback callback)
                     throws java.lang.Exception
```
    Description copied from interface: IFilter
    
    Parse single file.
    
    Specified by:
    
    parseFile in interface IFilter
    
    Parameters:
    
    inFile - file to parse
    
    config - filter's configuration options
    
    fc - processing context
    
    callback - callback for parsed data
    
    Throws:
    
    java.lang.Exception
  - alignFile
```
public final void alignFile(java.io.File inFile,
                            java.io.File outFile,
                            java.util.Map<java.lang.String,java.lang.String> config,
                            FilterContext fc,
                            IAlignCallback callback)
                     throws java.lang.Exception
```
    Description copied from interface: IFilter
    
    Align source and translated files. NB: this is not used for Tools->align files..., but for aligning in console mode
    
    Specified by:
    
    alignFile in interface IFilter
    
    Parameters:
    
    inFile - source file
    
    outFile - translated file
    
    config - filter's configuration options
    
    fc - processing context
    
    callback - callback for store aligned data
    
    Throws:
    
    java.lang.Exception
  - alignFile
```
protected void alignFile(java.io.BufferedReader sourceFile,
                         java.io.BufferedReader translatedFile,
                         FilterContext fc)
                  throws java.lang.Exception
```
    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
    
    Parameters:
    
    sourceFile - source file
    
    translatedFile - translated file
    
    Throws:
    
    java.lang.Exception
  - requirePrevNextFields
```
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. (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
  - translateFile
```
public final void translateFile(java.io.File inFile,
                                java.io.File outFile,
                                java.util.Map<java.lang.String,java.lang.String> config,
                                FilterContext fc,
                                ITranslateCallback callback)
                         throws java.lang.Exception
```
    Description copied from interface: IFilter
    
    Create translated file.
    
    Specified by:
    
    translateFile in interface IFilter
    
    Parameters:
    
    inFile - source file
    
    outFile - output file
    
    config - filter's configuration options
    
    fc - processing context
    
    callback - callback for get translation
    
    Throws:
    
    java.lang.Exception
  - processEntry
```
protected final java.lang.String processEntry(java.lang.String entry)
```
    Call this method to:
    - Instruct OmegaT what source strings are translatable.
    - Get the translation of each source string.
    Parameters:
    
    entry - Translatable source string
    
    Returns:
    
    Translation of the source string. If there's no translation, returns the source string itself.
  - processEntry
```
protected final java.lang.String processEntry(java.lang.String entry,
                                              java.lang.String comment)
```
    Call this method to:
    - Instruct OmegaT what source strings are translatable.
    - Get the translation of each source string.
    NB: this method doesn't use ID's or path or protectedParts. If your file format has ID's, paths or protectedParts, then call entryParseCallback.addEntry or entryTranslateCallback.getTranslation instead.
    Parameters:
    
    entry - Translatable source string
    
    comment - comment on the source string in the source file (if available)
    
    Returns:
    
    Translation of the source string. If there's no translation, returns the source string itself.
  - setCallbacks
```
public void setCallbacks(IParseCallback parseCallback,
                         ITranslateCallback translateCallback)
```
    Set both callbacks. Used for child XML filters only.
    
    Parameters:
    
    parseCallback -
    
    translateCallback -
  - 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
    
    Returns:
    
    the encoding of the last parsed source file, or null when no file has been parsed yet.

Class AbstractFilter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.omegat.filters2.IFilter

Field Detail

ENCODING_AUTO_HUMAN

TFP_FILENAME

TFP_NAMEONLY

TFP_EXTENSION

TFP_TARGET_LOCALE

TFP_TARGET_LANGUAGE

TFP_TARGET_LANG_CODE

TFP_TARGET_COUNTRY_CODE

TFP_TARGET_COUTRY_CODE

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

TFP_SYSTEM_OS_NAME

TFP_SYSTEM_OS_VERSION

TFP_SYSTEM_OS_ARCH

TFP_SYSTEM_USER_NAME

TFP_SYSTEM_HOST_NAME

TFP_FILE_SOURCE_ENCODING

TFP_FILE_TARGET_ENCODING

TFP_FILE_FILTER_NAME

TFP_TARGET_LOCALE_LCID

inEncodingLastParsedFile

entryParseCallback

entryTranslateCallback

entryAlignCallback

processOptions

TARGET_DEFAULT

Constructor Detail

AbstractFilter

Method Detail

getTargetFilenamePatterns

getFileFormatName

getDefaultInstances

isSourceEncodingVariable

isTargetEncodingVariable

isFileSupported

isFileSupported

getFuzzyMark

getHint

hasOptions

changeOptions

createReader

createWriter

processFile

processFile

getInputEncoding

getOutputEncoding

parseFile

alignFile

alignFile

requirePrevNextFields

translateFile

processEntry

processEntry

setCallbacks

getInEncodingLastParsedFile