Pr22

Class DocumentReaderDevice

java.lang.Object

Pr22.DocumentReaderDevice

public class DocumentReaderDevice
extends java.lang.Object

Central class for a document reader device. A device is composed of several modules. These modules can be accessed through this class.

Constructor Summary

Constructors

Constructor and Description
DocumentReaderDevice() Initializes the Document Reader software.
DocumentReaderDevice(java.lang.String proppath) Initializes the Document Reader software with a specified property path.

Method Summary

Modifier and Type	Method and Description
void	addEventListener(java.util.EventListener ev) Sets an event handler method to a specified event.
void	close() Ends using of the current device.
Certificates	getCertificateManager() Returns the certificate manager that stores certificates for task of the current DocumentReaderDevice device.
static java.util.ArrayList<java.lang.String>	getDeviceList() Collects a list of device names for useDevice(String) method.
java.lang.String	getDeviceName() Returns the name of the device.
Engine	getEngine() Returns the data analyzer module of the used DocumentReaderDevice.
Certificates	getGlobalCertificateManager() Returns the certificate manager that stores certificates for all task of the entire process.
Peripherals	getPeripherals() Returns the device peripheral controller module of the used DocumentReaderDevice.
java.lang.String	getProperty(java.lang.String property) Returns a property value of the PassportReader system.
java.util.ArrayList<ECardReader>	getReaders() Returns a list of all the electronic card reader (Smartcard, RFID card or Magnetic stripe card) module(s) of the used DocumentReaderDevice.
DocScanner	getScanner() Returns the document scanner module of the used DocumentReaderDevice.
java.lang.String	getVersion(char component) Returns version information of the API.
void	removeEventListener(java.util.EventListener ev) Removes an event handler method from a specified event.
void	setProperty(java.lang.String property, java.lang.String value) Sets a property value of the PassportReader system.
DocumentReaderDevice	useDevice(int devno) Starts using a device.
DocumentReaderDevice	useDevice(java.lang.String devname) Starts using a device.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentReaderDevice

public DocumentReaderDevice()
                     throws General

Initializes the Document Reader software.

Throws:

General

DocumentReaderDevice

public DocumentReaderDevice(java.lang.String proppath)
                     throws General

Initializes the Document Reader software with a specified property path. Specified path means the initial data are read from the gxsd.dat file from the specified xml node.

Parameters:

proppath - Name of the xml node of the gxsd.dat file from where the initial data should be read.

Throws:

General

Method Detail

addEventListener

public void addEventListener(java.util.EventListener ev)
                      throws General

Sets an event handler method to a specified event.

Parameters:

ev - The event handler class and method.

Throws:

General

removeEventListener

public void removeEventListener(java.util.EventListener ev)
                         throws General

Removes an event handler method from a specified event.

Parameters:

ev - The event handler class and method.

Throws:

General

getDeviceList

public static java.util.ArrayList<java.lang.String> getDeviceList()
                                                           throws General

Collects a list of device names for useDevice(String) method.

Returns:

List of device names.

Throws:

General

useDevice

public DocumentReaderDevice useDevice(int devno)
                               throws General

Starts using a device.

Parameters:

devno - Ordinal number of the device to use.

Returns:

This object.

Throws:

General

useDevice

public DocumentReaderDevice useDevice(java.lang.String devname)
                               throws General

Starts using a device.

Parameters:

devname - Name of the device to use. The list of available names can be requested from the getDeviceList().

Returns:

This object.

Throws:

General

getDeviceName

public java.lang.String getDeviceName()
                               throws General

Returns the name of the device.

Returns:

The name of the device.

Throws:

General

getVersion

public java.lang.String getVersion(char component)

Returns version information of the API.

Parameters:

component - Character 'A' for version of the java interface files, or character 'S' for version of the PassportReader system.

Returns:

Version string.

close

public void close()
           throws General

Ends using of the current device.

Throws:

General

setProperty

public void setProperty(java.lang.String property,
                        java.lang.String value)
                 throws General

Sets a property value of the PassportReader system. The names and values of the properties are documented in the PassportReader reference manual.

Parameters:

property - The name of the property.

value - The value of the property.

Throws:

General

getProperty

public java.lang.String getProperty(java.lang.String property)
                             throws General

Returns a property value of the PassportReader system. The names and values of the properties are documented in the PassportReader reference manual.

Parameters:

property - The name of the property.

Returns:

The value of the property.

Throws:

General

getGlobalCertificateManager

public Certificates getGlobalCertificateManager()
                                         throws General

Returns the certificate manager that stores certificates for all task of the entire process.

Returns:

The certificate manager.

Throws:

General

getCertificateManager

public Certificates getCertificateManager()
                                   throws General

Returns the certificate manager that stores certificates for task of the current DocumentReaderDevice device.

Returns:

The certificate manager.

Throws:

General

getPeripherals

public Peripherals getPeripherals()
                           throws General

Returns the device peripheral controller module of the used DocumentReaderDevice.

Returns:

The peripheral controller module.

Throws:

General

getScanner

public DocScanner getScanner()

Returns the document scanner module of the used DocumentReaderDevice.

Returns:

The document scanner module.

getReaders

public java.util.ArrayList<ECardReader> getReaders()

Returns a list of all the electronic card reader (Smartcard, RFID card or Magnetic stripe card) module(s) of the used DocumentReaderDevice.

Returns:

List of card reader devices.

getEngine

public Engine getEngine()

Returns the data analyzer module of the used DocumentReaderDevice.

Returns:

The data analyzer module.