org.omegat.filters3.xml.docbook

Class DocBookFilter

java.lang.Object

org.omegat.filters2.AbstractFilter

org.omegat.filters3.xml.XMLFilter

org.omegat.filters3.xml.docbook.DocBookFilter

All Implemented Interfaces:

IFilter

public class DocBookFilter
extends XMLFilter

Filter for DocBook files.

Field Summary

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
DocBookFilter() Creates a new instance of DocBookFilter

Method Summary

Modifier and Type	Method and Description
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	getHint() Returns the hint displayed while the user edits the filter, and when she adds/edits the instance of this filter.
boolean	isFileSupported(java.io.BufferedReader reader) Returns whether the file is supported by the filter, by checking DB4 (DTD) or DB5 (Namespace) constraints.
boolean	isSourceEncodingVariable() Either the encoding can be read, or it is UTF-8..
boolean	isTargetEncodingVariable() Yes, DocBook may be written out in a variety of encodings.
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.

Methods inherited from class org.omegat.filters3.xml.XMLFilter

comment, createReader, createWriter, getDialect, getSourceLanguage, getTargetLanguage, isInIgnored, processFile, processFile, tagEnd, tagStart, text, translate

Methods inherited from class org.omegat.filters2.AbstractFilter

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

Constructor Detail

DocBookFilter

public DocBookFilter()

Creates a new instance of DocBookFilter

Method Detail

getFileFormatName

public java.lang.String getFileFormatName()

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

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

Overrides:

getHint in class AbstractFilter

Returns:

The hint for editing the filter in a non-geek language.

getDefaultInstances

public 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

Specified by:

getDefaultInstances in class AbstractFilter

Returns:

Default filter instances

isSourceEncodingVariable

public boolean isSourceEncodingVariable()

Either the encoding can be read, or it is UTF-8..

Specified by:

isSourceEncodingVariable in interface IFilter

Overrides:

isSourceEncodingVariable in class XMLFilter

Returns:

false

isTargetEncodingVariable

public boolean isTargetEncodingVariable()

Yes, DocBook may be written out in a variety of encodings.

Specified by:

isTargetEncodingVariable in interface IFilter

Overrides:

isTargetEncodingVariable in class XMLFilter

Returns:

true

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

isFileSupported

public boolean isFileSupported(java.io.BufferedReader reader)

Returns whether the file is supported by the filter, by checking DB4 (DTD) or DB5 (Namespace) constraints.

Overrides:

isFileSupported in class XMLFilter

Parameters:

reader - The reader of the source file

Returns:

true or false