com.atakmap.android.layers

Class LayerScanner

java.lang.Object

com.atakmap.android.layers.LayerScanner

All Implemented Interfaces:

java.lang.Runnable

Direct Known Subclasses:

GenericLayerScanner

public abstract class LayerScanner
extends java.lang.Object
implements java.lang.Runnable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LayerScanner.Callback Interface that may be implemented to receive error, debugging, etc callbacks from this layer scanner.
static interface	LayerScanner.Spi

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	canceled
protected LocalRasterDataStore	database
protected java.lang.String	name

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LayerScanner(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
void	cancel() Instructs the scanner to terminate scanning as soon as possible.
protected void	cancelImpl() Subclasses may override this method to perform any additional activities that are required for cancelling the scan.
protected void	debug(java.lang.String msg) Subclasses should invoke to log a debug message with the owning ScanLayersService instance.
protected void	error(java.lang.String msg) Subclasses should invoke to log an error message with the owning ScanLayersService instance.
java.lang.String	getName() Returns the name of the scanner.
protected void	layerDiscovered(DatasetDescriptor layer) Subclasses should invoke when a layer is discovered while scanning.
void	prepare(LayerScanner.Callback callback) Invoked immediately before the enclosing Thread is started.
protected void	progress(java.lang.String msg)
abstract void	reset() Instructs the scanner to reset any state or cache information prior to initiating a scan.
abstract void	run()

Methods inherited from class java.lang.Object

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

Field Detail

name

protected final java.lang.String name

canceled

protected boolean canceled

database

protected LocalRasterDataStore database

Constructor Detail

LayerScanner

protected LayerScanner(java.lang.String name)

Method Detail

prepare

public void prepare(LayerScanner.Callback callback)

Invoked immediately before the enclosing Thread is started.

Parameters:

callback - The interface to be used for logging, error, etc callbacks.

layerDiscovered

protected void layerDiscovered(DatasetDescriptor layer)

Subclasses should invoke when a layer is discovered while scanning.

Parameters:

layer - The layer that was discovered.

error

protected void error(java.lang.String msg)

Subclasses should invoke to log an error message with the owning ScanLayersService instance.

Parameters:

msg - The error message

debug

protected void debug(java.lang.String msg)

Subclasses should invoke to log a debug message with the owning ScanLayersService instance.

Parameters:

msg - The debug message

progress

protected void progress(java.lang.String msg)

cancel

public final void cancel()

Instructs the scanner to terminate scanning as soon as possible. This method returns immediately.

cancelImpl

protected void cancelImpl()

Subclasses may override this method to perform any additional activities that are required for cancelling the scan.

IMPORTANT: This method should not block.

reset

public abstract void reset()

Instructs the scanner to reset any state or cache information prior to initiating a scan.

getName

public final java.lang.String getName()

Returns the name of the scanner.

Returns:

The name of the scanner.

run

public abstract void run()

Specified by:

run in interface java.lang.Runnable