Pr22

Class DocScanner

java.lang.Object

Pr22.DocScanner

public class DocScanner
extends java.lang.Object

Document scanner module.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DocScanner.Information Class for storing information on a DocScanner.

Method Summary

Modifier and Type	Method and Description
void	cleanUpData() Removes all the internally stored data (images, documents) from the system.
void	cleanUpLastPage() Removes the internally stored data (images, documents) of the last page from the system.
DocScanner.Information	getInfo() Returns the scanner information.
Page	getPage(int pageindex) Returns a previously scanned Page.
RawImage	getPreview() Returns the last captured preview image.
Document	loadDocument(BinData document) Loads the data of a "Root document" saved earlier.
Page	scan(DocScannerTask task, PagePosition pos) Takes images from an object window of the scanner.
TaskControl	startScanning(DocScannerTask task, PagePosition pos) Takes images from an object window of the scanner in a background thread.
TaskControl	startTask(FreerunTask task) Starts a task declared by the task parameter.

Methods inherited from class java.lang.Object

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

Method Detail

getInfo

public DocScanner.Information getInfo()
                               throws General

Returns the scanner information.

Returns:

The scanner information.

Throws:

General

scan

public Page scan(DocScannerTask task,
                 PagePosition pos)
          throws General

Takes images from an object window of the scanner.

Parameters:

task - List of lights and the object window Id.

pos - The target page.

Returns:

List of the scanned images.

Throws:

General

getPreview

public RawImage getPreview()
                    throws General

Returns the last captured preview image. To get preview images a FreerunTask.liveStream() task should be started before.

Returns:

The requested image.

Throws:

General

getPage

public Page getPage(int pageindex)
             throws General

Returns a previously scanned Page.

Parameters:

pageindex - Ordinal number of the requested Page.

Returns:

The Page.

Throws:

General

startScanning

public TaskControl startScanning(DocScannerTask task,
                                 PagePosition pos)
                          throws General

Takes images from an object window of the scanner in a background thread. After the process is finished the TaskControl.Wait() method must be called.

Parameters:

task - List of lights and the object window Id.

pos - The target page selector.

Returns:

A TaskControl object.

Throws:

General

startTask

public TaskControl startTask(FreerunTask task)
                      throws General

Starts a task declared by the task parameter. After the process is finished the TaskControl.Wait() method must be called.

Parameters:

task - The task to start.

Returns:

A TaskControl object.

Throws:

General

cleanUpData

public void cleanUpData()
                 throws General

Removes all the internally stored data (images, documents) from the system.

Throws:

General

cleanUpLastPage

public void cleanUpLastPage()
                     throws General

Removes the internally stored data (images, documents) of the last page from the system. Removing the last page is useful when a wrong page has scanned, e.g. because the scanned image is blurred or accidentally wrong document page has been scanned.

Throws:

General

loadDocument

public Document loadDocument(BinData document)
                      throws General

Loads the data of a "Root document" saved earlier. This method removes all the internally stored data (images, documents) from the system.

Parameters:

document - Data to load.

Returns:

Root document represents all the loaded data.

Throws:

General