Package de.gmxhome.conrad.jpos.jpos_base.checkscanner

Class CheckScannerDataEvent

java.lang.Object

java.util.EventObject

jpos.events.JposEvent

jpos.events.DataEvent

de.gmxhome.conrad.jpos.jpos_base.JposDataEvent

de.gmxhome.conrad.jpos.jpos_base.checkscanner.CheckScannerDataEvent

All Implemented Interfaces:

Serializable

public class CheckScannerDataEvent
extends JposDataEvent

Data event implementation for CheckScanner devices.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
Integer	DocumentHeight	New document height in dot units.
Integer	DocumentWidth	New document width in dot units.
String	FileID	New contents of FileID property.
int	FileIndex	New contents of FileIndex property.
byte[]	ImageData	New contents of ImageData property.
String	ImageTagData	New contents of ImageTagData property.
Integer	Quality	Resolution of the scan image in DPI.

Fields inherited from class jpos.events.DataEvent

status

Fields inherited from class jpos.events.JposEvent

sequenceNumber

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
CheckScannerDataEvent(JposBase source, int state, int fileIndex, byte[] imageData, Integer documentHeight, Integer documentWidth, String fileID, String imageTagData, Integer quality)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	setDataProperties()	Sets the data properties stored within the JposDataEvent into the JposCommonProperties object.
String	toLogString()	Generates string describing the data event for logging purposes.

Methods inherited from class de.gmxhome.conrad.jpos.jpos_base.JposDataEvent

getPropertySet

Methods inherited from class jpos.events.DataEvent

getStatus

Methods inherited from class jpos.events.JposEvent

getSequenceNumber, getWhen, incrSequenceNumber, updateSequenceNumber

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Field Details

FileID

public final String FileID

New contents of FileID property. Must be set if CapAutoGenerateFileID is true. For details, see UPOS specification.

FileIndex

public final int FileIndex

New contents of FileIndex property. For details, see UPOS specification.

ImageData

public final byte[] ImageData

New contents of ImageData property. For details, see UPOS specification.

ImageTagData

public final String ImageTagData

New contents of ImageTagData property. Must be set if CapAutoGenerateImageTagData is true. For details, see UPOS specification.

DocumentHeight

public final Integer DocumentHeight

New document height in dot units. See Quality for details.

DocumentWidth

public final Integer DocumentWidth

New document width in dot units. See Quality for details.

Quality

public final Integer Quality

Resolution of the scan image in DPI. For example, if Quality equals 320 and the scan image is 3 x 6 inch, DocumentHeight must be equal to 960 and DocumentWidth equal to 1920.

Constructor Details

CheckScannerDataEvent

public CheckScannerDataEvent(JposBase source,
 int state,
 int fileIndex,
 byte[] imageData,
 Integer documentHeight,
 Integer documentWidth,
 String fileID,
 String imageTagData,
 Integer quality)

Constructor. Parameters passed to base class unchanged.

Parameters:

source - Source, for services implemented with this framework, the (deviceclass.)DeviceClassService object.

state - Status, see UPOS specification.

fileIndex - Value to be set in property FileIndex before this DataEvent will be delivered.

imageData - Value to be set in property ImageData before this DataEvent will be delivered.

documentHeight - Document height in dots, used to compute property DocumentHeight before this DataEvent will be delivered.

documentWidth - Document width in dots, used to compute property DocumentWidth before this DataEvent will be delivered.

fileID - Value to be set in property FileID before this DataEvent will be delivered.

imageTagData - Value to be set in property ImageTagData before this DataEvent will be delivered.

quality - Value to be set in property Quality before this DataEvent will be delivered.

Method Details

setDataProperties

public void setDataProperties()

Description copied from class: JposDataEvent

Sets the data properties stored within the JposDataEvent into the JposCommonProperties object. The corresponding properties must be defined within derived classes.

Overrides:

setDataProperties in class JposDataEvent

toLogString

public String toLogString()

Description copied from class: JposDataEvent

Generates string describing the data event for logging purposes.

Overrides:

toLogString in class JposDataEvent

Returns:

Describing string.