com.atakmap.android.cot.detail

Class CotDetailHandler

java.lang.Object

com.atakmap.android.cot.detail.CotDetailHandler

Direct Known Subclasses:

AddressDetailHandler, BullseyeDetailHandler, EmergencyDetailHandler, ForceXDetailHandler, GeoFenceDetailHandler, MarkerIncludedRouteDetailHandler, MetaDetailHandler, PrecisionLocationHandler, RouteDetailHandler, SensorDetailHandler, ShapeDetailHandler, ShapeMsdDetailHandler, TacticalOverlayDetailHandler, TakVersionDetailHandler, VehicleModelDetailHandler, VideoDetailHandler

public abstract class CotDetailHandler
extends java.lang.Object

Converts map item meta data to CoT details and vice versa These methods should be called when converting to and from CoT for a specific detail (usually supplied by map item metadata)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CotDetailHandler(java.util.Set<java.lang.String> detailNames)
protected	CotDetailHandler(java.lang.String detailName)

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getDetailNames() Get the set of detail names this handler supports
protected <T extends MapItem> T	getMapItem(java.lang.String uid) Find a map item by a UID with a given class
protected GeoPointMetaData	getPoint(MapItem item) Helper method for obtaining a point given a map item
boolean	isSupported(MapItem item, CotEvent event, CotDetail detail) Check if this handler supports this item Used to filter out certain types from being processed by a handler
protected double	parseDouble(java.lang.String value, double defaultVal) Convert a string to a double (exceptions caught with fallback)
protected int	parseInt(java.lang.String value, int defaultVal) Convert a string to an int (exceptions caught with fallback)
abstract boolean	toCotDetail(MapItem item, CotEvent event, CotDetail root) Convert map item metadata to a CoT detail
abstract CommsMapComponent.ImportResult	toItemMetadata(MapItem item, CotEvent event, CotDetail detail) Convert CoT event detail to map item metadata

Methods inherited from class java.lang.Object

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

Constructor Detail

CotDetailHandler

protected CotDetailHandler(java.util.Set<java.lang.String> detailNames)

CotDetailHandler

protected CotDetailHandler(java.lang.String detailName)

Method Detail

getDetailNames

public final java.util.Set<java.lang.String> getDetailNames()

Get the set of detail names this handler supports

Returns:

Set of detail names

toItemMetadata

public abstract CommsMapComponent.ImportResult toItemMetadata(MapItem item,
                                                              CotEvent event,
                                                              CotDetail detail)

Convert CoT event detail to map item metadata

Parameters:

item - Map item

event - Item's associated CoT event

detail - The detail associated with this handler (read from this)

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

toCotDetail

public abstract boolean toCotDetail(MapItem item,
                                    CotEvent event,
                                    CotDetail root)

Convert map item metadata to a CoT detail

Parameters:

item - Map item to read

event - Item's associated CoT event

root - The CoT event root detail (add to this)

Returns:

True if handled, false if not

isSupported

public boolean isSupported(MapItem item,
                           CotEvent event,
                           CotDetail detail)

Check if this handler supports this item Used to filter out certain types from being processed by a handler

Parameters:

item - Map item

event - CoT Event

detail - Associated CoT detail

Returns:

True if supported

getPoint

protected GeoPointMetaData getPoint(MapItem item)

Helper method for obtaining a point given a map item

Parameters:

item - Map item

Returns:

A single point representing this map item or null if N/A

parseDouble

protected double parseDouble(java.lang.String value,
                             double defaultVal)

Convert a string to a double (exceptions caught with fallback)

Parameters:

value - String value

defaultVal - Default value if conversion fails

Returns:

Converted value or default value if conversion failed

parseInt

protected int parseInt(java.lang.String value,
                       int defaultVal)

Convert a string to an int (exceptions caught with fallback)

Parameters:

value - String value

defaultVal - Default value if conversion fails

Returns:

Converted value or default value if conversion failed

getMapItem

protected <T extends MapItem> T getMapItem(java.lang.String uid)

Find a map item by a UID with a given class

Type Parameters:

T - Class type

Parameters:

uid - Map item UID

Returns:

Map item of type T or null if not found or not convertible