READERNAME CommandFormatter.java - Revision history

Matt: Reverted edits by Amesycyxa (Talk); changed back to last version by Jmaine

2010-11-26T19:39:56Z

Reverted edits by Amesycyxa (Talk); changed back to last version by Jmaine

Amesycyxa at 10:14, 24 November 2010

2010-11-24T10:14:09Z

Jmaine: /* decode */

2008-11-22T23:22:53Z

‎decode

Jmaine: /* Return Value */

2008-04-17T19:50:48Z

‎Return Value

Jmaine: /* decode */

2008-04-17T19:43:21Z

‎decode

Kyle at 00:34, 12 February 2008

2008-02-12T00:34:11Z

Kyle at 22:07, 8 February 2008

2008-02-08T22:07:44Z

Kyle: New page: This class should implement CommandHandler. This page goes through each of the four methods in CommandHandler and describes in detail what each one does and how it should be implemented. ...

2008-02-08T21:15:16Z

New page: This class should implement CommandHandler. This page goes through each of the four methods in CommandHandler and describes in detail what each one does and how it should be implemented. ...

New page

This class should implement CommandHandler. This page goes through each of the four methods in CommandHandler and describes in detail what each one does and how it should be implemented. The first two methods are important, and the last two methods are not as important.

=decode=

This method needs to decode an incoming command into a command to be handled in the command formatter. It should put the command into a commandObject and put the commandObject in the first slot in an arraylist and return the arraylist.

<pre>public ArrayList<Object> decode(byte[] arg);</pre>

==Arguments==
#arg - The incoming command

==Return Value==
An array of objects where the first object is a command in the correct format to be processed by the command handler

==Reference Implementation==
This is the decode method in the alien reader
<pre>
public ArrayList<Object> decode(byte[] arg) {
if (arg.length == 0) {
ArrayList<Object> argArray = new ArrayList<Object>();
argArray.add("");
console = false;
return argArray;
}
String newString = new String(arg);

logger.debug("Formatter arg: " + newString);

ArrayList<Object> retVal = this.parseCommand(newString);

return retVal;
}
</pre>

=encode=
After a command has been processed by the command handler, the response it returns must be formatted to be sent back out to the client. This command handles that

<pre>public ArrayList<Object> encode(ArrayList<Object> arg);</pre>

==Arguments==
#arg - The return message(s) before they has been processed is in the array of objects

==Return Value==
An array of objects where each object is a formatted response message ready to be sent back to the client.

==Reference Implementation==
This is the encode method for the symbol reader. Because some commands in the symbol reader need to have more than one response message (e.g. a data message and a final message), more than one raw message can be in the array list in arg. For each message, the CRC must be calculated and appended.
<pre>
public ArrayList<Object> encode(ArrayList<Object> arg) {

ArrayList<Object> retVal = new ArrayList<Object>();

for (Object o : arg) {
byte[] command = (byte[]) o;

/*
* Create outgoing array list that is 3 slots bigger than incoming
* one: one for start of frame and two for crc bytes
*/
byte[] outgoingCommand = new byte[command.length + 3];
for (int i = 0; i < command.length; i++) {
outgoingCommand[i + 1] = command[i];
}

/* Add Start of Frame Byte */
outgoingCommand[0] = 0x01;

// Calculate CRC
int crc = CRC16.calculateCRC(command, 0xBEEF,
CRC16.XR400_CRC_TABLE, true);
byte[] crcBytes = ByteAndHexConvertingUtility
.intToByteArray(crc, 2);

// put crc in outgoingCommand, LSB first
outgoingCommand[outgoingCommand.length - 2] = crcBytes[1];
outgoingCommand[outgoingCommand.length - 1] = crcBytes[0];

logger.debug(ByteAndHexConvertingUtility.toHexString(outgoingCommand));

retVal.add(outgoingCommand);

}

return retVal;
}
</pre>

@@ Line 4: / Line 4: @@
 =decode=
-This method needs to decode an incoming command into a command to be handled in the command formatter.  It should put the command into a commandObject and put the commandObject in the first slot in an arraylist and return the arraylist. Normally the command object is a string that Rifidi uses to find the the appropriate command handler. The rest of the slots in the ArrayList may be used to pass arguments to the command handler, i.e. a coherent object that contains the the information already parsed and ready for consumption.
+This method needs to decode an incoming command into a command to be handled in the command formatter.  It should put the command into a commandObject and put the commandObject in the first slot in an arraylist and return the arraylist. Normally the command object is a string that Rifidi uses to find the the appropriate command handler. The rest of the slots in the ArrayList may be used to pass arguments to the command handler, i.e. a coherent object that contains the the information already parsed and ready for consumption. For an idea on how to do that, look up the ThingMagic source code.
 <pre>public ArrayList<Object> decode(byte[] arg);</pre>

← Older revision		Revision as of 00:34, 12 February 2008
Line 1:		Line 1:
		+	[[category:developerDoc]][[category:emulatorDoc]]
	This class should implement CommandHandler. This page goes through each of the four methods in CommandHandler and describes in detail what each one does and how it should be implemented. The first two methods are important, and the last two methods are not as important.		This class should implement CommandHandler. This page goes through each of the four methods in CommandHandler and describes in detail what each one does and how it should be implemented. The first two methods are important, and the last two methods are not as important.

@@ Line 1: / Line 1: @@
 [[category:developerDoc]][[category:emulatorDoc]]
 This class should implement CommandHandler.  This page goes through each of the four methods in CommandHandler and describes in detail what each one does and how it should be implemented.  The first two methods are important, and the last two methods are not as important.
@@ Line 14: / Line 6: @@
 This method needs to decode an incoming command into a command to be handled in the command formatter.  It should put the command into a commandObject and put the commandObject in the first slot in an arraylist and return the arraylist. Normally the command object is a string that Rifidi uses to find the the appropriate command handler. The rest of the slots in the ArrayList may be used to pass arguments to the command handler, i.e. a coherent object that contains the the information already parsed and ready for consumption. For an idea on how to do that, look up the ThingMagic source code.
-&lt;pre&gt;public ArrayList&lt;Object&gt; decode(byte[] arg);&lt;/pre&gt;
+<pre>public ArrayList<Object> decode(byte[] arg);</pre>
 ==Arguments==
@@ Line 24: / Line 16: @@
 ==Reference Implementation==
 This is the decode method in the alien reader
-&lt;pre&gt;
+<pre>
-	public ArrayList&lt;Object&gt; decode(byte[] arg) {
+	public ArrayList<Object> decode(byte[] arg) {
 		if (arg.length == 0) {
-			ArrayList&lt;Object&gt; argArray = new ArrayList&lt;Object&gt;();
+			ArrayList<Object> argArray = new ArrayList<Object>();
-			argArray.add(&quot;&quot;);
+			argArray.add("");
 			console = false;
 			return argArray;
@@ Line 34: / Line 26: @@
 		String newString = new String(arg);
-		logger.debug(&quot;Formatter arg: &quot; + newString);
+		logger.debug("Formatter arg: " + newString);
-		ArrayList&lt;Object&gt; retVal = this.parseCommand(newString);
+		ArrayList<Object> retVal = this.parseCommand(newString);
 		return retVal;
+	}
-&lt;/pre&gt;
+</pre>
 =encode=
 After a command has been processed by the command handler, the response it returns must be formatted to be sent back out to the client.
-&lt;pre&gt;public ArrayList&lt;Object&gt; encode(ArrayList&lt;Object&gt; arg);&lt;/pre&gt;
+<pre>public ArrayList<Object> encode(ArrayList<Object> arg);</pre>
 ==Arguments==
@@ Line 54: / Line 46: @@
 ==Reference Implementation==
 This is the encode method for the symbol reader.  Because some commands in the symbol reader need to have more than one response message (e.g. a data message and a final message), more than one raw message can be in the array list in arg.  For each message, the CRC must be calculated and appended.
-&lt;pre&gt;
+<pre>
-	public ArrayList&lt;Object&gt; encode(ArrayList&lt;Object&gt; arg) {
+	public ArrayList<Object> encode(ArrayList<Object> arg) {
-		ArrayList&lt;Object&gt; retVal = new ArrayList&lt;Object&gt;();
+		ArrayList<Object> retVal = new ArrayList<Object>();
 		for (Object o : arg) {
@@ Line 67: / Line 59: @@
 			 */
 			byte[] outgoingCommand = new byte[command.length + 3];
-			for (int i = 0; i &lt; command.length; i++) {
+			for (int i = 0; i < command.length; i++) {
 				outgoingCommand[i + 1] = command[i];
+			}
@@ Line 93: / Line 85: @@
 		return retVal;
+	}
-&lt;/pre&gt;
+</pre>
@@ Line 99: / Line 91: @@
 This method is mainly used by the alien reader to determine if the reader should supress the prompt when sending back a response.  Other readers may need similar functionality.
-&lt;pre&gt;public boolean promptSuppress();&lt;/pre&gt;
+<pre>public boolean promptSuppress();</pre>
 ==Arguments==
@@ Line 109: / Line 101: @@
 This method is mainly used by the alien reader to return a string that a user actually typed in.  Other readers may need similar functionality
-&lt;pre&gt;public String getActualCommand(byte[] arg);&lt;/pre&gt;
+<pre>public String getActualCommand(byte[] arg);</pre>
 ==Arguments==

@@ Line 42: / Line 42: @@
 ==Return Value==
-An array of objects where each object is a formatted response message ready to be sent back to the client.
+An array of objects where each object is a formatted response message ready to be sent back to the client. It must be formatted in a way that [[READERNAME_Protocol.java]]::addProtocol() can understand.
 ==Reference Implementation==