public abstract class AbstractScanListener extends Object implements ScanListener
Constructor and Description |
---|
AbstractScanListener() |
AbstractScanListener(ScanProgressListener progressListener) |
Modifier and Type | Method and Description |
---|---|
void |
finished(String error)
Scanning session has finished
|
List<Capability> |
getCapabilitiesToBeSet(int pageIndex,
long pageId)
List of capabilities to be set for the given page - in most cases, you should only set capabilities for the first page.
|
static AbstractScanListener |
newScanListener(OutputStream outputStream,
ScanProgressListener progressListener)
Constructs a scan listener with ScanListener.getPageOutputTarget(int, long) returns the same output stream for any page.
|
static AbstractScanListener |
newScanListener(String targetFilePath,
ScanProgressListener progressListener)
Constructs a scan listener with ScanListener.getPageOutputTarget(int, long) returns the same file path for any page.
|
void |
pageFinished(int pageIndex,
long pageId,
String error)
Indicates a page scan is done.
|
void |
pageProgress(int pageIndex,
long pageId,
int percent)
Reports the progress of page scanning.
|
void |
pageStarted(int pageIndex,
long pageId)
Indicates a page scan in this session has been started.
|
void |
started()
Scanning session has started; an ADF session could result multiple pages scanned.
|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getPageOutputTarget
public AbstractScanListener(ScanProgressListener progressListener)
public AbstractScanListener()
public static AbstractScanListener newScanListener(String targetFilePath, ScanProgressListener progressListener)
targetFilePath
- progressListener
- optional progress listenerpublic static AbstractScanListener newScanListener(OutputStream outputStream, ScanProgressListener progressListener)
outputStream
- progressListener
- optional progress listenerpublic List<Capability> getCapabilitiesToBeSet(int pageIndex, long pageId)
ScanListener
getCapabilitiesToBeSet
in interface ScanListener
public void started()
ScanListener
started
in interface ScanListener
public void pageStarted(int pageIndex, long pageId)
ScanListener
pageStarted
in interface ScanListener
public void pageProgress(int pageIndex, long pageId, int percent)
ScanListener
pageProgress
in interface ScanListener
percent
- a number between 0 to 100.public void pageFinished(int pageIndex, long pageId, String error)
ScanListener
pageFinished
in interface ScanListener
error
- error message or null
if succeeded.public void finished(String error)
ScanListener
finished
in interface ScanListener
error
- error message or null
if succeeded.Copyright © Asprise Software. All Rights Reserved. Please visit the product page at asprise.com