Class OcrType

  • All Implemented Interfaces:
    ParameterInterface

    public class OcrType
    extends Object
    implements ParameterInterface
     <?xml version="1.0" encoding="UTF-8"?><p xmlns:p327152_="https://jakarta.ee/xml/ns/jaxb" xmlns:p898759_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The "OCR" web service can be used to run character recognition in PDF documents or images.
                         If recognition is run on images, they will be converted to PDF documents. More specifically, a page will be generated for each image in the PDF document, with this page containing the original image and a text layer with the recognized text.
                         Character recognition on PDF documents will only work with documents that do not contain text already. Normally, these will be documents that were generated by scanners and that only have an image per page in the PDF document.
                     </p>
     

    Java class for OcrType complex type.

    The following schema fragment specifies the expected content contained within this class.

    
     <complexType name="OcrType">
       <complexContent>
         <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
           <all>
             <element name="page" type="{http://schema.webpdf.de/1.0/operation}OcrPageType" minOccurs="0"/>
             <element name="pdfa" type="{http://schema.webpdf.de/1.0/operation}PdfaType" minOccurs="0"/>
             <element name="optimization" type="{http://schema.webpdf.de/1.0/operation}ImageOptimizationType" minOccurs="0"/>
           </all>
           <attribute name="language" type="{http://schema.webpdf.de/1.0/operation}OcrLanguageType" default="eng" />
           <attribute name="outputFormat" default="pdf">
             <simpleType>
               <restriction base="{http://schema.webpdf.de/1.0/operation}OcrOutputType">
               </restriction>
             </simpleType>
           </attribute>
           <attribute name="checkResolution" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
           <attribute name="imageDpi" default="200">
             <simpleType>
               <restriction base="{http://schema.webpdf.de/1.0/operation}DpiType">
               </restriction>
             </simpleType>
           </attribute>
           <attribute name="forceEachPage" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
           <attribute name="normalizePageRotation" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
           <attribute name="failOnWarning" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
           <attribute name="jpegQuality" default="75">
             <simpleType>
               <restriction base="{http://www.w3.org/2001/XMLSchema}int">
                 <minInclusive value="0"/>
                 <maxInclusive value="100"/>
               </restriction>
             </simpleType>
           </attribute>
           <attribute name="ocrMode" type="{http://schema.webpdf.de/1.0/operation}OcrModeType" default="pageSegments" />
         </restriction>
       </complexContent>
     </complexType>
     
    • Constructor Detail

      • OcrType

        public OcrType()
    • Method Detail

      • getPage

        public OcrPageType getPage()
        Gets the value of the page property.
        Returns:
        possible object is OcrPageType
      • setPage

        public void setPage​(OcrPageType value)
        Sets the value of the page property.
        Parameters:
        value - allowed object is OcrPageType
      • isSetPage

        public boolean isSetPage()
      • getPdfa

        public PdfaType getPdfa()
        Gets the value of the pdfa property.
        Returns:
        possible object is PdfaType
      • setPdfa

        public void setPdfa​(PdfaType value)
        Sets the value of the pdfa property.
        Parameters:
        value - allowed object is PdfaType
      • isSetPdfa

        public boolean isSetPdfa()
      • isSetOptimization

        public boolean isSetOptimization()
      • setLanguage

        public void setLanguage​(OcrLanguageType value)
        Sets the value of the language property.
        Parameters:
        value - allowed object is OcrLanguageType
      • isSetLanguage

        public boolean isSetLanguage()
      • getOutputFormat

        public OcrOutputType getOutputFormat()
        Gets the value of the outputFormat property.
        Returns:
        possible object is OcrOutputType
      • setOutputFormat

        public void setOutputFormat​(OcrOutputType value)
        Sets the value of the outputFormat property.
        Parameters:
        value - allowed object is OcrOutputType
      • isSetOutputFormat

        public boolean isSetOutputFormat()
      • isCheckResolution

        public boolean isCheckResolution()
        Gets the value of the checkResolution property.
        Returns:
        possible object is Boolean
      • setCheckResolution

        public void setCheckResolution​(boolean value)
        Sets the value of the checkResolution property.
        Parameters:
        value - allowed object is Boolean
      • isSetCheckResolution

        public boolean isSetCheckResolution()
      • unsetCheckResolution

        public void unsetCheckResolution()
      • getImageDpi

        public int getImageDpi()
        Gets the value of the imageDpi property.
        Returns:
        possible object is Integer
      • setImageDpi

        public void setImageDpi​(int value)
        Sets the value of the imageDpi property.
        Parameters:
        value - allowed object is Integer
      • isSetImageDpi

        public boolean isSetImageDpi()
      • unsetImageDpi

        public void unsetImageDpi()
      • isForceEachPage

        public boolean isForceEachPage()
        Gets the value of the forceEachPage property.
        Returns:
        possible object is Boolean
      • setForceEachPage

        public void setForceEachPage​(boolean value)
        Sets the value of the forceEachPage property.
        Parameters:
        value - allowed object is Boolean
      • isSetForceEachPage

        public boolean isSetForceEachPage()
      • unsetForceEachPage

        public void unsetForceEachPage()
      • isNormalizePageRotation

        public boolean isNormalizePageRotation()
        Gets the value of the normalizePageRotation property.
        Returns:
        possible object is Boolean
      • setNormalizePageRotation

        public void setNormalizePageRotation​(boolean value)
        Sets the value of the normalizePageRotation property.
        Parameters:
        value - allowed object is Boolean
      • isSetNormalizePageRotation

        public boolean isSetNormalizePageRotation()
      • unsetNormalizePageRotation

        public void unsetNormalizePageRotation()
      • isFailOnWarning

        public boolean isFailOnWarning()
        Gets the value of the failOnWarning property.
        Returns:
        possible object is Boolean
      • setFailOnWarning

        public void setFailOnWarning​(boolean value)
        Sets the value of the failOnWarning property.
        Parameters:
        value - allowed object is Boolean
      • isSetFailOnWarning

        public boolean isSetFailOnWarning()
      • unsetFailOnWarning

        public void unsetFailOnWarning()
      • getJpegQuality

        public int getJpegQuality()
        Gets the value of the jpegQuality property.
        Returns:
        possible object is Integer
      • setJpegQuality

        public void setJpegQuality​(int value)
        Sets the value of the jpegQuality property.
        Parameters:
        value - allowed object is Integer
      • isSetJpegQuality

        public boolean isSetJpegQuality()
      • unsetJpegQuality

        public void unsetJpegQuality()
      • getOcrMode

        public OcrModeType getOcrMode()
        Gets the value of the ocrMode property.
        Returns:
        possible object is OcrModeType
      • setOcrMode

        public void setOcrMode​(OcrModeType value)
        Sets the value of the ocrMode property.
        Parameters:
        value - allowed object is OcrModeType
      • isSetOcrMode

        public boolean isSetOcrMode()