public class RequestOutputItem
extends java.lang.Object
implements java.lang.Cloneable
Modifier and Type | Class and Description |
---|---|
static class |
RequestOutputItem.UploadSetting
Upload settings.
|
Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_JPEG_QUALITY |
static int |
DEFAULT_THUMBNAIL_HEIGHT |
Constructor and Description |
---|
RequestOutputItem() |
RequestOutputItem(java.lang.String type,
java.lang.String format)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
RequestOutputItem |
addExifTag(java.lang.String tagName,
java.lang.String value)
Exif tags, key should be any of Imaging.EXIF_NAME_DocumentName ...
|
java.lang.Object |
clone() |
static RequestOutputItem |
fromJsonMap(java.util.Map json) |
int |
getBitsPerPixel()
Bits per pixel: bit depth of the output image; 0 (auto) | 1 (black/white) | 8 | 16 | 24 | 32
|
java.util.Map<java.lang.String,java.lang.String> |
getExifTags()
Exif tags, key should be any of Imaging.EXIF_NAME_DocumentName ...
|
java.lang.String |
getFormat()
Image format, any of Imaging.FORMAT_JPG ...
|
int |
getJpegQuality()
Only for JPG format; default value: 80
|
java.lang.String |
getPdfOwnerPassword()
PDF owner password
|
java.lang.String |
getPdfTextLine()
Optionally prints a line of text at the bottom of the first page.
|
java.lang.String |
getPdfUserPassword()
PDF user password
|
java.lang.String |
getSavePath()
Target output file path, may contain variable for expansion, e.g., C:\\tmp\\${TMS}${EXT}.
|
int |
getThumbnailHeight()
Only for thumbnail output types; default value: 200.
|
java.lang.String |
getTiffCompression()
Any of Imaging.TIFF_COMPRESSION_CCITT_G4 ...
|
java.lang.String |
getType()
Output type, any of Imaging.OUTPUT_SAVE ...
|
RequestOutputItem.UploadSetting |
getUploadSetting()
must be set when type is Imaging.OUTPUT_UPLOAD or Imaging.OUTPUT_UPLOAD_THUMB.
|
boolean |
isPdfaCompliant()
Set to true to output PDF/A compliant PDF.
|
boolean |
isPdfForceBlackWhite()
Force to output black/white PDF to save space.
|
boolean |
isTiffForceSinglePage()
Force to save images into individual single-image tiff files.
|
boolean |
isUploadAfterAllDone()
Perform upload after all scans.
|
boolean |
isUploadOneByOne()
Set to true to upload one image per HTTP request; otherwise upload all images in one HTTP request.
|
RequestOutputItem |
setBase64SkipEncodingLargeFileSizeLimit(int fileSizeLimit)
When output type is base64, skips encoding of the files with size equal to or larger than this limit: -1 for skipping none, 0 for always skipping.
|
RequestOutputItem |
setBitsPerPixel(int bitsPerPixel)
Bits per pixel: bit depth of the output image; 0 (auto) | 1 (black/white) | 8 | 16 | 24 | 32
|
RequestOutputItem |
setFormat(java.lang.String format)
Image format, any of Imaging.FORMAT_JPG ...
|
RequestOutputItem |
setJpegQuality(int jpegQuality)
Only for JPG format; default value: 80
|
RequestOutputItem |
setPdfaCompliant(boolean pdfaCompliant)
Set to true to output PDF/A compliant PDF.
|
RequestOutputItem |
setPdfForceBlackWhite(boolean pdfForceBlackWhite)
Force to output black/white PDF to save space.
|
RequestOutputItem |
setPdfOwnerPassword(java.lang.String pdfOwnerPassword)
PDF owner password
|
RequestOutputItem |
setPdfTextLine(java.lang.String pdfTextLine)
Optionally prints a line of text at the bottom of the first page.
|
RequestOutputItem |
setPdfUserPassword(java.lang.String pdfUserPassword)
PDF user password
|
RequestOutputItem |
setSavePath(java.lang.String savePath)
Target output file path, may contain variable for expansion, e.g., C:\\tmp\\${TMS}${EXT}.
|
RequestOutputItem |
setThumbnailHeight(int thumbnailHeight)
Only for thumbnail output types; default value: 200.
|
RequestOutputItem |
setTiffCompression(java.lang.String tiffCompression)
Any of Imaging.TIFF_COMPRESSION_CCITT_G4 ...
|
RequestOutputItem |
setTiffForceSinglePage(boolean tiffForceSinglePage)
Force to save images into individual single-image tiff files.
|
RequestOutputItem |
setType(java.lang.String type)
Output type, any of Imaging.OUTPUT_SAVE ...
|
RequestOutputItem |
setUploadAfterAllDone(boolean uploadAfterAllDone)
Perform upload after all scans.
|
RequestOutputItem |
setUploadOneByOne(boolean uploadOneByOne)
Set to true to upload one image per HTTP request; otherwise upload all images in one HTTP request.
|
RequestOutputItem |
setUploadSetting(RequestOutputItem.UploadSetting uploadSetting)
must be set when type is Imaging.OUTPUT_UPLOAD or Imaging.OUTPUT_UPLOAD_THUMB.
|
java.util.Map<java.lang.String,java.lang.Object> |
toJsonObject() |
public static final int DEFAULT_THUMBNAIL_HEIGHT
public static final int DEFAULT_JPEG_QUALITY
public RequestOutputItem()
public RequestOutputItem(java.lang.String type, java.lang.String format)
type
- any of Imaging.OUTPUT_SAVE ...format
- any of Imaging.FORMAT_JPG ...public java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class java.lang.Object
java.lang.CloneNotSupportedException
public static RequestOutputItem fromJsonMap(java.util.Map json) throws java.io.IOException
java.io.IOException
public java.util.Map<java.lang.String,java.lang.Object> toJsonObject()
public java.lang.String getType()
public RequestOutputItem setType(java.lang.String type)
public java.lang.String getFormat()
public RequestOutputItem setFormat(java.lang.String format)
public int getThumbnailHeight()
public RequestOutputItem setThumbnailHeight(int thumbnailHeight)
public java.lang.String getSavePath()
public RequestOutputItem setSavePath(java.lang.String savePath)
public int getBitsPerPixel()
public RequestOutputItem setBitsPerPixel(int bitsPerPixel)
public int getJpegQuality()
public RequestOutputItem setJpegQuality(int jpegQuality)
public java.lang.String getTiffCompression()
public RequestOutputItem setTiffCompression(java.lang.String tiffCompression)
public boolean isTiffForceSinglePage()
public RequestOutputItem setTiffForceSinglePage(boolean tiffForceSinglePage)
public boolean isPdfForceBlackWhite()
public RequestOutputItem setPdfForceBlackWhite(boolean pdfForceBlackWhite)
public boolean isPdfaCompliant()
public RequestOutputItem setPdfaCompliant(boolean pdfaCompliant)
public java.lang.String getPdfOwnerPassword()
public RequestOutputItem setPdfOwnerPassword(java.lang.String pdfOwnerPassword)
public java.lang.String getPdfUserPassword()
public RequestOutputItem setPdfUserPassword(java.lang.String pdfUserPassword)
public java.lang.String getPdfTextLine()
public RequestOutputItem setPdfTextLine(java.lang.String pdfTextLine)
public java.util.Map<java.lang.String,java.lang.String> getExifTags()
public RequestOutputItem addExifTag(java.lang.String tagName, java.lang.String value)
public boolean isUploadAfterAllDone()
public RequestOutputItem setUploadAfterAllDone(boolean uploadAfterAllDone)
public boolean isUploadOneByOne()
public RequestOutputItem setUploadOneByOne(boolean uploadOneByOne)
public RequestOutputItem.UploadSetting getUploadSetting()
public RequestOutputItem setUploadSetting(RequestOutputItem.UploadSetting uploadSetting)
public RequestOutputItem setBase64SkipEncodingLargeFileSizeLimit(int fileSizeLimit)
v12.0.5.0 | Copyright © Asprise Software. All Rights Reserved. Please visit the product page at asprise.com