com.atakmap.android.cot.importer

Class MapItemImporter

java.lang.Object

com.atakmap.android.importexport.AbstractImporter

com.atakmap.android.importexport.AbstractCotEventImporter

com.atakmap.android.cot.importer.CotEventTypeImporter

com.atakmap.android.cot.importer.MapItemImporter

All Implemented Interfaces:

CotEventImporter, Importer

Direct Known Subclasses:

DrawingImporter, MarkerImporter, RangeAndBearingImporter, VehicleModelImporter

public abstract class MapItemImporter
extends CotEventTypeImporter

CoT importer specifically for items on the map

Field Summary

Fields

Modifier and Type	Field and Description
protected android.content.Context	_context
protected MapGroup	_group
protected MapView	_mapView
protected android.content.SharedPreferences	_prefs
protected static java.lang.String	FROM_MISSIONPACKAGE
protected static java.lang.String	FROM_STATESAVER
protected static NotificationIdRecycler	NOTIFICATION_ID

Fields inherited from class com.atakmap.android.importexport.AbstractCotEventImporter

crcBlacklist, supportedMimeTypes

Fields inherited from class com.atakmap.android.importexport.AbstractImporter

contentType

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MapItemImporter(MapView mapView, MapGroup group)
protected	MapItemImporter(MapView mapView, MapGroup group, java.util.Set<java.lang.String> types)
protected	MapItemImporter(MapView mapView, MapGroup group, java.lang.String... types)

Method Summary

Modifier and Type	Method and Description
protected void	addToGroup(MapItem item)
protected void	addToGroup(MapItem item, MapGroup group) Helper method for adding an item to the defined group for this instance
protected void	dispatchItemImported(MapItem item, android.os.Bundle extras) Dispatch event for when the item has been imported
protected MapItem	findItem(CotEvent event)
protected MapItem	findItem(java.lang.String uid) Find a map item given its CoT event This should be a quick operation
protected int	getNotificationIcon(MapItem item) Get an to represent this importer's notification Note: Due to a limitation with the Android notification API, this method MUST return an ATAK core icon resource ID
CommsMapComponent.ImportResult	importData(CotEvent event, android.os.Bundle extras)
protected abstract CommsMapComponent.ImportResult	importMapItem(MapItem existing, CotEvent cot, android.os.Bundle extras) Import a map item via CoT event Sub-class implementation is responsible for the following: - Create the new map item (if it doesn't exist) - Update item metadata based on event content - Add the item to a map group (if not already added)
protected boolean	isLocalImport(android.os.Bundle extras) Helper method to check if import extras signify a local import depending on the "from" attribute
protected boolean	isStateSaverImport(android.os.Bundle extras) Helper method to check if import extras signify an import from the statesaver.
protected boolean	persist(MapItem item, android.os.Bundle extras) Persist a map item if it 'should' be persisted (has the archive flag and isn't being imported from the statesaver)
protected void	postNotification(MapItem item) Post notification for a newly received map item

Methods inherited from class com.atakmap.android.cot.importer.CotEventTypeImporter

getSupportedCotTypes, importNonCotData, isPrefixOnly, setPrefixOnly

Methods inherited from class com.atakmap.android.importexport.AbstractCotEventImporter

crcDetails, getSupportedMIMETypes, importData, importData, importData, parseColor, parseDouble, parseInt

Methods inherited from class com.atakmap.android.importexport.AbstractImporter

deleteData, getContentType, importUriAsStream

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

deleteData, getContentType

Field Detail

FROM_STATESAVER

protected static final java.lang.String FROM_STATESAVER

See Also:

Constant Field Values

FROM_MISSIONPACKAGE

protected static final java.lang.String FROM_MISSIONPACKAGE

See Also:

Constant Field Values

NOTIFICATION_ID

protected static final NotificationIdRecycler NOTIFICATION_ID

_mapView

protected final MapView _mapView

_context

protected final android.content.Context _context

_prefs

protected final android.content.SharedPreferences _prefs

_group

protected final MapGroup _group

Constructor Detail

MapItemImporter

protected MapItemImporter(MapView mapView,
                          MapGroup group,
                          java.util.Set<java.lang.String> types)

MapItemImporter

protected MapItemImporter(MapView mapView,
                          MapGroup group,
                          java.lang.String... types)

MapItemImporter

protected MapItemImporter(MapView mapView,
                          MapGroup group)

Method Detail

importData

public CommsMapComponent.ImportResult importData(CotEvent event,
                                                 android.os.Bundle extras)

Specified by:

importData in interface CotEventImporter

Overrides:

importData in class CotEventTypeImporter

dispatchItemImported

protected void dispatchItemImported(MapItem item,
                                    android.os.Bundle extras)

Dispatch event for when the item has been imported

Parameters:

item - Map item

extras - Import extras

importMapItem

protected abstract CommsMapComponent.ImportResult importMapItem(MapItem existing,
                                                                CotEvent cot,
                                                                android.os.Bundle extras)

Import a map item via CoT event Sub-class implementation is responsible for the following: - Create the new map item (if it doesn't exist) - Update item metadata based on event content - Add the item to a map group (if not already added)

Parameters:

existing - Existing map item (null if new)

cot - CoT event

extras - Import extras

Returns:

CommsMapComponent.ImportResult.SUCCESS if handled successfully CommsMapComponent.ImportResult.FAILURE if handled but failed CommsMapComponent.ImportResult.IGNORE if not handled or N/A CommsMapComponent.ImportResult.DEFERRED if we should try again later

findItem

protected MapItem findItem(java.lang.String uid)

Find a map item given its CoT event This should be a quick operation

Returns:

Map item or null if not found

findItem

protected MapItem findItem(CotEvent event)

addToGroup

protected void addToGroup(MapItem item,
                          MapGroup group)

Helper method for adding an item to the defined group for this instance

Parameters:

item - Map item

addToGroup

protected void addToGroup(MapItem item)

isLocalImport

protected boolean isLocalImport(android.os.Bundle extras)

Helper method to check if import extras signify a local import depending on the "from" attribute

Parameters:

extras - Import extras

Returns:

True if local import

isStateSaverImport

protected boolean isStateSaverImport(android.os.Bundle extras)

Helper method to check if import extras signify an import from the statesaver. Items that are imported from the statesaver generally should NOT be persisted upon import.

Parameters:

extras - Import extras

Returns:

True if from statesaver

persist

protected boolean persist(MapItem item,
                          android.os.Bundle extras)

Persist a map item if it 'should' be persisted (has the archive flag and isn't being imported from the statesaver)

Parameters:

item - Map item

extras - Import extras

Returns:

True if persisted

getNotificationIcon

protected int getNotificationIcon(MapItem item)

Get an to represent this importer's notification Note: Due to a limitation with the Android notification API, this method MUST return an ATAK core icon resource ID

Parameters:

item - Map item (not null)

Returns:

Notification icon

postNotification

protected void postNotification(MapItem item)

Post notification for a newly received map item

Parameters:

item - Map item to post the notification for