com.atakmap.android.routes.cot

Class RouteDetailHandler

java.lang.Object

com.atakmap.android.cot.detail.CotDetailHandler

com.atakmap.android.routes.cot.RouteDetailHandler

Direct Known Subclasses:

NavigationCueHandler

public abstract class RouteDetailHandler
extends CotDetailHandler

Handler for a route detail under the "__routeinfo" node

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	_subName

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RouteDetailHandler(java.lang.String subName)

Method Summary

Modifier and Type	Method and Description
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
boolean	toCotDetail(MapItem item, CotEvent event, CotDetail detail) Convert map item metadata to a CoT detail
protected abstract CotDetail	toCotDetail(Route route) Create route detail element (under "__routeInfo")
CommsMapComponent.ImportResult	toItemMetadata(MapItem item, CotEvent event, CotDetail detail) Convert CoT event detail to map item metadata
protected abstract CommsMapComponent.ImportResult	toRouteMetadata(Route route, CotDetail subNode) Convert sub-detail node to route metadata

Methods inherited from class com.atakmap.android.cot.detail.CotDetailHandler

getDetailNames, getMapItem, getPoint, parseDouble, parseInt

Methods inherited from class java.lang.Object

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

Field Detail

_subName

protected final java.lang.String _subName

Constructor Detail

RouteDetailHandler

protected RouteDetailHandler(java.lang.String subName)

Method Detail

isSupported

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

Description copied from class: CotDetailHandler

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

Overrides:

isSupported in class CotDetailHandler

Parameters:

item - Map item

event - CoT Event

detail - Associated CoT detail

Returns:

True if supported

toCotDetail

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

Description copied from class: CotDetailHandler

Convert map item metadata to a CoT detail

Specified by:

toCotDetail in class CotDetailHandler

Parameters:

item - Map item to read

event - Item's associated CoT event

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

Returns:

True if handled, false if not

toItemMetadata

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

Description copied from class: CotDetailHandler

Convert CoT event detail to map item metadata

Specified by:

toItemMetadata in class CotDetailHandler

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

protected abstract CotDetail toCotDetail(Route route)

Create route detail element (under "__routeInfo")

Parameters:

route - Route

Returns:

New detail to add

toRouteMetadata

protected abstract CommsMapComponent.ImportResult toRouteMetadata(Route route,
                                                                  CotDetail subNode)

Convert sub-detail node to route metadata

Parameters:

route - Route

subNode - The sub-detail node (same name as passed into ctor)

Returns:

Import result