Package com.regula.documentreader.api.results

Class DocumentReaderScenario

java.lang.Object

com.regula.documentreader.api.results.DocumentReaderScenario

public class DocumentReaderScenario
extends java.lang.Object

class, contains information about processing scenario. scenario allows to quickly configure processing

Field Summary

Fields

Modifier and Type	Field	Description
java.lang.String	caption	string representation of scenario ID
java.lang.String	description	Description of the scenario
boolean	faceExt
double	frameKWHDoublePageSpreadLandscape
double	frameKWHDoublePageSpreadPortrait
double	frameKWHLandscape
double	frameKWHPortrait
int	frameOrientation	available orientation for scenario see DocReaderOrientation description
int	height
boolean	manualCrop
boolean	multiPageOff
java.lang.String	name	ID of the scenario
java.lang.String	resolution
boolean	seriesProcessMode
boolean	uvTorch
int	width

Constructor Summary

Constructors

Constructor	Description
DocumentReaderScenario(java.lang.String name)
DocumentReaderScenario(java.lang.String name, java.lang.String caption, java.lang.String description, int multiPageOff, double frameKWHLandscape, double frameKWHPortrait, double frameKWHDoublePageSpreadPortrait, double frameKWHDoublePageSpreadLandscape, int frameOrientation, boolean uvTorch, boolean faceExt, boolean seriesProcessMode, boolean manualCrop, java.lang.String resolution)

Method Summary

Modifier and Type	Method	Description
static DocumentReaderScenario	fromJson(java.lang.String json)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

name

public final java.lang.String name

ID of the scenario

caption

public final java.lang.String caption

string representation of scenario ID

description

public final java.lang.String description

Description of the scenario

multiPageOff

public final boolean multiPageOff

frameKWHLandscape

public final double frameKWHLandscape

frameKWHPortrait

public final double frameKWHPortrait

frameKWHDoublePageSpreadPortrait

public final double frameKWHDoublePageSpreadPortrait

frameKWHDoublePageSpreadLandscape

public final double frameKWHDoublePageSpreadLandscape

frameOrientation

public final int frameOrientation

available orientation for scenario see DocReaderOrientation description

uvTorch

public final boolean uvTorch

faceExt

public final boolean faceExt

seriesProcessMode

public final boolean seriesProcessMode

manualCrop

public final boolean manualCrop

resolution

public java.lang.String resolution

width

public int width

height

public int height

Constructor Detail

DocumentReaderScenario

public DocumentReaderScenario(java.lang.String name,
                              java.lang.String caption,
                              java.lang.String description,
                              int multiPageOff,
                              double frameKWHLandscape,
                              double frameKWHPortrait,
                              double frameKWHDoublePageSpreadPortrait,
                              double frameKWHDoublePageSpreadLandscape,
                              int frameOrientation,
                              boolean uvTorch,
                              boolean faceExt,
                              boolean seriesProcessMode,
                              boolean manualCrop,
                              java.lang.String resolution)

DocumentReaderScenario

public DocumentReaderScenario(java.lang.String name)

Method Detail

fromJson

public static DocumentReaderScenario fromJson(java.lang.String json)