org.sejda.model.parameter

Class OcrTextParameters

java.lang.Object

org.sejda.model.parameter.base.AbstractParameters

org.sejda.model.parameter.OcrTextParameters

All Implemented Interfaces:

MultipleOutputTaskParameters, MultiplePdfSourceTaskParameters, PrefixableTaskParameters, TaskParameters

public class OcrTextParameters
extends AbstractParameters
implements MultiplePdfSourceTaskParameters, MultipleOutputTaskParameters

Parameter class to extract text from multiple documents performing OCR

Author:

Andrea Vacondio

Constructor Summary

Constructors

Constructor and Description
OcrTextParameters()

Method Summary

Modifier and Type	Method and Description
void	addLanguage(Locale language) Adds a language o the list of possible languages of the text found in the documents.
void	addSource(PdfSource<?> input) adds the input source to the source list.
boolean	equals(Object other)
Set<Locale>	getLanguages()
MultipleTaskOutput	getOutput()
String	getOutputPrefix()
List<PdfSource<?>>	getSourceList()
String	getTextEncoding()
int	hashCode()
void	setOutput(MultipleTaskOutput output) Sets the output destination
void	setOutputPrefix(String outputPrefix) Set the prefix to be used to generate names of the multiple outputs for this parameter.
void	setTextEncoding(String textEncoding)

Methods inherited from class org.sejda.model.parameter.base.AbstractParameters

getExistingOutputPolicy, isLenient, setExistingOutputPolicy, setLenient, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.sejda.model.parameter.base.TaskParameters

getExistingOutputPolicy, isLenient, setExistingOutputPolicy, setLenient

Constructor Detail

OcrTextParameters

public OcrTextParameters()

Method Detail

addLanguage

public void addLanguage(Locale language)

Adds a language o the list of possible languages of the text found in the documents. This can help the OCR engine to return a more accurate result.

Parameters:

language -

getLanguages

public Set<Locale> getLanguages()

Returns:

Languages that can be fed to the OCR engine to return a more accurate result

getTextEncoding

public String getTextEncoding()

setTextEncoding

public void setTextEncoding(String textEncoding)

getOutput

public MultipleTaskOutput getOutput()

Specified by:

getOutput in interface TaskParameters

Returns:

output destination where the result of the manipulation is placed

setOutput

public void setOutput(MultipleTaskOutput output)

Description copied from interface: MultipleOutputTaskParameters

Sets the output destination

Specified by:

setOutput in interface MultipleOutputTaskParameters

getOutputPrefix

public String getOutputPrefix()

Specified by:

getOutputPrefix in interface PrefixableTaskParameters

Returns:

the prefix to be used to generate names of the multiple outputs.

setOutputPrefix

public void setOutputPrefix(String outputPrefix)

Description copied from interface: PrefixableTaskParameters

Set the prefix to be used to generate names of the multiple outputs for this parameter.

Specified by:

setOutputPrefix in interface PrefixableTaskParameters

addSource

public void addSource(PdfSource<?> input)

adds the input source to the source list.

Specified by:

addSource in interface MultiplePdfSourceTaskParameters

Parameters:

input -

getSourceList

public List<PdfSource<?>> getSourceList()

Specified by:

getSourceList in interface MultiplePdfSourceTaskParameters

Returns:

an unmodifiable view of the source list

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractParameters

equals

public boolean equals(Object other)

Overrides:

equals in class AbstractParameters