Package de.elo.ix.client

Class OcrInfoRecognizeFile

java.lang.Object
byps.BValueClass
de.elo.ix.client.ValueClass
de.elo.ix.client.OcrInfoRecognizeFile
All Implemented Interfaces:
Serializable
public class OcrInfoRecognizeFile extends ValueClass
This class describes an OCR analysis request.
Since:
8.00.020.001
See Also:

  • Field Details

    • imageData

      protected FileData imageData
      Image file content. Either imageData or objId must be set.

    • objId

      protected String objId
      Object ID of an archived document to be analyzed. Either imageData or objId must be set.

    • originalFileName

      protected String originalFileName
      Original Filename. allows tracking through the log files of the different modules.
      Since:
      11.00.000.058

    • pageNo

      protected int pageNo
      Page number. The first page number is 0. If all pages should be analyzed, set pageNo = -1.

    • pageNumbers

      protected int[] pageNumbers
      Array of page numbers which should be analysed by the OCR. The first page number is 0. The following constants can be used: OcrInfoC.ALL_PAGES, OcrInfoC.EVEN_PAGES, OcrInfoC.ODD_PAGES
      Since:
      9.00.030.027

    • recognizeLangs

      protected String[] recognizeLangs
      The image data is of this language(s). The supported languages can be requested by a call to IXServicePortIF.processOcr(ClientInfo, OcrInfo). The OcrInfo parameter must have member OcrInfo.queryLanguages set. Use the internal languages returned in OcrResult.queryLanguages for this member. At least one language must be set. The String is case sensitive.

    • recognizeRects

      protected OcrRect[] recognizeRects
      Constrain recognition to this rectangles. Optional.

    • rectUnit

      protected int rectUnit
      Rectangle coordinates are based on this unit. Use on of the constants OcrInfoC.UNIT_*. Optional.
      See Also:

    • timeoutSeconds

      protected int timeoutSeconds
      Recognition timeout. Cancel recognition if it least longer than this number of seconds. Optional.

    • pageTimeout

      protected int pageTimeout
      Recognition timeout for a single page. Cancel recognition if it least longer than this number of seconds. Optional.
      Since:
      9.00.030.028

    • minCharConfidence

      protected int minCharConfidence
      Minimum confidence of character recognition in percent. Characters that are recognized with a lower confidence are replaced by replaceChar. Optional.

    • replaceChar

      protected int replaceChar
      Replacement for characters. Characters that are recognized with a lower confidence than minCharConfidence are replaced this character. Optional.

    • accuracy

      protected int accuracy
      Recognition accuracy. A value of 0 activates the fast mode, a value of 1 activates the exact mode.

    • singleColumnMode

      protected boolean singleColumnMode
      Disable table recognition. Set this member to true, if the OCR should not try to recognized columns and rows of tables. Optional.

    • spaces

      protected int spaces
      OcrInfoC.NORMAL/TWOSPACES/EXACT
      Since:
      10.17.069.001

    • encoding

      protected int encoding
      OcrInfoC.ENCODING_UTF8 / _UTF16 / _UTF16LE
      Since:
      10.17.080.003

    • pdfQuality

      protected int pdfQuality
      OcrInfoC.PDF_QUALITY_MAXQUALITY / _BALANCED / _MINSIZE / _MAXSPEED
      Since:
      11.00.000.057

    • pdfCompliance

      protected int pdfCompliance
      OcrInfoC.COMPLIANCE_PDFA_3U / _3A / _2U / _2A / _1B / _1A / _NONE
      Since:
      11.00.000.057

    • whitespace

      protected int whitespace
      OCR returns whitespace characters. Must be one of the following: OcrInfoC.WHITESPACE_DEFAULT, OcrInfoC.WHITESPACE_REPLACE
      Since:
      12.00.000.041

    • outputFormat

      protected int outputFormat
      Output format. Must be one of the following: OcrInfoC.TEXT, OcrInfoC.CHAR_AND_RECT, OcrInfoC.CHAR_AND_RECT_EX OcrInfoC.PDF, OcrInfoC.XML

  • Constructor Details

    • OcrInfoRecognizeFile

      public OcrInfoRecognizeFile()

  • Method Details

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getImageData

      public FileData getImageData()

    • setImageData

      public void setImageData(FileData imageData)

    • setPageNumbers

      public void setPageNumbers(int[] pageNumbers)

    • getPageNumbers

      public int[] getPageNumbers()

    • getPageNo

      public int getPageNo()

    • setPageNo

      public void setPageNo(int pageNo)

    • getRecognizeLangs

      public String[] getRecognizeLangs()

    • setRecognizeLangs

      public void setRecognizeLangs(String[] recognizeLangs)

    • getRecognizeRects

      public OcrRect[] getRecognizeRects()

    • setRecognizeRects

      public void setRecognizeRects(OcrRect[] recognizeRects)

    • getRectUnit

      public int getRectUnit()

    • setRectUnit

      public void setRectUnit(int rectUnit)

    • setPageTimeout

      public void setPageTimeout(int pageTimeout)

    • getPageTimeout

      public int getPageTimeout()

    • getTimeoutSeconds

      public int getTimeoutSeconds()

    • setTimeoutSeconds

      public void setTimeoutSeconds(int timeoutSeconds)

    • getMinCharConfidence

      public int getMinCharConfidence()

    • setMinCharConfidence

      public void setMinCharConfidence(int minCharConfidence)

    • getReplaceChar

      public int getReplaceChar()

    • setReplaceChar

      public void setReplaceChar(int replaceChar)

    • getAccuracy

      public int getAccuracy()

    • setAccuracy

      public void setAccuracy(int accuracy)

    • isSingleColumnMode

      public boolean isSingleColumnMode()

    • setSingleColumnMode

      public void setSingleColumnMode(boolean singleColumnMode)

    • getOutputFormat

      public int getOutputFormat()

    • setOutputFormat

      public void setOutputFormat(int outputFormat)

    • getObjId

      public String getObjId()

    • setObjId

      public void setObjId(String objId)

    • setSpaces

      public void setSpaces(int spaces)

    • getSpaces

      public int getSpaces()

    • setEncoding

      public void setEncoding(int encoding)

    • getEncoding

      public int getEncoding()

    • getPdfQuality

      public int getPdfQuality()

    • setPdfQuality

      public void setPdfQuality(int pdfQuality)

    • getPdfCompliance

      public int getPdfCompliance()

    • setPdfCompliance

      public void setPdfCompliance(int pdfCompliance)

    • getWhitespace

      public int getWhitespace()

    • setWhitespace

      public void setWhitespace(int whitespace)

    • getOriginalFileName

      public String getOriginalFileName()

    • setOriginalFileName

      public void setOriginalFileName(String originalFileName)