OcrType (webPDF - Web service client library 2.0.2 API)

java.lang.Object
- net.webpdf.wsclient.schema.operation.OcrType

All Implemented Interfaces:: ParameterInterface

public class OcrType
extends Object
implements ParameterInterface

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>

Field Summary

Fields
Modifier and Type	Field and Description
`protected Boolean`	`checkResolution`
`protected Boolean`	`failOnWarning`
`protected Boolean`	`forceEachPage`
`protected Integer`	`imageDpi`
`protected Integer`	`jpegQuality`
`protected OcrLanguageType`	`language`
`protected Boolean`	`normalizePageRotation`
`protected OcrModeType`	`ocrMode`
`protected ImageOptimizationType`	`optimization`
`protected OcrOutputType`	`outputFormat`
`protected OcrPageType`	`page`
`protected PdfaType`	`pdfa`

Constructor Summary

Constructors
Constructor and Description

OcrType()

Constructors
Constructor and Description
`OcrType()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getImageDpi()` Gets the value of the imageDpi property.
`int`	`getJpegQuality()` Gets the value of the jpegQuality property.
`OcrLanguageType`	`getLanguage()` Gets the value of the language property.
`OcrModeType`	`getOcrMode()` Gets the value of the ocrMode property.
`ImageOptimizationType`	`getOptimization()` Gets the value of the optimization property.
`OcrOutputType`	`getOutputFormat()` Gets the value of the outputFormat property.
`OcrPageType`	`getPage()` Gets the value of the page property.
`PdfaType`	`getPdfa()` Gets the value of the pdfa property.
`boolean`	`isCheckResolution()` Gets the value of the checkResolution property.
`boolean`	`isFailOnWarning()` Gets the value of the failOnWarning property.
`boolean`	`isForceEachPage()` Gets the value of the forceEachPage property.
`boolean`	`isNormalizePageRotation()` Gets the value of the normalizePageRotation property.
`boolean`	`isSetCheckResolution()`
`boolean`	`isSetFailOnWarning()`
`boolean`	`isSetForceEachPage()`
`boolean`	`isSetImageDpi()`
`boolean`	`isSetJpegQuality()`
`boolean`	`isSetLanguage()`
`boolean`	`isSetNormalizePageRotation()`
`boolean`	`isSetOcrMode()`
`boolean`	`isSetOptimization()`
`boolean`	`isSetOutputFormat()`
`boolean`	`isSetPage()`
`boolean`	`isSetPdfa()`
`void`	`setCheckResolution(boolean value)` Sets the value of the checkResolution property.
`void`	`setFailOnWarning(boolean value)` Sets the value of the failOnWarning property.
`void`	`setForceEachPage(boolean value)` Sets the value of the forceEachPage property.
`void`	`setImageDpi(int value)` Sets the value of the imageDpi property.
`void`	`setJpegQuality(int value)` Sets the value of the jpegQuality property.
`void`	`setLanguage(OcrLanguageType value)` Sets the value of the language property.
`void`	`setNormalizePageRotation(boolean value)` Sets the value of the normalizePageRotation property.
`void`	`setOcrMode(OcrModeType value)` Sets the value of the ocrMode property.
`void`	`setOptimization(ImageOptimizationType value)` Sets the value of the optimization property.
`void`	`setOutputFormat(OcrOutputType value)` Sets the value of the outputFormat property.
`void`	`setPage(OcrPageType value)` Sets the value of the page property.
`void`	`setPdfa(PdfaType value)` Sets the value of the pdfa property.
`void`	`unsetCheckResolution()`
`void`	`unsetFailOnWarning()`
`void`	`unsetForceEachPage()`
`void`	`unsetImageDpi()`
`void`	`unsetJpegQuality()`
`void`	`unsetNormalizePageRotation()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - page
```
protected OcrPageType page
```
  - pdfa
```
protected PdfaType pdfa
```
  - optimization
```
protected ImageOptimizationType optimization
```
  - language
```
protected OcrLanguageType language
```
  - outputFormat
```
protected OcrOutputType outputFormat
```
  - checkResolution
```
protected Boolean checkResolution
```
  - imageDpi
```
protected Integer imageDpi
```
  - forceEachPage
```
protected Boolean forceEachPage
```
  - normalizePageRotation
```
protected Boolean normalizePageRotation
```
  - failOnWarning
```
protected Boolean failOnWarning
```
  - jpegQuality
```
protected Integer jpegQuality
```
  - ocrMode
```
protected OcrModeType ocrMode
```
- 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()
```
  - getOptimization
```
public ImageOptimizationType getOptimization()
```
    Gets the value of the optimization property.
    
    Returns:
    
    possible object is ImageOptimizationType
  - setOptimization
```
public void setOptimization(ImageOptimizationType value)
```
    Sets the value of the optimization property.
    
    Parameters:
    
    value - allowed object is ImageOptimizationType
  - isSetOptimization
```
public boolean isSetOptimization()
```
  - getLanguage
```
public OcrLanguageType getLanguage()
```
    Gets the value of the language property.
    
    Returns:
    
    possible object is OcrLanguageType
  - 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()
```

Class OcrType

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

page

pdfa

optimization

language

outputFormat

checkResolution

imageDpi

forceEachPage

normalizePageRotation

failOnWarning

jpegQuality

ocrMode

Constructor Detail

OcrType

Method Detail

getPage

setPage

isSetPage

getPdfa

setPdfa

isSetPdfa

getOptimization

setOptimization

isSetOptimization

getLanguage

setLanguage

isSetLanguage

getOutputFormat

setOutputFormat

isSetOutputFormat

isCheckResolution

setCheckResolution

isSetCheckResolution

unsetCheckResolution

getImageDpi

setImageDpi

isSetImageDpi

unsetImageDpi

isForceEachPage

setForceEachPage

isSetForceEachPage

unsetForceEachPage

isNormalizePageRotation

setNormalizePageRotation

isSetNormalizePageRotation

unsetNormalizePageRotation

isFailOnWarning

setFailOnWarning

isSetFailOnWarning

unsetFailOnWarning

getJpegQuality

setJpegQuality

isSetJpegQuality

unsetJpegQuality

getOcrMode

setOcrMode

isSetOcrMode