Attachment_0009_DoD Active RFID Common Abstraction Interface Developers ....pdf

Overview index.html[2/3/2014 1:10:24 PM]

All Classes

Packages gov.pmjait.cai gov.pmjait.cai.device gov.pmjait.cai.driverRegistra gov.pmjait.cai.query gov.pmjait.cai.tag gov.pmjait.cai.tag.table gov.pmjait.cai.tag.udbEleme

All Classes

ActiveTag ApplicationExtensionBlock ApplicationExtensionElemen ApplicationIDTLDElement ApplicationTLDElement BCScannerEventListener CollectEventListener DatabaseTag Device DeviceConnection DeviceConnectionException DeviceConnectionFactory DeviceException DeviceFactory DriverInfo GPSISO180007Reader GPSLocation HardwareFaultStatusEleme HHISO180007Reader IntegratedSensorStatusElem ISO180007Reader ISO180007SensorTag ISO180007Tag ISO180007TagEvent ISO180007WriteDevice MemorySizeElement OptionalCommandListElem QueryElement QueryElementFactory Reader RFIDDriver RFIDDriverManager

Overview Package Class Use Tree Deprecated Index Help

Prev Next Frames No Frames

Common Abstraction Interface

DOD RFID Common Abstraction Interface

See: Description

DOD RFID Common Abstraction Interface

DOD Active RFID Common Abstraction Interface 05/16/2013

Overview The DOD Active RFID Common Abstraction Interface (CAI) is a well-defined set of software interfaces (written in Java) that standardizes communications between Government developed PC applications (GOTS software) and vendor provided RFID hardware (readers and tags).

The benefits of using the CAI are as follows:

It allows GOTS software developers to write a single application that works with every vendor’s hardware (as long as the minimum required functionality is used).

This includes the existing DOD RFID Active hardware infrastructure.

It defines the minimum required functionality that vendor provided hardware must satisfy.

It provides an extendable framework that does not hinder innovation and allows a vendor to provide additional functionality outside of the minimum requirements.

Assumptions It has been assumed that all of the following are true in order to support the use of the CAI:

All over-air RF communications between non-legacy hardware will be defined by the ISO 18000-7 standard.

For any given PC read / write station, all connected readers shall be from a single vendor.

Communications between a PC and a non-legacy tag will use a standard

Package Description gov.pmjait.cai gov.pmjait.cai.device Device related interfaces and classes.

gov.pmjait.cai.driverRegistration gov.pmjait.cai.query Tag Query related interfaces and classes.

gov.pmjait.cai.tag Tag related interfaces and classes.

gov.pmjait.cai.tag.table Table related interfaces and classes.

gov.pmjait.cai.tag.udbElements

Packages file:///Z|/d3k076/PMJ/AppIntLibrary2/doc/index.html?overview-summary.html

Overview index.html[2/3/2014 1:10:24 PM]

RFIDDriverRegInfo RFIDDriverRegistrationUI RoutingCodeElement SensorDetailDataElement SensorDetailElement SensorSpecificElement SensorStatusBlock SensorStatusElement SensorStatusFlagElement TableQueryResultsElement TableQuerySizeElement Tag TagConnectionListener TagEvent TagException TagFactory TagTableProperties UDBElement UserIDElement WriteDevice

Overview Package Class Use Tree Deprecated Index Help

Prev Next Frames No Frames connection (USB) and a common ISO 18000-7 derived wired protocol.

Responsibilities RFID hardware vendors will be responsible for creating an implementation of the CAI to support their hardware. In addition, they will also be required to provide any configuration utilities needed to customize the operation of their readers (e.g. adjusting transmit power levels).

GOTS software developers will be responsible for writing their applications such that all RFID hardware related operations will be accessed through the CAI (unless a vendor specific function is required).

file:///Z|/d3k076/PMJ/AppIntLibrary2/doc/index.html?overview-summary.html

All Classes allclasses-frame.html[2/3/2014 1:10:26 PM]

All Classes

ActiveTag ApplicationExtensionBlock ApplicationExtensionElement ApplicationIDTLDElement ApplicationTLDElement BCScannerEventListener CollectEventListener DatabaseTag Device DeviceConnection DeviceConnectionException DeviceConnectionFactory DeviceException DeviceFactory DriverInfo GPSISO180007Reader GPSLocation HardwareFaultStatusElement HHISO180007Reader IntegratedSensorStatusElement ISO180007Reader ISO180007SensorTag ISO180007Tag ISO180007TagEvent ISO180007WriteDevice MemorySizeElement OptionalCommandListElement QueryElement QueryElementFactory Reader RFIDDriver RFIDDriverManager RFIDDriverRegInfo RFIDDriverRegistrationUI RoutingCodeElement SensorDetailDataElement SensorDetailElement SensorSpecificElement SensorStatusBlock SensorStatusElement SensorStatusFlagElement TableQueryResultsElement TableQuerySizeElement Tag TagConnectionListener TagEvent TagException TagFactory TagTableProperties UDBElement UserIDElement WriteDevice gov.pmjait.cai package-frame.html[2/3/2014 1:10:27 PM] gov.pmjait.cai

Interfaces

DriverInfo GPSLocation RFIDDriver

Classes

RFIDDriverManager gov.pmjait.cai.device package-frame.html[2/3/2014 1:10:27 PM] gov.pmjait.cai.device

Interfaces

BCScannerEventListener CollectEventListener Device DeviceConnection DeviceConnectionFactory DeviceFactory GPSISO180007Reader HHISO180007Reader ISO180007Reader ISO180007WriteDevice Reader TagConnectionListener WriteDevice

Exceptions

DeviceConnectionException DeviceException gov.pmjait.cai.driverRegistration package-frame.html[2/3/2014 1:10:28 PM] gov.pmjait.cai.driverRegistration

Classes

RFIDDriverRegInfo RFIDDriverRegistrationUI gov.pmjait.cai.query package-frame.html[2/3/2014 1:10:28 PM] gov.pmjait.cai.query

Interfaces

QueryElement QueryElementFactory gov.pmjait.cai.tag package-frame.html[2/3/2014 1:10:29 PM] gov.pmjait.cai.tag

Interfaces

ActiveTag DatabaseTag ISO180007SensorTag ISO180007Tag ISO180007TagEvent Tag TagEvent TagFactory

Exceptions

TagException gov.pmjait.cai.tag.table package-frame.html[2/3/2014 1:10:29 PM] gov.pmjait.cai.tag.table

Interfaces

TagTableProperties gov.pmjait.cai.tag.udbElements package-frame.html[2/3/2014 1:10:30 PM] gov.pmjait.cai.tag.udbElements

Interfaces

ApplicationExtensionBlock ApplicationExtensionElement ApplicationIDTLDElement ApplicationTLDElement HardwareFaultStatusElement IntegratedSensorStatusElement MemorySizeElement OptionalCommandListElement RoutingCodeElement SensorDetailDataElement SensorDetailElement SensorSpecificElement SensorStatusBlock SensorStatusElement SensorStatusFlagElement TableQueryResultsElement TableQuerySizeElement UDBElement UserIDElement

ActiveTag

ActiveTag.html[2/3/2014 1:10:31 PM]

Overview Package Class Use Tree Deprecated Index Help

Prev Class Next Class Frames No Frames All Classes

Summary: Nested | Field | Constr | Method Detail: Field | Constr | Method gov.pmjait.cai.tag

Interface ActiveTag

All Superinterfaces:

Tag

All Known Subinterfaces:

DatabaseTag, ISO180007SensorTag, ISO180007Tag public interface ActiveTag extends Tag

Title: ActiveTag interface

Description: Common Abstraction Interface representation of a generic active tag for PMJ-AIT

Copyright: Copyright (c) 2007

Company: PMJ-AIT

Version: 1.0

Version:

1.0

Field Summary

Modifier and Type Field and Description static int STATUS_ALARM_SET

A constant that represents the alarm bit being set static int STATUS_OK

A constant that represents an ok status static int STATUS_SERVICE_AND_ALARM_SET

A constant the represents the service bit and the alarm bit being set static int STATUS_SERVICE_SET

A constant that represents the service bit being set

Method Summary

Modifier and Type Method and Description void ()

Fields

Methods file:///Z|/d3k076/PMJ/AppIntLibrary2/doc/index.html?gov/pmjait/cai/tag/ActiveTag.html beepOff

The Beep OFF method turns the tag’s beeper off.

void beepOn()

The Beep ON method turns the tag’s beeper on.

void clearMemory()

This method restores all user-writeable memory to factory defaults.

void clearUserID()

This method clears the tag's User ID field (sets its length to zero).

java.lang.String getFirmwareVersion()

This method retrieves a tag’s Firmware Version int getMemorySize()

This method will return the total number of bytes available for Read / Write memory commands java.lang.String getModelNumber()

This method retrieves a tag’s Model Number java.lang.String getRoutingCode()

This method retrieves a tag’s Routing Code int getTagStatus()

This method will return the status of the tag from the last operation.

java.lang.String getUserID()

This method retrieves a tag’s User ID boolean isBatteryLow()

This method returns true if the tag battery is low (Service bit when set (‘1’) indicates that tag battery is low) byte[] readMemory(int startingAddress, int numBytes)

This method will read the specified number of bytes from the tag starting at the memory location specified.

void refreshTagStatus()

This method will refresh the status of the tag from its current state.

void setRoutingCode(java.lang.String routingCode)

This method sets a tag’s Routing Code void setUserID(java.lang.String userID)

This method sets a tag’s User ID void writeMemory(int startingAddress, byte[] data)

This method will write the data passed in to the memory location specified on the tag.

Methods inherited from interface gov.pmjait.cai.tag.Tag getTagID

Field Detail

STATUS_OK

static final int STATUS_OK

A constant that represents an ok status

See Also:

Constant Field Values

STATUS_SERVICE_SET

static final int STATUS_SERVICE_SET

A constant that represents the service bit being set

See Also:

Constant Field Values

STATUS_ALARM_SET

static final int STATUS_ALARM_SET

A constant that represents the alarm bit being set

See Also:

Constant Field Values

STATUS_SERVICE_AND_ALARM_SET

static final int STATUS_SERVICE_AND_ALARM_SET

A constant the represents the service bit and the alarm bit being set

See Also:

Constant Field Values

Method Detail beepOn void beepOn() throws TagException

The Beep ON method turns the tag’s beeper on. When the tag’s beeper is turned on, the beeper stays on until explicitly turned off or when the tag returns to the Sleep mode.

Throws:

TagException beepOff void beepOff() throws TagException

The Beep OFF method turns the tag’s beeper off.

Throws:

getRoutingCode java.lang.String getRoutingCode() throws TagException

This method retrieves a tag’s Routing Code

Returns:

String - The routing code

Throws:

TagException setRoutingCode void setRoutingCode(java.lang.String routingCode) throws TagException

This method sets a tag’s Routing Code

Parameters:

routingCode - String - The routing code to be set on the tag

Throws:

TagException clearMemory void clearMemory() throws TagException

This method restores all user-writeable memory to factory defaults. In particular, the following operations are performed:

• The length of the User ID is reset to zero.

• The value of the Routing Code is reset to the value it was set to previously.

• All database tables are deleted.

Throws:

TagException getFirmwareVersion java.lang.String getFirmwareVersion() throws TagException

This method retrieves a tag’s Firmware Version

Returns:

String - A string containing the firmware version of the tag getModelNumber java.lang.String getModelNumber() throws TagException

This method retrieves a tag’s Model Number

Returns:

String - A string containing the model number of the tag

Throws:

TagException isBatteryLow boolean isBatteryLow() throws TagException

This method returns true if the tag battery is low (Service bit when set (‘1’) indicates that tag battery is low)

Returns:

boolean - True if the battery is low

Throws:

TagException getTagStatus int getTagStatus() throws TagException

This method will return the status of the tag from the last operation. The meaning of the integer value returned is tag version specific

Returns:

int - an integer indicating the status of the tag (one of the STATUS constants defined in this class)

Throws:

TagException refreshTagStatus void refreshTagStatus() throws TagException

This method will refresh the status of the tag from its current state. The meaning of the tag status is tag version specific

Throws:

TagException getUserID java.lang.String getUserID() throws TagException

This method retrieves a tag’s User ID

Returns:

String - The User ID on the tag

Throws:

TagException setUserID void setUserID(java.lang.String userID) throws TagException

This method sets a tag’s User ID

Parameters:

userID - String - The User ID to be set on the tag

Throws:

TagException clearUserID void clearUserID() throws TagException

This method clears the tag's User ID field (sets its length to zero).

Throws:

TagException getMemorySize int getMemorySize()

This method will return the total number of bytes available for Read / Write memory commands

Returns:

int - The number of bytes of available for read / write memory commands writeMemory void writeMemory(int startingAddress, byte[] data) throws TagException

This method will write the data passed in to the memory location specified on the tag. This is an OPTIONAL command and is not required for DoD interoperabilty.

Parameters:

startingAddress - int - The starting address location for where to write the byte data data - byte[] - The data to be written to the tag memory

Overview Package Class Use Tree Deprecated Index Help

Prev Class Next Class Frames No Frames All Classes

Summary: Nested | Field | Constr | Method Detail: Field | Constr | Method readMemory byte[] readMemory(int startingAddress, int numBytes) throws TagException

This method will read the specified number of bytes from the tag starting at the memory location specified. This is an OPTIONAL command and is not required for DoD interoperability.

Parameters:

startingAddress - int - The starting address location for where to read data from numBytes - int - The number of bytes to read

Returns:

byte[] - The data read from the tag

Throws:

file:///Z|/d3k076/PMJ/AppIntLibrary2/doc/index.html?gov/pmjait/cai/tag/ActiveTag.html

ApplicationExtensionBlock

ApplicationExtensionBlock.html[2/3/2014 1:10:32 PM]

Overview Package Class Use Tree Deprecated Index Help

Prev Class Next Class Frames No Frames All Classes

Summary: Nested | Field | Constr | Method Detail: Field | Constr | Method gov.pmjait.cai.tag.udbElements

Interface ApplicationExtensionBlock

All Superinterfaces:

UDBElement

All Known Subinterfaces:

SensorStatusBlock public interface ApplicationExtensionBlock extends UDBElement

Title: ApplicationExtensionBlock Interface

Description: Common Abstraction Interface representation of a UDB Application Extension Block

Copyright: Copyright (c) 2007

Company: PMJ-AIT

Version:

1.0

Field Summary

Fields inherited from interface gov.pmjait.cai.tag.udbElements.UDBElement ELEMENT_APPLICATION_EXTENSION_BLOCK, ELEMENT_APPLICATION_EXTENSIONS, ELEMENT_ASSET_ID, ELEMENT_HARDWARE_FAULT_STATUS, ELEMENT_MEMORY_SIZE, ELEMENT_OPTIONAL_COMMAND_LIST, ELEMENT_ROUTING_CODE, ELEMENT_SENSOR_STATUS, ELEMENT_TABLE_QUERY_RESULTS, ELEMENT_TABLE_QUERY_SIZE, ELEMENT_USER_ID

Method Summary

Modifier and Type Method and Description

ApplicationIDTLDElement getAppIDTLDElement()

This method will return the Application ID TLD Element for the UDB Application Extention Block

ApplicationTLDElement getAppTLDElement(int appTLDElementNum)

This method will return an ApplicationTLDElement object that represents the application TLD element at the index passed in appTLDElementNum int getAppTLDElementCount()

This method returns the count of Application TLD Elements contained within this UDB Application Extension Block file:///Z|/d3k076/PMJ/AppIntLibrary2/doc/index.html?gov/pmjait/cai/tag/udbElements/ApplicationExtensionBlock.html java.util.List getAppTLDElements()

This method will return a list of all the Application TLD Elements contained within this UDB Application Extension Block

Methods inherited from interface gov.pmjait.cai.tag.udbElements.UDBElement getData, getLength, getType

Method Detail getAppIDTLDElement

ApplicationIDTLDElement getAppIDTLDElement()

This method will return the Application ID TLD Element for the UDB Application Extention Block

Returns:

ApplicationTLDElement - The Application ID TLD Element for this UDB Application Extension Block getAppTLDElementCount int getAppTLDElementCount()

This method returns the count of Application TLD Elements contained within this UDB Application Extension Block

Returns:

int - The count of hte Application TLD Elements contains within this UDB Application Extension Block getAppTLDElements java.util.List getAppTLDElements()

This method will return a list of all the Application TLD Elements contained within this UDB Application Extension Block

Returns:

List - A list of ApplicationTLDElements getAppTLDElement

ApplicationTLDElement getAppTLDElement(int appTLDElementNum)

This method will return an ApplicationTLDElement object that represents the application TLD element at the index passed in appTLDElementNum

Parameters:

appTLDElementNum - int - the indes of the application TLD element to retreive

Returns:

ApplicationTLDElement - an ApplicationTLDElement object

Overview Package Class Use Tree Deprecated Index Help

Prev Class Next Class Frames No Frames All Classes

Summary: Nested | Field | Constr | Method Detail: Field | Constr | Method file:///Z|/d3k076/PMJ/AppIntLibrary2/doc/index.html?gov/pmjait/cai/tag/udbElements/ApplicationExtensionBlock.html

ApplicationExtensionElement

ApplicationExtensionElement.html[2/3/2014 1:10:33 PM]

Overview Package Class Use Tree Deprecated Index Help

Prev Class Next Class Frames No Frames All Classes

Summary: Nested | Field | Constr | Method Detail: Field | Constr | Method gov.pmjait.cai.tag.udbElements

Interface ApplicationExtensionElement

All Superinterfaces:

UDBElement public interface ApplicationExtensionElement extends UDBElement

Title: ApplicationExtensionElement Interface

Description: Common Abstraction Interface definition of an Application Extension UDB Element

Copyright: Copyright (c) 2007

Company: PMJ-AIT

Version:

1.0

Field Summary

Fields inherited from interface gov.pmjait.cai.tag.udbElements.UDBElement ELEMENT_APPLICATION_EXTENSION_BLOCK, ELEMENT_APPLICATION_EXTENSIONS, ELEMENT_ASSET_ID, ELEMENT_HARDWARE_FAULT_STATUS, ELEMENT_MEMORY_SIZE, ELEMENT_OPTIONAL_COMMAND_LIST, ELEMENT_ROUTING_CODE, ELEMENT_SENSOR_STATUS, ELEMENT_TABLE_QUERY_RESULTS, ELEMENT_TABLE_QUERY_SIZE, ELEMENT_USER_ID

Method Summary

Modifier and Type Method and Description

ApplicationExtensionBlock getAppExtensionBlock(int blockNumber)

This method will return an ApplicationExtensionBlock object that represents the application extension block at the index passed in blockNumber int getAppExtensionBlockCount()

This method will return a count of the number of application extension blocks within this application extension element java.util.List getAppExtensionBlocks()

This method will return a list of the application extension blocks contained within the application extension element

Methods inherited from interface gov.pmjait.cai.tag.udbElements.UDBElement file:///Z|/d3k076/PMJ/AppIntLibrary2/doc/index.html?gov/pmjait/cai/tag/udbElements/ApplicationExtensionElement.html

ApplicationExtensionElement

ApplicationExtensionElement.html[2/3/2014 1:10:33 PM]

Overview Package Class Use Tree Deprecated Index Help

Prev Class Next Class Frames No Frames All Classes

Summary: Nested | Field | Constr | Method Detail: Field | Constr | Method getData, getLength, getType

Method Detail getAppExtensionBlocks java.util.List getAppExtensionBlocks()

This method will return a list of the application extension blocks contained within the application extension element

Returns:

List - A list of the application extension blocks contained within this application element (list element type is ApplicationExtensionBlock) getAppExtensionBlockCount int getAppExtensionBlockCount()

This method will return a count of the number of application extension blocks within this application extension element

Returns:

int - A count of the number of application extension blocks contained within this application extension element getAppExtensionBlock

ApplicationExtensionBlock getAppExtensionBlock(int blockNumber)

This method will return an ApplicationExtensionBlock object that represents the application extension block at the index passed in blockNumber

Parameters:

blockNumber - int - The index of the application extension block to be returned

Returns:

ApplicationExtensionBlock - The application extension block object at index blockNumber file:///Z|/d3k076/PMJ/AppIntLibrary2/doc/index.html?gov/pmjait/cai/tag/udbElements/ApplicationExtensionElement.html

ApplicationIDTLDElement

ApplicationIDTLDElement.html[2/3/2014 1:10:33 PM]

Overview Package Class Use Tree Deprecated Index Help

Prev Class Next Class Frames No Frames All Classes

Summary: Nested | Field | Constr | Method Detail: Field | Constr | Method

Overview Package Class Use Tree Deprecated Index Help

Prev Class Next Class Frames No Frames All Classes

Summary: Nested | Field | Constr | Method Detail: Field | Constr | Method gov.pmjait.cai.tag.udbElements

Interface ApplicationIDTLDElement

All Superinterfaces:

UDBElement public interface ApplicationIDTLDElement extends UDBElement

Title: ApplicationIDTLDElement Interface

Description: Common Abstraction Interface representation of an Application ID TLD Element. This element will be made up of an Application ID, a one-byte lengthe field, and a data field containing the Application ID value for the entity responsible for defining the following Application defined TLD (Type, Length, Data) elements

Copyright: Copyright (c) 2007

Company: PMJ-AIT

Version:

1.0

Field Summary

Fields inherited from interface gov.pmjait.cai.tag.udbElements.UDBElement ELEMENT_APPLICATION_EXTENSION_BLOCK, ELEMENT_APPLICATION_EXTENSIONS, ELEMENT_ASSET_ID, ELEMENT_HARDWARE_FAULT_STATUS, ELEMENT_MEMORY_SIZE, ELEMENT_OPTIONAL_COMMAND_LIST, ELEMENT_ROUTING_CODE, ELEMENT_SENSOR_STATUS, ELEMENT_TABLE_QUERY_RESULTS, ELEMENT_TABLE_QUERY_SIZE, ELEMENT_USER_ID

Method Summary

Methods inherited from interface gov.pmjait.cai.tag.udbElements.UDBElement getData, getLength, getType file:///Z|/d3k076/PMJ/AppIntLibrary2/doc/index.html?gov/pmjait/cai/tag/udbElements/ApplicationIDTLDElement.html file:///Z|/d3k076/PMJ/AppIntLibrary2/doc/index.html?gov/pmjait/cai/tag/udbElements/ApplicationIDTLDElement.html

ApplicationTLDElement

ApplicationTLDElement.html[2/3/2014 1:10:34 PM]

Overview Package Class Use Tree Deprecated Index Help

Prev Class Next Class Frames No Frames All Classes

Summary: Nested | Field | Constr | Method Detail: Field | Constr | Method

Overview Package Class Use Tree Deprecated Index Help

Prev Class Next Class Frames No Frames All Classes gov.pmjait.cai.tag.udbElements

Interface ApplicationTLDElement

All Superinterfaces:

UDBElement

All Known Subinterfaces:

IntegratedSensorStatusElement, SensorDetailElement, SensorSpecificElement public interface ApplicationTLDElement extends UDBElement

Title: ApplicationTLDElement Interface

Description: Common Abstraction Interface representation of an Application TLD Element. A TLD is a Type, Length, Data element and is made up a 1 byte type ID, followed by a 1 byte length (length of the data), followed by the data.

Copyright: Copyright (c) 2007

Company: PMJ-AIT

Version:

1.0

Field Summary

Fields inherited from interface gov.pmjait.cai.tag.udbElements.UDBElement ELEMENT_APPLICATION_EXTENSION_BLOCK, ELEMENT_APPLICATION_EXTENSIONS, ELEMENT_ASSET_ID, ELEMENT_HARDWARE_FAULT_STATUS, ELEMENT_MEMORY_SIZE, ELEMENT_OPTIONAL_COMMAND_LIST, ELEMENT_ROUTING_CODE, ELEMENT_SENSOR_STATUS, ELEMENT_TABLE_QUERY_RESULTS, ELEMENT_TABLE_QUERY_SIZE, ELEMENT_USER_ID

Method Summary

Methods inherited from interface gov.pmjait.cai.tag.udbElements.UDBElement getData, getLength, getType file:///Z|/d3k076/PMJ/AppIntLibrary2/doc/index.html?gov/pmjait/cai/tag/udbElements/ApplicationTLDElement.html file:///Z|/d3k076/PMJ/AppIntLibrary2/doc/index.html?gov/pmjait/cai/tag/udbElements/ApplicationTLDElement.html

ApplicationTLDElement

ApplicationTLDElement.html[2/3/2014 1:10:34 PM]

BCScannerEventListener

BCScannerEventListener.html[2/3/2014 1:10:35 PM]

Overview Package Class Use Tree Deprecated Index Help

Prev Class Next Class Frames No Frames All Classes

Summary: Nested | Field | Constr | Method Detail: Field | Constr | Method

Overview Package Use Tree Deprecated Index Help gov.pmjait.cai.device

Interface BCScannerEventListener public interface BCScannerEventListener

Title: BCScannerEventListener Interface

Description: ISO-18000-7 Common Abstraction Interface representation of an interface to be implemented by classes which are interested in being notified when a barcode scanner event takes place

Copyright: Copyright (c) 2007

Company: PMJ-AIT

Version: 1.0

Version:

1.0

Method Summary

Modifier and Type Method and Description void barcodeEventReceived(java.lang.String data)

This method must be implemented by a class who will register to be notified when barcode scanner events take place.

Method Detail barcodeEventReceived void barcodeEventReceived(java.lang.String data)

This method must be implemented by a class who will register to be notified when barcode scanner events take place. The parameter a data is a string that holds the barcode data that was collected.

Parameters:

data - String - Represents the barcode data that was collected file:///Z|/d3k076/PMJ/AppIntLibrary2/doc/index.html?gov/pmjait/cai/device/BCScannerEventListener.html

BCScannerEventListener

BCScannerEventListener.html[2/3/2014 1:10:35 PM]

Class

Prev Class Next Class Frames No Frames All Classes file:///Z|/d3k076/PMJ/AppIntLibrary2/doc/index.html?gov/pmjait/cai/device/BCScannerEventListener.html

CollectEventListener

CollectEventListener.html[2/3/2014 1:10:36 PM]

Overview Package Class Use Tree Deprecated Index Help

Prev Class Next Class Frames No Frames All Classes

Summary: Nested | Field | Constr | Method Detail: Field | Constr | Method gov.pmjait.cai.device

Interface CollectEventListener public interface CollectEventListener

Title: CollectEventListener Interface

Description: ISO-18000-7 Common Abstraction Interface representation of an interface to be implemented by classes which are interested in being notified when an asynchronous collection is finished

Copyright: Copyright (c) 2007

Company: PMJ-AIT

Version: 1.0

Version:

1.0

Method Summary

Modifier and Type Method and Description void collectionCompleted(boolean terminated)

This method must be implemented by a class who will register to be notified when an asynchronous collection has been completed.

void tagEventReceived(TagEvent tagEvent)

This method must be implemented by a class who will register to be notified when tag events are received during an asynchronous collection.

Method Detail tagEventReceived void tagEventReceived(TagEvent tagEvent)

This method must be implemented by a class who will register to be notified when tag events are received during an asynchronous collection. The parameter a TagEvent object that represents the tag event that was collected.

Parameters:

tagEvent - TagEvent - Represents the tag event that took place during collection collectionCompleted file:///Z|/d3k076/PMJ/AppIntLibrary2/doc/index.html?gov/pmjait/cai/device/CollectEventListener.html

CollectEventListener

CollectEventListener.html[2/3/2014 1:10:36 PM]

Overview Package Class Use Tree Deprecated Index Help

Prev Class Next Class Frames No Frames All Classes

Summary: Nested | Field | Constr | Method Detail: Field | Constr | Method void collectionCompleted(boolean terminated)

This method must be implemented by a class who will register to be notified when an asynchronous collection has been completed.

The parameter is a boolean value that indicates whether the collection was stopped prematurely (by the user).

Parameters:

terminated - boolean - If true the collection was stopped prematurely by the user file:///Z|/d3k076/PMJ/AppIntLibrary2/doc/index.html?gov/pmjait/cai/device/CollectEventListener.html

DatabaseTag

DatabaseTag.html[2/3/2014 1:10:36 PM]

Overview Package Class Use Tree Deprecated Index Help

Prev Class Next Class Frames No Frames All Classes

Summary: Nested | Field | Constr | Method Detail: Field | Constr | Method gov.pmjait.cai.tag

Interface DatabaseTag

All Superinterfaces:

ActiveTag, Tag

All Known Subinterfaces:

ISO180007SensorTag, ISO180007Tag public interface DatabaseTag extends ActiveTag

Title: DatabaseTag interface

Description: Common Abstraction Interface representation of a database capable tag for PMJ-AIT

Copyright: Copyright (c) 2007

Company: PMJ-AIT

Version: 1.0

Version:

1.0

Field Summary

Fields inherited from interface gov.pmjait.cai.tag.ActiveTag

STATUS_ALARM_SET, STATUS_OK, STATUS_SERVICE_AND_ALARM_SET, STATUS_SERVICE_SET

Method Summary

Modifier and Type Method and Description void addRecords(int tableID, int numRecords, byte[] recordData)

This method adds records to the database table specified.

void createTable(int tableID, int maxRecords, int[] fieldSizes)

This method creates a database table consisting of the specified number of fields each having the specified length.

void deleteRecord(int tableID, int recordNum)

This method instructs the tag to delete a single record from the Table.

TagTableProperties getTableProperties(int tableID) file:///Z|/d3k076/PMJ/AppIntLibrary2/doc/index.html?gov/pmjait/cai/tag/DatabaseTag.html

The Table Get Properties method retrieves information about the specified table, namely, the number of used records in the table and the capacity of the table.

byte[] readFields(int tableID, int recordNum, int startingFieldNum, int numBytes) This method will read the specified fields from a record in a database table byte[] readRecords(int tableID, int startingRecordNum, int numBytes)

This method will read records staring from the starting record index from the specified database table int[] tableQuery(int tableID, java.util.List queryElements)

This method queries the specifed table using the query elements provided and returns a list of record indexes that satisified the matching criteria (point-to-point version) void updateFields(int tableID, int recordNum, int startingFieldNum, int numFields, byte[] fieldData) This method updates the fields in the specified table and row, starting with the field at the starting field index specified.

void updateRecords(int tableID, int startingRecordNum, int numRecords, byte[] recordData) This method updates records in the specified database table, starting with the the record at the starting row specified.

Methods inherited from interface gov.pmjait.cai.tag.ActiveTag beepOff, beepOn, clearMemory, clearUserID, getFirmwareVersion, getMemorySize, getModelNumber, getRoutingCode, getTagStatus, getUserID, isBatteryLow, readMemory, refreshTagStatus, setRoutingCode, setUserID, writeMemory

Methods inherited from interface gov.pmjait.cai.tag.Tag getTagID

Method Detail createTable void createTable(int tableID, int maxRecords, int[] fieldSizes) throws TagException

This method creates a database table consisting of the specified number of fields each having the specified length. Initially after creation, the table has no records.

Parameters:

tableID - int - The integer identifier for the new table--the valid range is 0X0001 to 0XFFFF. Table ID 0x0000 is reserved for Table Query results maxRecords - int - The maximum number of records fieldSizes - int[] - An array of field sizes (one for each field)--the length of a field shall lie within the range 1 to 255 inclusive

Throws:

TagException addRecords void addRecords(int tableID, int numRecords, byte[] recordData) throws TagException

This method adds records to the database table specified. It is assumed that caller of this method knows the structure of the table (number and sizes of fields) ahead of time

Parameters:

tableID - int - The pre-assigned identifier value for the table numRecords - int - The total number of records to add to the table recordData - byte[] - A byte array that contains the data for the new records to be added. It is assumed that the byte array is formatted to match the structure of the table that the records are to be added to (proper field and record sizes)

Throws:

TagException updateRecords void updateRecords(int tableID, int startingRecordNum, int numRecords, byte[] recordData) throws TagException

This method updates records in the specified database table, starting with the the record at the starting row specified. It is assumed that the caller of this method knows the structure of the table (number and size of fields) ahead of time

Parameters:

tableID - int - The pre-assigned identifier value for the table startingRecordNum - int - The first record to begin updating. The valid range is 0 up to the number of records in the table - 1 numRecords - int - The total number of records that will be updated. The valid range is 1 up to the number of records in the table

- startingRecordNum recordData - byte[] - A byte array that contains the data for the records to be updated. It is assumed that the byte array is formatted to match the structure of the table that records are to be updated in (proper field and record sizes)

Throws:

TagException updateFields void updateFields(int tableID, int recordNum, int startingFieldNum, int numFields, byte[] fieldData) throws TagException

This method updates the fields in the specified table and row, starting with the field at the starting field index specified. It is assumed that the caller of this method knows the structure of the table (number and size of fields) ahead of time

Parameters:

tableID - int - The pre-assigned identifier value for the table recordNum - int - The record to be updated. The valid range is 0 up to the number of records in the table - 1 startingFieldNum - int - The first field to begin updating. The valid range is from 0 up to the number of fields in the table - 1 numFields - int - The total number of fields in the specified record that will be updated. The valid range is 1 up to the number of fields in the table - startingFieldNum fieldData - byte[] - A byte array that contains the data for the fields to be updated with. It is assumed that the byte array is formatted to match the structure of the table that the records are to be added to (proper field and record sizes)

Throws:

TagException deleteRecord void deleteRecord(int tableID, int recordNum) throws TagException

This method instructs the tag to delete a single record from the Table. When the record is deleted from the database all records below the deleted one will be shifted upwards by one record size.

Parameters:

tableID - int - The pre-assigned identifier value for the table recordNum - int - The record to be deleted. The valid range is 0 up to the number of records in the table - 1

Throws:

TagException readRecords byte[] readRecords(int tableID, int startingRecordNum, int numBytes) throws TagException

This method will read records staring from the starting record index from the specified database table

Parameters:

tableID - int - The pre-assigned identifier value for the table startingRecordNum - int - The first record to begin updating. The valid range is 0 up to the number of records in the table - 1 numBytes - int - The total number of bytes to read from the table

Returns:

byte[] - A byte array that contains the data that was read from the records. It is assumed that the caller of this method will know how to break the byte array up into records and fields, based on prior knowledge of the table structure

Throws:

TagException readFields byte[] readFields(int tableID, int recordNum, int startingFieldNum, int numBytes) throws TagException

This method will read the specified fields from a record in a database table

Parameters:

tableID - int - The pre-assigned identifier value for the table recordNum - int - The record to be read. The valid range is 0 up to the number of records in the table - 1 startingFieldNum - int - The first field to begin reading from. The valid range is from 0 up to the number of fields in the table -numBytes - int - The total number of bytes in the specified record that will be updated. The valid range is 1 up to the number of fields in the table - startingFieldNum

Returns:

byte[] - A byte array that contains the data that was read from the fields. It is assumed that the caller of this method will know how to break the byte array up into fields, based on prior knowledge of the table structure

Throws:

TagException getTableProperties

TagTableProperties getTableProperties(int tableID) throws TagException

The Table Get Properties method retrieves information about the specified table, namely, the number of used records in the table and the capacity of the table.

Parameters:

tableID - int - The pre-assigned identifier value for the table

Returns:

TagTableProperties - An object that contains the table properties

Throws:

TagException tableQuery int[] tableQuery(int tableID, java.util.List queryElements) throws TagException

This method queries the specifed table using the query elements provided and returns a list of record indexes that satisified the matching criteria (point-to-point version)

Parameters:

tableID - int - The pre-assigned identifier value for the table queryElements - List - A list of QueryElement objects that defines the filter characteristics of the query

Returns:

int[] - A list of record indexes that satisified the filter characteristics of the query. It will be null if no matches are found

Overview Package Class Use Tree Deprecated Index Help

Prev Class Next Class Frames No Frames All Classes file:///Z|/d3k076/PMJ/AppIntLibrary2/doc/index.html?gov/pmjait/cai/tag/DatabaseTag.html

Device

Device.html[2/3/2014 1:10:38 PM]

Overview Package Class Use Tree Deprecated Index Help

Prev Class Next Class Frames No Frames All Classes

Summary: Nested | Field | Constr | Method Detail: Field | Constr | Method gov.pmjait.cai.device

Interface Device

All Known Subinterfaces:

GPSISO180007Reader, HHISO180007Reader, ISO180007Reader, ISO180007WriteDevice, Reader, WriteDevice public interface Device

Title: Device interface

Description: Common Abstraction Interface representation of a device that allows a PC to communicate with an tag for PMJ-AIT

Copyright: Copyright (c) 2007

Company: PMJ-AIT

Version: 1.0

Version:

1.0

Field Summary

Modifier and Type Field and Description static java.lang.String DEVICE_TYPE_READER

Type for reader devices static java.lang.String DEVICE_TYPE_WRITE_STATION

Type for write station devices (includes direct connect cables)

Method Summary

Modifier and Type Method and Description void clearInternalBuffer()

This method clears the internal memory of the device and any persistent data held within the device driver.

java.lang.String getDescription()

This method returns a string that contains information about the device (i.e.

DeviceConnection getDeviceConnection()

This method returns an object that represents the physical connection on which this devices resides

Fields file:///Z|/d3k076/PMJ/AppIntLibrary2/doc/index.html?gov/pmjait/cai/device/Device.html java.lang.String getDeviceType()

This method will return the type of the device.

RFIDDriver getDriver()

This method will return the RFIDDriver that generated the device java.lang.String getFirmwareVersion()

This method returns a string that contains the version of the firmware that is currently loaded in the device java.lang.String getID()

This method returns the unique identifier for the device.

java.lang.String getStatus()

This method will return the status of the device, which is a vendor defined value.

void reset()

This method resets the device

Field Detail

DEVICE_TYPE_READER

static final java.lang.String DEVICE_TYPE_READER

Type for reader devices

See Also:

Constant Field Values

DEVICE_TYPE_WRITE_STATION

static final java.lang.String DEVICE_TYPE_WRITE_STATION

Type for write station devices (includes direct connect cables)

See Also:

Constant Field Values

Method Detail reset void reset() throws DeviceException

This method resets the device

Throws:

getDeviceConnection

DeviceConnection getDeviceConnection()

This method returns an object that represents the physical connection on which this devices resides

Returns:

DeviceConnection getID java.lang.String getID() throws DeviceException

This method returns the unique identifier for the device. For an active device (an interrogator) the returned value will be a 48-bit value that consists of a 16-bit manufacturer ID (defined by ISO 18000-7 Section 6.2.6.3) followed by a 32-bit serial number that is vendor assigned. For an inactive device (a docking station or write cable) the returned value will be the MAC address in hexidecimal of the first network card on the host computer prefixed with a "T" (NOTE--because of the way the ID is set for a inactive device, only one may be connected to a given system at a time)

Returns:

String - A string representing the ID of the connected device

Throws:

DeviceException getFirmwareVersion java.lang.String getFirmwareVersion() throws DeviceException

This method returns a string that contains the version of the firmware that is currently loaded in the device

Returns:

String - A string containing the firmware version--formatting is vendor specific

Throws:

DeviceException getDescription java.lang.String getDescription() throws DeviceException

This method returns a string that contains information about the device (i.e. manufacturer, model, etc.)

Returns:

String - A string containing descriptive information about the device

Throws:

DeviceException getDeviceType java.lang.String getDeviceType() throws DeviceException

Overview Package Class Use Tree Deprecated Index Help

Prev Class Next Class Frames No Frames All Classes

Summary: Nested | Field | Constr | Method Detail: Field | Constr | Method

This method will return the type of the device. The return value can be either Device.DEVICE_TYPE_READER or Device.DEVICE_TYPE_WRITE_STATION

Returns:

String - A string that represents the type of this device (either) DEVICE_TYPE_READER or DEVICE_TYPE_WRITE_STATION

Throws:

DeviceException getStatus java.lang.String getStatus() throws DeviceException

This method will return the status of the device, which is a vendor defined value.

Returns:

String - A vendor defined string value that represents the status of the device

Throws:

DeviceException clearInternalBuffer void clearInternalBuffer() throws DeviceException

This method clears the internal memory of the device and any persistent data held within the device driver.

Throws:

DeviceException getDriver

RFIDDriver getDriver()

This method will return the RFIDDriver that generated the device

Returns:

RFIDDriver file:///Z|/d3k076/PMJ/AppIntLibrary2/doc/index.html?gov/pmjait/cai/device/Device.html

DeviceConnection

DeviceConnection.html[2/3/2014 1:10:39 PM]

Overview Package Class Use Tree Deprecated Index Help

Prev Class Next Class Frames No Frames All Classes

Summary: Nested | Field | Constr | Method Detail: Field | Constr | Method gov.pmjait.cai.device

Interface DeviceConnection public interface DeviceConnection

Title: DeviceConnection Class

Description: Object to establish connections to RFID readers and tags

Copyright: Copyright (c) 2007

Company: PMJ-AIT

Version: 1.0

Version:

1.0

Field Summary

Modifier and Type Field and Description static java.lang.String STATE_DISABLED

A constant to indicate that the physical connection is currently disabled static java.lang.String STATE_OFFLINE

A constant to indicate that the physical connection is currently offline static java.lang.String STATE_ONLINE

A constant to indicate that the physical connection is currently online

Method Summary

Modifier and Type Method and Description void closeConnection()

This method will gracefully close the device connection so that it can be used by other programs (i.e.

java.util.Collection discoverDevices()

This method will discover all the devices present on this connection and register them.

java.lang.String getConnectionType()

This method returns the type of connection, which is defined in DeviceConnectionFactory java.lang.String getDescription()

This method will return a String containing the device connection information (i.e.

Fields file:///Z|/d3k076/PMJ/AppIntLibrary2/doc/index.html?gov/pmjait/cai/device/DeviceConnection.html java.util.Collection getRegisteredDevciesByJavaClass(java.lang.Class deviceClass)

This method returns all registered devices that are of a specific java class

Device getRegisteredDeviceByID(java.lang.String deviceID)

This method returns the registered device that has the device id passed in java.util.Collection getRegisteredDevices()

This method returns a collection of all registered devices on this collection java.lang.String getRunningState()

This method will return a string that represents the current running state of the physcial device connection.

void openConnection()

This method will open the device connection (i.e.

void registerDevice(Device device)

This method registers a device on this connection void unregisterDevice(Device device)

This method unregisters a device on this connection

Field Detail

STATE_DISABLED

static final java.lang.String STATE_DISABLED

A constant to indicate that the physical connection is currently disabled

See Also:

Constant Field Values

STATE_OFFLINE

static final java.lang.String STATE_OFFLINE

A constant to indicate that the physical connection is currently offline

See Also:

Constant Field Values

STATE_ONLINE

static final java.lang.String STATE_ONLINE

A constant to indicate that the physical connection is currently online

See Also:

Method Detail getConnectionType java.lang.String getConnectionType()

This method returns the type of connection, which is defined in DeviceConnectionFactory

Returns:

String - The value will be one of the CONNECTION_TYPE constants defined in the DeviceConnectionFactory interface registerDevice void registerDevice(Device device) throws DeviceConnectionException

This method registers a device on this connection

Parameters:

device - Device - The device to be registered with this DeviceConnection

Throws:

DeviceConnectionException unregisterDevice void unregisterDevice(Device device) throws DeviceConnectionException

This method unregisters a device on this connection

Parameters:

device - Device - The device to be unregistered from this DeviceConnection

Throws:

DeviceConnectionException getRegisteredDevices java.util.Collection getRegisteredDevices() throws DeviceConnectionException

This method returns a collection of all registered devices on this collection

Returns:

Collection - A collection of Device objects. If no registered devices exists then an empty collection should be returned.

Throws:

DeviceConnectionException getRegisteredDevciesByJavaClass java.util.Collection getRegisteredDevciesByJavaClass(java.lang.Class deviceClass) throws DeviceConnectionException

This method returns all registered devices that are of a specific java class

Parameters:

deviceClass - Class - The java class of devices that are to be returned

Returns:

Collection - A collection of Device objects. If no matching registered devices exist then an empty collection should be returned.

Throws:

DeviceConnectionException getRegisteredDeviceByID

Device getRegisteredDeviceByID(java.lang.String deviceID) throws DeviceConnectionException

This method returns the registered device that has the device id passed in

Parameters:

deviceID - String - A string that contains the ID of the device to be returned

Returns:

Device - A device that has the ID requested. The return will be null if a device with the requested ID is not found

Throws:

DeviceConnectionException discoverDevices java.util.Collection discoverDevices() throws DeviceConnectionException

This method will discover all the devices present on this connection and register them. The return value is a collection of devices

Returns:

Collection - A collection of Device objects. If no devices are discovered then an empty collection should be returned.

Throws:

DeviceConnectionException getDescription java.lang.String getDescription()

This method will return a String containing the device connection information (i.e. type, COM port, timeout setting, etc.)

Returns:

String - A string that describes the physical device connection getRunningState java.lang.String getRunningState()

This method will return a string that represents the current running state of the physcial device connection.

Overview Package Class Use Tree Deprecated Index Help

Prev Class Next Class Frames No Frames All Classes

Summary: Nested | Field | Constr | Method Detail: Field | Constr | Method

Returns:

String - This string will be either DeviceConnection.STATE_DISABLED, DeviceConnection.STATE_OFFLINE, or DeviceConnection.STATE_ONLINE closeConnection void closeConnection() throws DeviceConnectionException

This method will gracefully close the device connection so that it can be used by other programs (i.e. close the COM port and allow it to be used by other programs)

Throws:

DeviceConnectionException openConnection void openConnection() throws DeviceConnectionException

This method will open the device connection (i.e. initialize and open the COM port so that is owned by this application)

Throws:

file:///Z|/d3k076/PMJ/AppIntLibrary2/doc/index.html?gov/pmjait/cai/device/DeviceConnection.html

DeviceConnectionException.html[2/3/2014 1:10:40 PM]

Overview Package Class Use Tree Deprecated Index Help

Prev Class Next Class Frames No Frames All Classes

Summary: Nested | Field | Constr | Method Detail: Field | Constr | Method gov.pmjait.cai.device

Class DeviceConnectionException java.lang.Object java.lang.Throwable java.lang.Exception gov.pmjait.cai.device.DeviceConnectionException

All Implemented Interfaces:

java.io.Serializable public class DeviceConnectionException extends java.lang.Exception

Title: DeviceConnectionException class

Description: ISO-18000-7 Common Abstraction Interface representation for a Device Connection Exception object

Copyright: Copyright (c) 2007

Company: PMJ-AIT

Version: 1.0

Version:

1.0

See Also:

Serialized Form

Field Summary

Modifier and Type Field and Description static java.lang.String ERROR_CODE_DEVICE_COMMUNICATION_ERROR

A constant to define the error code returned when an error occurs when communicating with a device on this connection static java.lang.String ERROR_CODE_DEVICE_NOT_FOUND

A constant to define the error code returned when a requested device is not found on the device connection static java.lang.String ERROR_CODE_NO_CONNECTION_EXISTS

A constant to define the error code returned when the physical connection (e.g.

Constructor Summary

Fields file:///Z|/d3k076/PMJ/AppIntLibrary2/doc/index.html?gov/pmjait/cai/device/DeviceConnectionException.html

Constructor and Description

DeviceConnectionException()

The default constructor

DeviceConnectionException(java.lang.String errCd, java.lang.String subCd, java.lang.String errMsg, java.lang.Error baseErr) A constructor that contains all the fields

Method Summary

Modifi…