org.omegat.filters2.pdf

Class PdfFilter

java.lang.Object

org.omegat.filters2.AbstractFilter

org.omegat.filters2.pdf.PdfFilter

All Implemented Interfaces:

IFilter

public class PdfFilter
extends AbstractFilter

PDF input filter

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

Method Summary

Modifier and Type	Method and Description
java.io.BufferedReader	createReader(java.io.File infile, java.lang.String encoding) Creates a reader of an input 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.
boolean	isSourceEncodingVariable() Whether source encoding can be varied by the user.
boolean	isTargetEncodingVariable() Whether target encoding can be varied by the user.
void	processFile(java.io.BufferedReader in, java.io.BufferedWriter out, FilterContext fc) Processes a single file given a reader and a writer.

Methods inherited from class org.omegat.filters2.AbstractFilter

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

changeOptions, isBilingual

Constructor Detail

PdfFilter

public PdfFilter()

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

createReader

public java.io.BufferedReader createReader(java.io.File infile,
                                           java.lang.String encoding)
                                    throws java.io.IOException,
                                           TranslationException

Description copied from class: AbstractFilter

Creates a reader of an input file.

Overrides:

createReader in class AbstractFilter

Parameters:

infile - The source file.

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

processFile

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

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.