Pr22

Class FingerprintScannerDevice

java.lang.Object

Pr22.FingerprintScannerDevice

public class FingerprintScannerDevice
extends java.lang.Object

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

Constructor Summary

Constructors

Constructor and Description
FingerprintScannerDevice() Initializes the Fingerprint Scanner software.
FingerprintScannerDevice(java.lang.String proppath) Initializes the Fingerprint Scanner 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.
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.
Peripherals	getPeripherals() Returns the device peripheral controller module of the used FingerprintScannerDevice.
java.lang.String	getProperty(java.lang.String property) Returns a property value of the Fingerprint Scanner system.
FingerScanner	getScanner() Returns the finger scanner module of the used FingerprintScannerDevice.
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 Fingerprint Scanner system.
FingerprintScannerDevice	useDevice(int devno) Starts using a device.
FingerprintScannerDevice	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

FingerprintScannerDevice

public FingerprintScannerDevice()
                         throws General

Initializes the Fingerprint Scanner software.

Throws:

General

FingerprintScannerDevice

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

Initializes the Fingerprint Scanner 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 FingerprintScannerDevice 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 FingerprintScannerDevice 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 Fingerprint Scanner 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 Fingerprint Scanner system. The names and values of the properties are documented in the Fingerprint Scanner 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 Fingerprint Scanner system. The names and values of the properties are documented in the Fingerprint Scanner reference manual.

Parameters:

property - The name of the property.

Returns:

The value of the property.

Throws:

General

getPeripherals

public Peripherals getPeripherals()
                           throws General

Returns the device peripheral controller module of the used FingerprintScannerDevice.

Returns:

The peripheral controller module.

Throws:

General

getScanner

public FingerScanner getScanner()

Returns the finger scanner module of the used FingerprintScannerDevice.

Returns:

The finger scanner module.