AbstractDevice (Battery Manager)

java.lang.Object
- com.lf.battman.io.AbstractDevice

All Implemented Interfaces:

com.lf.commons.model.ConfigurableUnit

Direct Known Subclasses:

CustomDevice, SerialDevice, USBDevice
```
public abstract class AbstractDevice
extends java.lang.Object
implements com.lf.commons.model.ConfigurableUnit
```
Interface for devices connected to serial ports (RS-232, USB, ...).
This is the base class for more specific subclasses like SerialDevice or USBDevice. All constants for configuration parameters are centralized here while specific fields are declared by the subclasses (e.g. SerialPortWindow references).

Since:

1.6

Version:

$Revision: 1.5 $, $Date: 2015/02/03 16:21:40 $

Author:

Axel Schwolow

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`BARCODE_FORMAT_GENERIC` Represents the generic barcode reader format (configurable).
`static java.lang.String`	`BARCODE_FORMAT_TEXTCRLF` Represents the default barcode reader format with CRLF terminators.
`static java.lang.String`	`BARCODE_READER_FORMAT` Barcode reader specific parameter.
`static java.lang.String`	`BARCODE_READER_REGEX` Barcode reader specific parameter.
`static java.lang.String`	`BARCODE_READER_REGEX_GROUP` Barcode reader specific parameter.
`static java.lang.String`	`COMM_BAUDRATE` Serial communication baud rate (110,...,256000).
`static java.lang.String`	`COMM_DATABITS` Serial communication data bits (5,6,7,8).
`static java.lang.String`	`COMM_FLOWCONTROL` Serial communication set RTS (RTS,DTR).
`static java.lang.String`	`COMM_INTERFACE` Serial communication interface (RS-232,RS-485,... not USB!).
`static java.lang.String`	`COMM_PARITY` Serial communication parity (EVEN,MARK,NONE,ODD).
`static java.lang.String`	`COMM_STOPBITS` Serial communication stop bits (1,1.5,2).
`static java.lang.String`	`DEV_BARCODE_READER` Represents a bar code reader device.
`static java.lang.String`	`DEV_CHARGER` Represents a charger device.
`static java.lang.String`	`DEV_POWER` Represents a power switch device.
`static java.lang.String`	`DEV_RFID_READER` Represents a RFID reader device.
`protected com.lf.commons.db.DatabaseConnector`	`dvConnector` The database connector for this device (DEVICE.DVID).
`protected int`	`dvid` The database ID for this device.
`protected java.net.URL`	`figureURL` Device figure image (optional).
`static java.lang.String`	`RFID_CONVERT_10DEC` Represents the decimal format to convert from hexadecimal.
`static java.lang.String`	`RFID_CONVERT_10HEX` Represents the hexadecimal format to convert from decimal.
`static java.lang.String`	`RFID_CONVERT_8HEX` Represents the hexadecimal format to convert from decimal.
`static java.lang.String`	`RFID_FORMAT_10DEC_STX8ETX` Represents the decimal RFID tag format with length of 8 characters.
`static java.lang.String`	`RFID_FORMAT_10HEX_STX10CRLFETX` Represents the hexadecimal RFID tag format with length of 10 characters.
`static java.lang.String`	`RFID_FORMAT_8HEX_STX8CRLFETX` Represents the hexadecimal RFID tag format with length of 8 characters.
`static java.lang.String`	`RFID_FORMAT_GENERIC_DEC` Represents the generic decimal RFID tag format (configurable).
`static java.lang.String`	`RFID_FORMAT_GENERIC_HEX` Represents the generic hexadecimal RFID tag format (configurable).
`static java.lang.String`	`RFID_READER_CONVERT` RFID reader specific parameter.
`static java.lang.String`	`RFID_READER_FORMAT` RFID reader specific parameter.
`static java.lang.String`	`RFID_READER_REGEX` RFID reader specific parameter.
`static java.lang.String`	`RFID_READER_REGEX_GROUP` RFID reader specific parameter.
`protected java.lang.String`	`type` Device type identifier.
`static java.lang.String`	`USB_PRODUCT_ID` Hexadecimal USB device product identifier, see `USBIds.getProductNameByID()` method.
`static java.lang.String`	`USB_RELEASE` USB device release number (58.1, 2.0).
`static java.lang.String`	`USB_VENDOR_ID` Hexadecimal USB device vendor identifier, see `USBIds.getVendorNameByID()` method.
`static java.lang.String`	`USB_VERSION` USB interface version (1.1, 2.0), see `getUSBVersionDescription()` method.

Constructor Summary

Constructors
Constructor and Description
`AbstractDevice()` Constructor method for i18n purposes only.
`AbstractDevice(java.lang.String type, java.net.URL figureurl)` Constructs an instance based on the parameters.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`configureUnit(java.lang.String id, com.lf.commons.config.Configuration config)` Restores values from persistent data stores.
`static AbstractDevice`	`createDevice(java.lang.String type, int dvid, com.lf.commons.db.DatabaseConnector connector)` Creates a new instance of the given device type.
`com.lf.commons.db.DatabaseConnector`	`getConnector()` Provides the database connector for this device.
`abstract java.lang.String`	`getDeviceClass()` Provides the class type of this device (charger, RFID reader, ...).
`static java.lang.String`	`getDeviceClass(java.lang.String type)` Provides an appropriate device class for the given device type.
`static javax.swing.ImageIcon`	`getDeviceIcon(java.lang.String devclass)` Provides an appropriate icon for the given device class.
`int`	`getDeviceID()` Provides the ID for this device.
`static java.lang.String`	`getDeviceToolTip(java.lang.String devclass)` Provides an appropriate tooltip for the given device class.
`abstract java.awt.Component`	`getFigureDisplay()` Provides the canvas to display the device figure.
`abstract java.awt.Component`	`getLiveDisplay()` Provides the canvas to display the device live data.
`abstract java.awt.Component`	`getOptionsDisplay()` Provides the canvas to display additional device options.
`abstract java.util.Properties`	`getParams()` Provides the parameters to configure the serial port.
`abstract boolean`	`getParamsConfigurable()` May the parameters of this device be configured?
`static java.lang.String`	`getSupportedBarcodeFormatDescription(java.lang.String format)` Provides the barcode data tag format description for the given format.
`static java.lang.String[]`	`getSupportedBarcodeFormatDescriptions()` Provides the supported barcode data format descriptions.
`static java.lang.String[]`	`getSupportedBarcodeFormatRegex(java.lang.String format)` Provides the preset values (regex and group) for a certain barcode data format.
`static java.lang.String[]`	`getSupportedBarcodeFormats()` Provides the supported barcode data formats (default types).
`static java.lang.Integer[]`	`getSupportedBaudrates()` Provides the supported device baud rates.
`static java.lang.String[]`	`getSupportedBays()` Provides the list of supported device bays (chargers only).
`static java.lang.String[]`	`getSupportedBays(java.lang.String type)` Provides the list of supported device bays (special type.
`static java.lang.Integer[]`	`getSupportedDatabits()` Provides the supported device databits.
`static java.lang.String`	`getSupportedFlowControlDescription(java.lang.String value)` Provides the flow control description for the given numeric value.
`static java.lang.String[]`	`getSupportedFlowControlDescriptions()` Provides the supported device flow control value descriptions.
`static java.lang.Integer[]`	`getSupportedFlowControls()` Provides the supported device flow control values.
`static java.lang.String[]`	`getSupportedInterfaces()` Provides the supported device interfaces.
`static java.lang.Integer[]`	`getSupportedParities()` Provides the supported device parity values.
`static java.lang.String`	`getSupportedParityDescription(java.lang.String value)` Provides the parity description for the given numeric value.
`static java.lang.String[]`	`getSupportedParityDescriptions()` Provides the supported device parity value descriptions.
`static java.lang.String[]`	`getSupportedPrograms()` Provides the list of supported device programs (chargers only).
`static java.lang.String[]`	`getSupportedPrograms(java.lang.String type)` Provides the list of supported device programs (special type.
`static java.lang.String`	`getSupportedRFIDConvertFormatDescription(java.lang.String format)` Provides the RFID tag format description for the given convert format.
`static java.lang.String[]`	`getSupportedRFIDConvertFormatDescriptions()` Provides the supported RFID tag format descriptions.
`static java.lang.String[]`	`getSupportedRFIDConvertFormats()` Provides the supported RFID tag formats (target types for auto-convert).
`static java.lang.String`	`getSupportedRFIDFormatDescription(java.lang.String format)` Provides the RFID tag format description for the given format.
`static java.lang.String[]`	`getSupportedRFIDFormatDescriptions()` Provides the supported RFID tag format descriptions.
`static java.lang.String[]`	`getSupportedRFIDFormatRegex(java.lang.String format)` Provides the preset values (regex and group) for a certain RFID tag format.
`static java.lang.String[]`	`getSupportedRFIDFormats()` Provides the supported RFID tag formats (default types).
`static java.lang.String[]`	`getSupportedStatus()` Provides the list of supported device status values (chargers only).
`static java.lang.String[]`	`getSupportedStatus(java.lang.String type)` Provides the list of supported device status values (special type.
`static java.lang.String`	`getSupportedStopbitDescription(java.lang.String value)` Provides the stopbit description for the given numeric value.
`static java.lang.String[]`	`getSupportedStopbitDescriptions()` Provides the supported device stopbit value descriptions.
`static java.lang.Integer[]`	`getSupportedStopbits()` Provides the supported device stopbits.
`java.lang.String`	`getType()` Provides the type of this device.
`static java.lang.String`	`getUSBVersionDescription(java.lang.String version)` Provides the display text for the given USB standard.
`abstract boolean`	`isFunctional()` Checks if this device can be used.
`void`	`setDevice(int dvid, com.lf.commons.db.DatabaseConnector connector)` Sets the database entry data for this device.
`void`	`storeUnit(java.lang.String id, com.lf.commons.config.Configuration config)` Stores the current configuration values persistently.
`void`	`unitRegistered(com.lf.commons.model.ApplicationModel model, java.lang.String id)` Informs the configurable unit that it was registered with a model.
`void`	`unitUnregistered(com.lf.commons.model.ApplicationModel model, java.lang.String id)` Informs the configurable unit that it was unregistered with a model.
`abstract void`	`updateStatus()` Called regularly by a separate thread e.g. to update connected status icon.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEV_CHARGER
```
public static final java.lang.String DEV_CHARGER
```
    Represents a charger device.
    
    See Also:
    Constant Field Values
  - DEV_RFID_READER
```
public static final java.lang.String DEV_RFID_READER
```
    Represents a RFID reader device.
    
    See Also:
    Constant Field Values
  - DEV_POWER
```
public static final java.lang.String DEV_POWER
```
    Represents a power switch device.
    
    See Also:
    Constant Field Values
  - DEV_BARCODE_READER
```
public static final java.lang.String DEV_BARCODE_READER
```
    Represents a bar code reader device.
    
    See Also:
    Constant Field Values
  - COMM_INTERFACE
```
public static final java.lang.String COMM_INTERFACE
```
    Serial communication interface (RS-232,RS-485,... not USB!).
    
    See Also:
    Constant Field Values
  - COMM_BAUDRATE
```
public static final java.lang.String COMM_BAUDRATE
```
    Serial communication baud rate (110,...,256000).
    
    See Also:
    Constant Field Values
  - COMM_DATABITS
```
public static final java.lang.String COMM_DATABITS
```
    Serial communication data bits (5,6,7,8).
    
    See Also:
    Constant Field Values
  - COMM_STOPBITS
```
public static final java.lang.String COMM_STOPBITS
```
    Serial communication stop bits (1,1.5,2).
    
    See Also:
    Constant Field Values
  - COMM_PARITY
```
public static final java.lang.String COMM_PARITY
```
    Serial communication parity (EVEN,MARK,NONE,ODD).
    
    See Also:
    Constant Field Values
  - COMM_FLOWCONTROL
```
public static final java.lang.String COMM_FLOWCONTROL
```
    Serial communication set RTS (RTS,DTR).
    
    See Also:
    Constant Field Values
  - RFID_FORMAT_GENERIC_HEX
```
public static final java.lang.String RFID_FORMAT_GENERIC_HEX
```
    Represents the generic hexadecimal RFID tag format (configurable).
    
    See Also:
    Constant Field Values
  - RFID_FORMAT_GENERIC_DEC
```
public static final java.lang.String RFID_FORMAT_GENERIC_DEC
```
    Represents the generic decimal RFID tag format (configurable).
    
    See Also:
    Constant Field Values
  - RFID_FORMAT_8HEX_STX8CRLFETX
```
public static final java.lang.String RFID_FORMAT_8HEX_STX8CRLFETX
```
    Represents the hexadecimal RFID tag format with length of 8 characters.
    
    See Also:
    Constant Field Values
  - RFID_FORMAT_10HEX_STX10CRLFETX
```
public static final java.lang.String RFID_FORMAT_10HEX_STX10CRLFETX
```
    Represents the hexadecimal RFID tag format with length of 10 characters.
    
    See Also:
    Constant Field Values
  - RFID_FORMAT_10DEC_STX8ETX
```
public static final java.lang.String RFID_FORMAT_10DEC_STX8ETX
```
    Represents the decimal RFID tag format with length of 8 characters.
    
    See Also:
    Constant Field Values
  - RFID_CONVERT_8HEX
```
public static final java.lang.String RFID_CONVERT_8HEX
```
    Represents the hexadecimal format to convert from decimal.
    
    See Also:
    Constant Field Values
  - RFID_CONVERT_10HEX
```
public static final java.lang.String RFID_CONVERT_10HEX
```
    Represents the hexadecimal format to convert from decimal.
    
    See Also:
    Constant Field Values
  - RFID_CONVERT_10DEC
```
public static final java.lang.String RFID_CONVERT_10DEC
```
    Represents the decimal format to convert from hexadecimal.
    
    See Also:
    Constant Field Values
  - RFID_READER_FORMAT
```
public static final java.lang.String RFID_READER_FORMAT
```
    RFID reader specific parameter.
    
    See Also:
    Constant Field Values
  - RFID_READER_REGEX
```
public static final java.lang.String RFID_READER_REGEX
```
    RFID reader specific parameter.
    
    See Also:
    Constant Field Values
  - RFID_READER_REGEX_GROUP
```
public static final java.lang.String RFID_READER_REGEX_GROUP
```
    RFID reader specific parameter.
    
    See Also:
    Constant Field Values
  - RFID_READER_CONVERT
```
public static final java.lang.String RFID_READER_CONVERT
```
    RFID reader specific parameter.
    
    See Also:
    Constant Field Values
  - BARCODE_FORMAT_GENERIC
```
public static final java.lang.String BARCODE_FORMAT_GENERIC
```
    Represents the generic barcode reader format (configurable).
    
    See Also:
    Constant Field Values
  - BARCODE_FORMAT_TEXTCRLF
```
public static final java.lang.String BARCODE_FORMAT_TEXTCRLF
```
    Represents the default barcode reader format with CRLF terminators.
    
    See Also:
    Constant Field Values
  - BARCODE_READER_FORMAT
```
public static final java.lang.String BARCODE_READER_FORMAT
```
    Barcode reader specific parameter.
    
    See Also:
    Constant Field Values
  - BARCODE_READER_REGEX
```
public static final java.lang.String BARCODE_READER_REGEX
```
    Barcode reader specific parameter.
    
    See Also:
    Constant Field Values
  - BARCODE_READER_REGEX_GROUP
```
public static final java.lang.String BARCODE_READER_REGEX_GROUP
```
    Barcode reader specific parameter.
    
    See Also:
    Constant Field Values
  - USB_VERSION
```
public static final java.lang.String USB_VERSION
```
    USB interface version (1.1, 2.0), see getUSBVersionDescription() method.
    
    See Also:
    Constant Field Values
  - USB_VENDOR_ID
```
public static final java.lang.String USB_VENDOR_ID
```
    Hexadecimal USB device vendor identifier, see USBIds.getVendorNameByID() method.
    
    See Also:
    Constant Field Values
  - USB_PRODUCT_ID
```
public static final java.lang.String USB_PRODUCT_ID
```
    Hexadecimal USB device product identifier, see USBIds.getProductNameByID() method.
    
    See Also:
    Constant Field Values
  - USB_RELEASE
```
public static final java.lang.String USB_RELEASE
```
    USB device release number (58.1, 2.0).
    
    See Also:
    Constant Field Values
  - type
```
protected java.lang.String type
```
    Device type identifier.
  - figureURL
```
protected java.net.URL figureURL
```
    Device figure image (optional).
  - dvid
```
protected int dvid
```
    The database ID for this device.
  - dvConnector
```
protected com.lf.commons.db.DatabaseConnector dvConnector
```
    The database connector for this device (DEVICE.DVID).
- Constructor Detail
  - AbstractDevice
```
public AbstractDevice()
               throws java.lang.InstantiationException
```
    Constructor method for i18n purposes only.
    Can only be used if beans design time is set (e.g. by external tools like the I18NExtractor).
    
    Throws:
    
    java.lang.InstantiationException - Error indication
    Since:
    
    1.6
  - AbstractDevice
```
public AbstractDevice(java.lang.String type,
              java.net.URL figureurl)
```
    Constructs an instance based on the parameters.
    
    Parameters:
    type - The device type identifier, required
    figureurl - The device figure (optional)
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
- Method Detail
  - getSupportedBays
```
public static java.lang.String[] getSupportedBays()
```
    Provides the list of supported device bays (chargers only).
    
    Returns:
    The bay identifiers (1, 2, A, B, ...)
    Since:
    
    1.6
  - getSupportedBays
```
public static java.lang.String[] getSupportedBays(java.lang.String type)
```
    Provides the list of supported device bays (special type.
    
    Parameters:
    type - The official device type
    
    Returns:
    The bay identifiers (1, 2, A, B, ...)
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    Since:
    
    1.6
  - getSupportedPrograms
```
public static java.lang.String[] getSupportedPrograms()
```
    Provides the list of supported device programs (chargers only).
    
    Returns:
    The program identifiers (CHA, CHK, ...)
    Since:
    
    1.6
  - getSupportedPrograms
```
public static java.lang.String[] getSupportedPrograms(java.lang.String type)
```
    Provides the list of supported device programs (special type.
    
    Parameters:
    type - The official device type
    
    Returns:
    The program identifiers (CHA, CHK, ...)
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    Since:
    
    1.6
  - getSupportedStatus
```
public static java.lang.String[] getSupportedStatus()
```
    Provides the list of supported device status values (chargers only).
    
    Returns:
    The program identifiers (RDY, ERR, ...)
    Since:
    
    1.6
  - getSupportedStatus
```
public static java.lang.String[] getSupportedStatus(java.lang.String type)
```
    Provides the list of supported device status values (special type.
    
    Parameters:
    type - The official device type
    
    Returns:
    The program identifiers (RDY, ERR, ...)
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    Since:
    
    1.6
  - getSupportedInterfaces
```
public static java.lang.String[] getSupportedInterfaces()
```
    Provides the supported device interfaces.
    
    Returns:
    The values (RS-232, ...)
    Since:
    
    1.6
  - getSupportedBaudrates
```
public static java.lang.Integer[] getSupportedBaudrates()
```
    Provides the supported device baud rates.
    
    Returns:
    The values (300, ...)
    Since:
    
    1.6
  - getSupportedDatabits
```
public static java.lang.Integer[] getSupportedDatabits()
```
    Provides the supported device databits.
    
    Returns:
    The values (5, ...)
    Since:
    
    1.6
  - getSupportedStopbits
```
public static java.lang.Integer[] getSupportedStopbits()
```
    Provides the supported device stopbits.
    
    Returns:
    The values (1, ...)
    Since:
    
    1.6
  - getSupportedStopbitDescriptions
```
public static java.lang.String[] getSupportedStopbitDescriptions()
```
    Provides the supported device stopbit value descriptions.
    
    Returns:
    The descriptions
    Since:
    
    1.6
  - getSupportedStopbitDescription
```
public static java.lang.String getSupportedStopbitDescription(java.lang.String value)
```
    Provides the stopbit description for the given numeric value.
    
    Parameters:
    value - The value 0, 1, ...
    
    Returns:
    The description, null otherwise
    Since:
    
    1.6
  - getSupportedParities
```
public static java.lang.Integer[] getSupportedParities()
```
    Provides the supported device parity values.
    
    Returns:
    The values (1, ...)
    Since:
    
    1.6
  - getSupportedParityDescriptions
```
public static java.lang.String[] getSupportedParityDescriptions()
```
    Provides the supported device parity value descriptions.
    
    Returns:
    The descriptions
    Since:
    
    1.6
  - getSupportedParityDescription
```
public static java.lang.String getSupportedParityDescription(java.lang.String value)
```
    Provides the parity description for the given numeric value.
    
    Parameters:
    value - The value 0, 1, ...
    
    Returns:
    The description, null otherwise
    Since:
    
    1.6
  - getSupportedFlowControls
```
public static java.lang.Integer[] getSupportedFlowControls()
```
    Provides the supported device flow control values.
    
    Returns:
    The values (1, ...)
    Since:
    
    1.6
  - getSupportedFlowControlDescriptions
```
public static java.lang.String[] getSupportedFlowControlDescriptions()
```
    Provides the supported device flow control value descriptions.
    
    Returns:
    The descriptions
    Since:
    
    1.6
  - getSupportedFlowControlDescription
```
public static java.lang.String getSupportedFlowControlDescription(java.lang.String value)
```
    Provides the flow control description for the given numeric value.
    
    Parameters:
    value - The value 0, 1, ...
    
    Returns:
    The description, null otherwise
    Since:
    
    1.6
  - getSupportedRFIDFormats
```
public static java.lang.String[] getSupportedRFIDFormats()
```
    Provides the supported RFID tag formats (default types).
    
    Returns:
    The formats
    Since:
    
    1.6
  - getSupportedRFIDFormatDescriptions
```
public static java.lang.String[] getSupportedRFIDFormatDescriptions()
```
    Provides the supported RFID tag format descriptions.
    
    Returns:
    The descriptions
    Since:
    
    1.6
  - getSupportedRFIDFormatDescription
```
public static java.lang.String getSupportedRFIDFormatDescription(java.lang.String format)
```
    Provides the RFID tag format description for the given format.
    
    Parameters:
    format - The tag format ID like "8HEX_STX8CRLFETX"
    
    Returns:
    The description, null otherwise
    Since:
    
    1.6
  - getSupportedRFIDFormatRegex
```
public static java.lang.String[] getSupportedRFIDFormatRegex(java.lang.String format)
```
    Provides the preset values (regex and group) for a certain RFID tag format.
    
    Parameters:
    format - The tag format ID like "8HEX_STX8CRLFETX"
    
    Returns:
    The regex, index 0=regex, index 1=group, null otherwise
    Since:
    
    1.6
  - getSupportedRFIDConvertFormats
```
public static java.lang.String[] getSupportedRFIDConvertFormats()
```
    Provides the supported RFID tag formats (target types for auto-convert).
    
    Returns:
    The formats
    Since:
    
    1.6
  - getSupportedRFIDConvertFormatDescriptions
```
public static java.lang.String[] getSupportedRFIDConvertFormatDescriptions()
```
    Provides the supported RFID tag format descriptions.
    
    Returns:
    The descriptions
    Since:
    
    1.6
  - getSupportedRFIDConvertFormatDescription
```
public static java.lang.String getSupportedRFIDConvertFormatDescription(java.lang.String format)
```
    Provides the RFID tag format description for the given convert format.
    
    Parameters:
    format - The convert format ID like "CONVERT_10HEX"
    
    Returns:
    The description, null otherwise
    Since:
    
    1.6
  - getSupportedBarcodeFormats
```
public static java.lang.String[] getSupportedBarcodeFormats()
```
    Provides the supported barcode data formats (default types).
    
    Returns:
    The formats
    Since:
    
    1.6
  - getSupportedBarcodeFormatDescriptions
```
public static java.lang.String[] getSupportedBarcodeFormatDescriptions()
```
    Provides the supported barcode data format descriptions.
    
    Returns:
    The descriptions
    Since:
    
    1.6
  - getSupportedBarcodeFormatDescription
```
public static java.lang.String getSupportedBarcodeFormatDescription(java.lang.String format)
```
    Provides the barcode data tag format description for the given format.
    
    Parameters:
    format - The tag format ID like "8HEX_STX8CRLFETX"
    
    Returns:
    The description, null otherwise
    Since:
    
    1.6
  - getSupportedBarcodeFormatRegex
```
public static java.lang.String[] getSupportedBarcodeFormatRegex(java.lang.String format)
```
    Provides the preset values (regex and group) for a certain barcode data format.
    
    Parameters:
    format - The tag format ID like "8HEX_STX8CRLFETX"
    
    Returns:
    The regex, index 0=regex, index 1=group, null otherwise
    Since:
    
    1.6
  - getUSBVersionDescription
```
public static java.lang.String getUSBVersionDescription(java.lang.String version)
```
    Provides the display text for the given USB standard.
    
    Parameters:
    version - The USB version 1.0, 2.0 etc.
    
    Returns:
    The text, null if not available
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    Since:
    
    1.6
  - getType
```
public java.lang.String getType()
```
    Provides the type of this device.
    
    Returns:
    The type identifier
    Since:
    
    1.6
  - setDevice
```
public void setDevice(int dvid,
             com.lf.commons.db.DatabaseConnector connector)
```
    Sets the database entry data for this device.
    The DVID is logged into MXDATA/MXRAWDATA only if the battery and device are managed by the same database. Cross database references are not allowed.
    
    Parameters:
    dvid - The database ID for this device, -1 = unknown
    connector - The database connector for this device (DEVICE.DVID)
    Since:
    
    1.6
  - getDeviceID
```
public int getDeviceID()
```
    Provides the ID for this device.
    
    Returns:
    The database ID for this device, -1 = unknown
    Since:
    
    1.6
  - getConnector
```
public com.lf.commons.db.DatabaseConnector getConnector()
```
    Provides the database connector for this device.
    
    Returns:
    The connector, null otherwise
    Since:
    
    1.6
  - createDevice
```
public static AbstractDevice createDevice(java.lang.String type,
                          int dvid,
                          com.lf.commons.db.DatabaseConnector connector)
```
    Creates a new instance of the given device type.
    All device types serial, USB, and custom may be created here by delegation.
    
    Parameters:
    type - The type identifier
    dvid - The database ID for this device, -1 = unknown
    connector - The database connector for this device (DEVICE.DVID)
    
    Returns:
    The device, null if not available
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    Since:
    
    1.6
  - getDeviceIcon
```
public static javax.swing.ImageIcon getDeviceIcon(java.lang.String devclass)
```
    Provides an appropriate icon for the given device class.
    
    Parameters:
    devclass - The device class DEV_BARCODE_READER, ...
    
    Returns:
    The icon, null if not available
    Since:
    
    1.6
  - getDeviceToolTip
```
public static java.lang.String getDeviceToolTip(java.lang.String devclass)
```
    Provides an appropriate tooltip for the given device class.
    
    Parameters:
    devclass - The device class DEV_BARCODE_READER, ...
    
    Returns:
    The tooltip, null if not available
    Since:
    
    1.6
  - getDeviceClass
```
public static java.lang.String getDeviceClass(java.lang.String type)
```
    Provides an appropriate device class for the given device type.
    
    Parameters:
    type - The device type Barcode Reader (RS-232), ...
    
    Returns:
    The device class DEV_BARCODE_READER, null if not available
    Since:
    
    1.6
  - configureUnit
```
public void configureUnit(java.lang.String id,
                 com.lf.commons.config.Configuration config)
```
    Restores values from persistent data stores.
    
    Specified by:
    
    configureUnit in interface com.lf.commons.model.ConfigurableUnit
    
    Parameters:
    id - The unique identifier for the instance
    config - The configuration
    Since:
    
    1.6
  - storeUnit
```
public void storeUnit(java.lang.String id,
             com.lf.commons.config.Configuration config)
```
    Stores the current configuration values persistently.
    
    Specified by:
    
    storeUnit in interface com.lf.commons.model.ConfigurableUnit
    
    Parameters:
    id - The unique identifier for the instance
    config - The configuration
    Since:
    
    1.6
  - unitRegistered
```
public void unitRegistered(com.lf.commons.model.ApplicationModel model,
                  java.lang.String id)
```
    Informs the configurable unit that it was registered with a model.
    
    Specified by:
    
    unitRegistered in interface com.lf.commons.model.ConfigurableUnit
    
    Parameters:
    model - The application model
    id - The unique identifier for the instance
    Since:
    
    1.6
  - unitUnregistered
```
public void unitUnregistered(com.lf.commons.model.ApplicationModel model,
                    java.lang.String id)
```
    Informs the configurable unit that it was unregistered with a model.
    
    Specified by:
    
    unitUnregistered in interface com.lf.commons.model.ConfigurableUnit
    
    Parameters:
    model - The application model
    id - The unique identifier for the instance
    Since:
    
    1.6
  - getParams
```
public abstract java.util.Properties getParams()
```
    Provides the parameters to configure the serial port.
    
    Returns:
    The parameters
    Since:
    
    1.6
  - getParamsConfigurable
```
public abstract boolean getParamsConfigurable()
```
    May the parameters of this device be configured?
    
    Returns:
    Configurable?
    Since:
    
    1.6
  - getDeviceClass
```
public abstract java.lang.String getDeviceClass()
```
    Provides the class type of this device (charger, RFID reader, ...).
    
    Returns:
    The class DEV_CHARGER, ...
    Since:
    
    1.6
  - getOptionsDisplay
```
public abstract java.awt.Component getOptionsDisplay()
```
    Provides the canvas to display additional device options.
    
    Returns:
    The canvas, maybe null
    Since:
    
    1.6
  - getFigureDisplay
```
public abstract java.awt.Component getFigureDisplay()
```
    Provides the canvas to display the device figure.
    
    Returns:
    The canvas, maybe null
    Since:
    
    1.6
  - getLiveDisplay
```
public abstract java.awt.Component getLiveDisplay()
```
    Provides the canvas to display the device live data.
    
    Returns:
    The canvas, maybe null
    Since:
    
    1.6
  - isFunctional
```
public abstract boolean isFunctional()
```
    Checks if this device can be used.
    
    Returns:
    Device OK?
    Since:
    
    1.6
  - updateStatus
```
public abstract void updateStatus()
```
    Called regularly by a separate thread e.g. to update connected status icon.
    
    Since:
    
    1.6

Class AbstractDevice

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEV_CHARGER

DEV_RFID_READER

DEV_POWER

DEV_BARCODE_READER

COMM_INTERFACE

COMM_BAUDRATE

COMM_DATABITS

COMM_STOPBITS

COMM_PARITY

COMM_FLOWCONTROL

RFID_FORMAT_GENERIC_HEX

RFID_FORMAT_GENERIC_DEC

RFID_FORMAT_8HEX_STX8CRLFETX

RFID_FORMAT_10HEX_STX10CRLFETX

RFID_FORMAT_10DEC_STX8ETX

RFID_CONVERT_8HEX

RFID_CONVERT_10HEX

RFID_CONVERT_10DEC

RFID_READER_FORMAT

RFID_READER_REGEX

RFID_READER_REGEX_GROUP

RFID_READER_CONVERT

BARCODE_FORMAT_GENERIC

BARCODE_FORMAT_TEXTCRLF

BARCODE_READER_FORMAT

BARCODE_READER_REGEX

BARCODE_READER_REGEX_GROUP

USB_VERSION

USB_VENDOR_ID

USB_PRODUCT_ID

USB_RELEASE

type

figureURL

dvid

dvConnector

Constructor Detail

AbstractDevice

AbstractDevice

Method Detail

getSupportedBays

getSupportedBays

getSupportedPrograms

getSupportedPrograms

getSupportedStatus

getSupportedStatus

getSupportedInterfaces

getSupportedBaudrates

getSupportedDatabits

getSupportedStopbits

getSupportedStopbitDescriptions

getSupportedStopbitDescription

getSupportedParities

getSupportedParityDescriptions

getSupportedParityDescription

getSupportedFlowControls

getSupportedFlowControlDescriptions

getSupportedFlowControlDescription

getSupportedRFIDFormats

getSupportedRFIDFormatDescriptions

getSupportedRFIDFormatDescription

getSupportedRFIDFormatRegex

getSupportedRFIDConvertFormats

getSupportedRFIDConvertFormatDescriptions

getSupportedRFIDConvertFormatDescription

getSupportedBarcodeFormats

getSupportedBarcodeFormatDescriptions

getSupportedBarcodeFormatDescription

getSupportedBarcodeFormatRegex

getUSBVersionDescription

getType

setDevice

getDeviceID

getConnector

createDevice