com.atakmap.spatial.file

Class SpatialDbContentSource

java.lang.Object

com.atakmap.spatial.file.SpatialDbContentSource

All Implemented Interfaces:

Importer

Direct Known Subclasses:

FalconViewSpatialDb, MvtSpatialDb, OgrSpatialDb

public abstract class SpatialDbContentSource
extends java.lang.Object
implements Importer

A source of content for the spatial database. The content source will process directories and files, as instructed, and populate the spatial database and update the catalog appropriately.

Implementors may expect that all directory and file processing will occur in a thread-safe manner and that transactions will be applied to the spatial database and catalog externally.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATAK_ACTION_HANDLE_DATA
static java.lang.String	ATAK_GROUP_NAME_EXTRA
protected SpatialDbContentResolver	contentResolver
protected DataSourceFeatureDataStore	database
protected java.lang.String	groupName
protected boolean	notifyUserAfterImport
static int	PROCESS_ACCEPT Flag indicating that the current file should be processed for content.
static int	PROCESS_RECURSE Flag indicating that processing should recurse into the current directory.
static int	PROCESS_REJECT Flag indicating that the current file should not undergo further processing.
protected java.lang.String	type

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SpatialDbContentSource(DataSourceFeatureDataStore database, java.lang.String groupName, java.lang.String type)

Method Summary

Modifier and Type	Method and Description
protected boolean	checkValidEntry(java.io.File file) Returns a flag indicating whether or not the catalog entry is valid.
MapOverlay	createOverlay(android.content.Context context, FeatureDataStoreDeepMapItemQuery query)
void	deleteAll()
boolean	deleteData(android.net.Uri uri, java.lang.String mime) The method used to remove the imported data
void	dispose() Dispose the importer - to be called when the map component is destroyed
SpatialDbContentResolver	getContentResolver()
DataSourceFeatureDataStore	getDatabase() Returns the data base that backs the features.
abstract java.lang.String	getFileDirectoryName() Returns the principal directory containing the content (e.g.
abstract java.lang.String	getFileMimeType() Returns the MIME type associated with the content.
java.lang.String	getGroupName() Returns the group name for the content.
abstract int	getIconId() Returns the Resource ID of the icon drawable (used in notifications)
abstract java.lang.String	getIconPath() Returns the path to an icon appropriate for the content.
static int	getNotificationId() Reuse from just a few IDs to avoid many many notifications
protected abstract java.lang.String	getProviderHint(java.io.File file) Processes the specified file.
java.util.Set<java.lang.String>	getSupportedMIMETypes() Returns the set of mime types supported by this importer.
java.lang.String	getType() Returns the type of the content.
CommsMapComponent.ImportResult	importData(java.io.InputStream source, java.lang.String mime, android.os.Bundle bundle) The method used to import the data
CommsMapComponent.ImportResult	importData(android.net.Uri uri, java.lang.String mime, android.os.Bundle b) The method used to import the data
static MapGroup	makeMapGroup(SpatialDbContentSource contentSource) Creates a new MapGroup for the source using the source's group name and icon.
static void	notifyUserOfError(com.atakmap.spatial.file.DataIngestReport report, java.io.File fromFile)
static void	notifyUserOfError(java.io.File file, java.lang.String ticker, java.lang.String message)
protected static void	notifyUserOfError(java.lang.String allThree)
static void	notifyUserOfError(java.lang.String title, java.lang.String ticker, java.lang.String message)
int	processAccept(java.io.File f, int depth) Returns a flag instructing the process loop how to handle the file.
boolean	processFile(java.io.File file) Processes the specified file.
void	setContentResolver(SpatialDbContentResolver resolver) Set the content resolver for this importer The resolver will be notified of any adds, updates, or removals of database content

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atakmap.android.importexport.Importer

getContentType

Field Detail

PROCESS_ACCEPT

public static final int PROCESS_ACCEPT

Flag indicating that the current file should be processed for content.

See Also:

Constant Field Values

PROCESS_REJECT

public static final int PROCESS_REJECT

Flag indicating that the current file should not undergo further processing.

See Also:

Constant Field Values

PROCESS_RECURSE

public static final int PROCESS_RECURSE

Flag indicating that processing should recurse into the current directory.

See Also:

Constant Field Values

ATAK_ACTION_HANDLE_DATA

public static final java.lang.String ATAK_ACTION_HANDLE_DATA

See Also:

Constant Field Values

ATAK_GROUP_NAME_EXTRA

public static final java.lang.String ATAK_GROUP_NAME_EXTRA

See Also:

Constant Field Values

groupName

protected final java.lang.String groupName

type

protected final java.lang.String type

database

protected final DataSourceFeatureDataStore database

notifyUserAfterImport

protected final boolean notifyUserAfterImport

contentResolver

protected SpatialDbContentResolver contentResolver

Constructor Detail

SpatialDbContentSource

protected SpatialDbContentSource(DataSourceFeatureDataStore database,
                                 java.lang.String groupName,
                                 java.lang.String type)

Method Detail

getDatabase

public final DataSourceFeatureDataStore getDatabase()

Returns the data base that backs the features.

Returns:

the database for the features.

dispose

public void dispose()

Dispose the importer - to be called when the map component is destroyed

getType

public final java.lang.String getType()

Returns the type of the content.

Returns:

The type of the content

getGroupName

public final java.lang.String getGroupName()

Returns the group name for the content.

Returns:

The group name for the content.

getFileDirectoryName

public abstract java.lang.String getFileDirectoryName()

Returns the principal directory containing the content (e.g. atak/KML).

Returns:

The principal directory containing the content.

getFileMimeType

public abstract java.lang.String getFileMimeType()

Returns the MIME type associated with the content.

Returns:

The MIME type associated with the content.

getIconPath

public abstract java.lang.String getIconPath()

Returns the path to an icon appropriate for the content.

Returns:

The path to an icon appropriate for the content. May be null to indicate no icon.

getIconId

public abstract int getIconId()

Returns the Resource ID of the icon drawable (used in notifications)

Returns:

the resource id of the icon.

setContentResolver

public void setContentResolver(SpatialDbContentResolver resolver)

Set the content resolver for this importer The resolver will be notified of any adds, updates, or removals of database content

Parameters:

resolver - Content resolver or null to dispose

getContentResolver

public SpatialDbContentResolver getContentResolver()

createOverlay

public MapOverlay createOverlay(android.content.Context context,
                                FeatureDataStoreDeepMapItemQuery query)

processFile

public boolean processFile(java.io.File file)

Processes the specified file. The file is not currently cataloged in the database.

Parameters:

file - The file to be processed.

getProviderHint

protected abstract java.lang.String getProviderHint(java.io.File file)

Processes the specified file. If the file contains valid content, the features should be added to the spatial database and a catalog entry created for the file.

Parameters:

file - The file to be processed.

checkValidEntry

protected boolean checkValidEntry(java.io.File file)

Returns a flag indicating whether or not the catalog entry is valid.

Parameters:

file - A file. The catalog may or may not contain an entry for the file.

Returns:

false if there is no catalog entry for the file or if the file fails

makeMapGroup

public static MapGroup makeMapGroup(SpatialDbContentSource contentSource)

Creates a new MapGroup for the source using the source's group name and icon. The group's ignoreOffscreen metadata is set to true.

Parameters:

contentSource - The source

Returns:

A new MapGroup for the source.

processAccept

public int processAccept(java.io.File f,
                         int depth)

Returns a flag instructing the process loop how to handle the file.

Parameters:

f - The file to be processed

depth - The current recursion depth

Returns:

Returns one of PROCESS_ACCEPT, PROCESS_RECURSE or PROCESS_REJECT.

notifyUserOfError

public static void notifyUserOfError(com.atakmap.spatial.file.DataIngestReport report,
                                     java.io.File fromFile)

notifyUserOfError

public static void notifyUserOfError(java.io.File file,
                                     java.lang.String ticker,
                                     java.lang.String message)

notifyUserOfError

protected static void notifyUserOfError(java.lang.String allThree)

notifyUserOfError

public static void notifyUserOfError(java.lang.String title,
                                     java.lang.String ticker,
                                     java.lang.String message)

getSupportedMIMETypes

public java.util.Set<java.lang.String> getSupportedMIMETypes()

Description copied from interface: Importer

Returns the set of mime types supported by this importer.

Specified by:

getSupportedMIMETypes in interface Importer

Returns:

the set of mimetypes

importData

public CommsMapComponent.ImportResult importData(java.io.InputStream source,
                                                 java.lang.String mime,
                                                 android.os.Bundle bundle)

Description copied from interface: Importer

The method used to import the data

Specified by:

importData in interface Importer

Parameters:

source - the input stream to use when importing

mime - the mime type for the input stream

bundle - the bundle that would have additional information concerning the import

Returns:

the state of the import (Success, Failure or Deferred)

importData

public CommsMapComponent.ImportResult importData(android.net.Uri uri,
                                                 java.lang.String mime,
                                                 android.os.Bundle b)

Description copied from interface: Importer

The method used to import the data

Specified by:

importData in interface Importer

Parameters:

uri - the uri to use when importing

mime - the mime type for the input stream

b - the bundle that would have additional information concerning the import

Returns:

the state of the import (Success, Failure or Deferred)

deleteData

public boolean deleteData(android.net.Uri uri,
                          java.lang.String mime)

Description copied from interface: Importer

The method used to remove the imported data

Specified by:

deleteData in interface Importer

Parameters:

uri - the input stream to use when importing

mime - the mime type for the input stream

Returns:

the state of the import (Success is true, Failure is false)

getNotificationId

public static int getNotificationId()

Reuse from just a few IDs to avoid many many notifications

Returns:

the notification id

deleteAll

public void deleteAll()