com.cognex.mobile.barcode.sdk

Class ReadResults

java.lang.Object

com.cognex.mobile.barcode.sdk.ReadResults

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<ReadResult>

public class ReadResults
extends java.lang.Object
implements java.io.Serializable, java.lang.Iterable<ReadResult>

Represents a list of read results

You can obtain individual subresults of type ReadResult using getSubResults method. At single code read the ReadResult object can be found at position 0. On multi code read, the ReadResult object at position 0 is a processed combination of all sub results. Positions 1..n contain the individual subresults.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
int	getCount() Returns the number of results
ReadResult	getResultAt(int index) Returns a ReadResult at the specified position
java.util.List<ReadResult>	getSubResults() Helper method to retrieve multicode subresults.
java.lang.String	getXml() Returns the raw XML recieved from the reader
java.util.Iterator<ReadResult>	iterator()
static ReadResults	parse(ComplexResult result)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

iterator

public java.util.Iterator<ReadResult> iterator()

Specified by:

iterator in interface java.lang.Iterable<ReadResult>

getResultAt

public ReadResult getResultAt(int index)

Returns a ReadResult at the specified position

Parameters:

index - index of ReadResult to retrieve

Returns:

ReadResult at the specified index

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of range

getCount

public int getCount()

Returns the number of results

Returns:

the number of results

getXml

public java.lang.String getXml()

Returns the raw XML recieved from the reader

Returns:

the raw XML string or null, if XML parsing has failed

getSubResults

public java.util.List<ReadResult> getSubResults()

Helper method to retrieve multicode subresults.

Returns:

a list of ReadResult or null if only a single code was read

parse

public static ReadResults parse(ComplexResult result)
                         throws org.xmlpull.v1.XmlPullParserException,
                                java.io.IOException

Throws:

org.xmlpull.v1.XmlPullParserException

java.io.IOException