com.asprise.imaging.core

Class ResultOutputItem

java.lang.Object

com.asprise.imaging.core.ResultOutputItem

public class ResultOutputItem
extends java.lang.Object

Represents an output..

Method Summary

Modifier and Type	Method and Description
static ResultOutputItem	createScanResultOutputItem(java.util.Map<java.lang.String,java.lang.Object> jsonOutputObject) Creates ScanResultOutputItem if the jsonOutputObject is not null.
java.util.List<java.io.File>	getFiles() List of output files for Imaging.OUTPUT_SAVE and Imaging.OUTPUT_SAVE_THUMB.
java.lang.String	getFormat() Image format - any of Imaging.FORMAT_JPG ...
int	getOutputRecordCount() Number of records.
java.util.List<java.lang.String>	getOutputRecords() List of output records.
java.lang.String	getSelectedAction()
java.lang.String	getSelectedFileName()
java.lang.String	getType() Output type - any of Imaging.OUTPUT_SAVE ...
java.awt.image.BufferedImage	loadImage(int recordIndex) Loads the image represented by the given record if output type is one of: Imaging.OUTPUT_SAVE, Imaging.OUTPUT_SAVE_THUMB, Imaging.OUTPUT_RETURN_BASE64, and Imaging.OUTPUT_RETURN_BASE64_THUMB.
void	setOutputRecords(java.util.List<java.lang.String> outputRecords)
void	setSelectedAction(java.lang.String selectedAction)
void	setSelectedFileName(java.lang.String selectedFileName)
java.util.Map<java.lang.String,java.lang.Object>	toJsonObject()
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

toJsonObject

public java.util.Map<java.lang.String,java.lang.Object> toJsonObject()

createScanResultOutputItem

public static ResultOutputItem createScanResultOutputItem(java.util.Map<java.lang.String,java.lang.Object> jsonOutputObject)

Creates ScanResultOutputItem if the jsonOutputObject is not null.

Parameters:

jsonOutputObject -

Returns:

ScanResultOutputItem created or null if jsonOutputObject is null.

getType

public java.lang.String getType()

Output type - any of Imaging.OUTPUT_SAVE ...

Returns:

getFormat

public java.lang.String getFormat()

Image format - any of Imaging.FORMAT_JPG ...

Returns:

getSelectedAction

public java.lang.String getSelectedAction()

setSelectedAction

public void setSelectedAction(java.lang.String selectedAction)

getSelectedFileName

public java.lang.String getSelectedFileName()

setSelectedFileName

public void setSelectedFileName(java.lang.String selectedFileName)

getOutputRecordCount

public int getOutputRecordCount()

Number of records.

Returns:

getOutputRecords

public java.util.List<java.lang.String> getOutputRecords()

List of output records. Depending on output type, record type can be:

• path to file for Imaging.OUTPUT_SAVE, Imaging.OUTPUT_SAVE_THUMB;
• server response for Imaging.OUTPUT_UPLOAD, Imaging.OUTPUT_UPLOAD_THUMB;
• image data in base64 for Imaging.OUTPUT_RETURN_BASE64, Imaging.OUTPUT_RETURN_BASE64_THUMB.

Returns:

List of output records or empty list if there is no record.

setOutputRecords

public void setOutputRecords(java.util.List<java.lang.String> outputRecords)

getFiles

public java.util.List<java.io.File> getFiles()

List of output files for Imaging.OUTPUT_SAVE and Imaging.OUTPUT_SAVE_THUMB.

Returns:

List of output records or null if the type is not Imaging.OUTPUT_SAVE or Imaging.OUTPUT_SAVE_THUMB.

loadImage

public java.awt.image.BufferedImage loadImage(int recordIndex)

Loads the image represented by the given record if output type is one of: Imaging.OUTPUT_SAVE, Imaging.OUTPUT_SAVE_THUMB, Imaging.OUTPUT_RETURN_BASE64, and Imaging.OUTPUT_RETURN_BASE64_THUMB.

Parameters:

recordIndex -

Returns:

Throws:

java.lang.IndexOutOfBoundsException - if recordIndex is not valid.

TwainException - in case of other errors.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object