com.atakmap.android.maps

Class DefaultMapGroup

java.lang.Object

com.atakmap.android.maps.FilterMetaDataHolder

com.atakmap.android.maps.MapGroup

com.atakmap.android.maps.DefaultMapGroup

All Implemented Interfaces:

HashtagSearch, DeepMapItemQuery, MetaDataHolder

Direct Known Subclasses:

RootMapGroup, RubberSheetMapGroup

public class DefaultMapGroup
extends MapGroup

Collection of MapItems and child MapGroups. MapGroup's also contain dynamic properties which are observable. These properties are used to define component or user specific details about the MapItems in the group and child groups. A child group with the same dynamic property as a parent group in a sense overrides it's parents dynamic property when considering it own MapItems. Some built in core-components use pre-defined dynamic properties (such as the GLMapComponent for coloring and styling).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultMapGroup.MetaDataMapItemFilter

Nested classes/interfaces inherited from class com.atakmap.android.maps.MapGroup

MapGroup.MapItemsCallback, MapGroup.OnFriendlyNameChangedListener, MapGroup.OnGroupListChangedListener, MapGroup.OnItemCallback<T extends MapItem>, MapGroup.OnItemListChangedListener, MapGroup.OnVisibleChangedListener

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	_friendlyName
protected java.util.Map<java.lang.Long,MapGroup>	_groups
protected java.util.Map<java.lang.Long,MapItem>	_items
protected boolean	_visible

Fields inherited from class com.atakmap.android.maps.FilterMetaDataHolder

metadata

Constructor Summary

Constructors

Constructor and Description
DefaultMapGroup() Create an empty MapGroup
DefaultMapGroup(java.lang.String friendlyName) Create a MapGroup with a friendly display name
DefaultMapGroup(java.lang.String friendlyName, java.lang.String overlay, boolean permaGroup)
DefaultMapGroup(java.lang.String friendlyName, java.lang.String overlay, boolean permaGroup, double zOrder)

Method Summary

Modifier and Type	Method and Description
MapGroup	addGroup() Create and add a MapGroup
MapGroup	addGroup(MapGroup group) Add a MapGroup
MapGroup	addGroup(java.lang.String friendlyName) Create and add a MapGroup with a friendly display name
protected void	addItemImpl(MapItem item) Add an item to the group
void	clearGroups()
void	clearItems()
boolean	containsItem(MapItem item)
MapItem	deepFindItem(java.util.Map<java.lang.String,java.lang.String> metadata) Deep traverse the map group to find an item that matches search constraints.
java.util.Collection<MapItem>	deepFindItems(GeoBounds bounds, java.util.Map<java.lang.String,java.lang.String> metadata) Find map items within given boundaries
java.util.List<MapItem>	deepFindItems(java.util.Map<java.lang.String,java.lang.String> metadata)
MapGroup	deepFindMapGroup(java.lang.String friendlyname) Finds and returns THE FIRST child map group of this map group with a friendly name that matches 'friendlyname' in a breadth-first-search process.
MapItem	deepFindUID(java.lang.String uid) Stock implementation of searching for a UID.
boolean	deepForEachItem(MapGroup.MapItemsCallback cb)
MapItem	findClosestItem(GeoPoint location, double threshold, java.util.Map<java.lang.String,java.lang.String> metadata) Finds the closest MapItem to the specified point, that falls within the specified threshold.
MapItem	findItem(java.util.Map<java.lang.String,java.lang.String> meta)
java.util.Collection<MapItem>	findItems(GeoBounds bounds, java.util.Map<java.lang.String,java.lang.String> metadata)
java.util.Collection<MapItem>	findItems(GeoPoint location, double radius, java.util.Map<java.lang.String,java.lang.String> metadata)
java.util.List<MapItem>	findItems(java.util.Map<java.lang.String,java.lang.String> meta)
MapGroup	findMapGroup(java.lang.String friendlyname) Finds and returns THE FIRST child map group of this map group with a friendly name that matches 'friendlyname'.
boolean	forEachItem(MapGroup.MapItemsCallback cb) Executes the callback on each of this group's child items until a value of true is returned by the callback.
MapGroup	getChildGroupById(long id)
java.util.Collection<MapGroup>	getChildGroups()
java.lang.String	getFriendlyName() Get the friendly name of the MapGroup
int	getGroupCount() Get the number of child MapGroups
MapItem	getItemById(long id)
int	getItemCount() Get the number of MapItems in the group
java.util.Collection<MapItem>	getItems()
java.util.Collection<MapGroup>	getMapGroups()
java.util.Collection<MapItem>	getMapItems()
boolean	getVisible()
protected boolean	removeGroupImpl(MapGroup group, boolean referenceOnly) Remove a MapGroup if it belongs to this one ;
protected boolean	removeItemImpl(MapItem item) Implementation for removing an item from a map group.
void	setFriendlyName(java.lang.String friendlyName)
void	setVisible(boolean visible)
void	setVisibleIgnoreChildren(boolean visible) Set group visibility without modifying the visibility of children items

Methods inherited from class com.atakmap.android.maps.MapGroup

addItem, addOnFriendlyNameChangedListener, addOnGroupListChangedListener, addOnItemListChangedListener, addOnVisibleChangedListener, createMapGroupSerialId, createMarker, deepFindClosestItem, deepFindClosestItem, deepFindClosestItem, deepFindClosestItem, deepFindClosestItem, deepFindClosestItem, deepFindGroupByNameBreadthFirst, deepFindGroupByNameDepthFirst, deepFindGroupBySerialIdBreadthFirst, deepFindGroupBySerialIdDepthFirst, deepFindItem, deepFindItems, deepFindItems, deepFindItems, deepFindItems, deepFindItemsWithMetaString, deepFindItemsWithMetaString, deepFindItemWithMetaString, deepFindItemWithMetaString, deepFindItemWithSerialId, deepHitTest, deepHitTestItems, deepMapItems, deepMapItemsCount, deepMapItemsCount, dispatchFriendlyNameChanged, dispatchGroupAdded, dispatchGroupRemoved, dispatchItemAdded, dispatchItemRemoved, dispatchVisibleChanged, findClosestItem, findClosestItem, findClosestItem, findClosestItem, findClosestItem, findItem, findItems, findItems, findItems, findItemsWithMetaString, findItemWithMetaString, findItemWithMetaString, findItemWithMetaStringImpl, findMapGroup, getItemsRecursive, getParentGroup, getPath, getSerialId, hasItemListChangedListeners, hitTest, hitTestItems, mapItems, mapItemsCount, matchItemWithMetaString, matchItemWithMetaString, matchItemWithMetaString, onAddedNoSync, onRemovedNoSync, removeGroup, removeItem, removeOnFriendlyNameChangedListener, removeOnGroupListChangedListener, removeOnItemListChangedListener, removeOnVisibleChangedListener, search, setDefaultZOrder

Methods inherited from class com.atakmap.android.maps.FilterMetaDataHolder

copyMetaData, get, getMetaBoolean, getMetaData, getMetaDouble, getMetaIntArray, getMetaInteger, getMetaLong, getMetaMap, getMetaParcelable, getMetaSerializable, getMetaString, getMetaStringArrayList, hasMetaValue, removeMetaData, setMetaBoolean, setMetaData, setMetaDataImpl, setMetaDouble, setMetaIntArray, setMetaInteger, setMetaLong, setMetaMap, setMetaParcelable, setMetaSerializable, setMetaString, setMetaStringArrayList, toggleMetaData

Methods inherited from class java.lang.Object

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

Field Detail

_visible

protected boolean _visible

_friendlyName

protected java.lang.String _friendlyName

_items

protected final java.util.Map<java.lang.Long,MapItem> _items

_groups

protected final java.util.Map<java.lang.Long,MapGroup> _groups

Constructor Detail

DefaultMapGroup

public DefaultMapGroup()

Create an empty MapGroup

DefaultMapGroup

public DefaultMapGroup(java.lang.String friendlyName)

Create a MapGroup with a friendly display name

Parameters:

friendlyName - the friendly display name

DefaultMapGroup

public DefaultMapGroup(java.lang.String friendlyName,
                       java.lang.String overlay,
                       boolean permaGroup)

DefaultMapGroup

public DefaultMapGroup(java.lang.String friendlyName,
                       java.lang.String overlay,
                       boolean permaGroup,
                       double zOrder)

Method Detail

clearItems

public void clearItems()

Specified by:

clearItems in class MapGroup

clearGroups

public void clearGroups()

Specified by:

clearGroups in class MapGroup

setVisible

public void setVisible(boolean visible)

Specified by:

setVisible in class MapGroup

setVisibleIgnoreChildren

public void setVisibleIgnoreChildren(boolean visible)

Description copied from class: MapGroup

Set group visibility without modifying the visibility of children items

Overrides:

setVisibleIgnoreChildren in class MapGroup

getVisible

public boolean getVisible()

Specified by:

getVisible in class MapGroup

getGroupCount

public int getGroupCount()

Get the number of child MapGroups

Specified by:

getGroupCount in class MapGroup

Returns:

the number of items in the group

removeGroupImpl

protected boolean removeGroupImpl(MapGroup group,
                                  boolean referenceOnly)

Remove a MapGroup if it belongs to this one ;

Specified by:

removeGroupImpl in class MapGroup

Parameters:

group - the MapGroup to remove

referenceOnly - If true only references to the group should be removed. This will be the common case when the remove is effected by adding the child to another group. If false it is assumed that the group is being disposed of.

Returns:

true if group belonged and was removed

addGroup

public MapGroup addGroup(MapGroup group)

Add a MapGroup

Specified by:

addGroup in class MapGroup

Parameters:

group - the MapGroup to add

Returns:

addGroup

public MapGroup addGroup()

Create and add a MapGroup

Specified by:

addGroup in class MapGroup

Returns:

the freshly created and added MapGroup

addGroup

public MapGroup addGroup(java.lang.String friendlyName)

Create and add a MapGroup with a friendly display name

Specified by:

addGroup in class MapGroup

Parameters:

friendlyName - the friendly display name

Returns:

the freshly created and added MapGroup

getItemCount

public int getItemCount()

Get the number of MapItems in the group

Specified by:

getItemCount in class MapGroup

Returns:

addItemImpl

protected void addItemImpl(MapItem item)

Add an item to the group

Specified by:

addItemImpl in class MapGroup

Parameters:

item - the item to add

deepFindUID

public MapItem deepFindUID(java.lang.String uid)

Description copied from class: MapGroup

Stock implementation of searching for a UID.

Overrides:

deepFindUID in class MapGroup

deepFindItem

public MapItem deepFindItem(java.util.Map<java.lang.String,java.lang.String> metadata)

Description copied from class: MapGroup

Deep traverse the map group to find an item that matches search constraints.

Specified by:

deepFindItem in interface DeepMapItemQuery

Specified by:

deepFindItem in class MapGroup

Parameters:

metadata - is the map looking for matches with a key and a value.

Returns:

deepFindItems

public java.util.List<MapItem> deepFindItems(java.util.Map<java.lang.String,java.lang.String> metadata)

findItem

public MapItem findItem(java.util.Map<java.lang.String,java.lang.String> meta)

Specified by:

findItem in class MapGroup

Parameters:

meta - is the map looking for matches with a key and a value.

Returns:

findItems

public java.util.List<MapItem> findItems(java.util.Map<java.lang.String,java.lang.String> meta)

Specified by:

findItems in class MapGroup

Parameters:

meta - is the map looking for matches with a key and a value.

Returns:

findMapGroup

public MapGroup findMapGroup(java.lang.String friendlyname)

Finds and returns THE FIRST child map group of this map group with a friendly name that matches 'friendlyname'. NOTE: MapGroup names are not guaranteed to be unique. Make sure you know where you're searching before you grab a map group that may not be the one you actually want.

Overrides:

findMapGroup in class MapGroup

Parameters:

friendlyname - the friendly name of the group to find

Returns:

the FIRST map group encountered with a matching friendly name or null if it was not found

deepFindMapGroup

public MapGroup deepFindMapGroup(java.lang.String friendlyname)

Finds and returns THE FIRST child map group of this map group with a friendly name that matches 'friendlyname' in a breadth-first-search process. This means it will search all of its children before going back and checking its children's groups. NOTE: MapGroup names are not guaranteed to be unique. Make sure you know where you're searching before you grab a map group that may not be the one you actually want.

Overrides:

deepFindMapGroup in class MapGroup

Parameters:

friendlyname - the friendly name of the group to find

Returns:

the FIRST map group encountered with a matching friendly name or null if it was not found

getFriendlyName

public java.lang.String getFriendlyName()

Get the friendly name of the MapGroup

Specified by:

getFriendlyName in class MapGroup

Returns:

setFriendlyName

public void setFriendlyName(java.lang.String friendlyName)

Specified by:

setFriendlyName in class MapGroup

removeItemImpl

protected boolean removeItemImpl(MapItem item)

Description copied from class: MapGroup

Implementation for removing an item from a map group. This will return true if the item was in the map group and removed, otherwise it will return false if the item was not in the map group.

Specified by:

removeItemImpl in class MapGroup

getChildGroups

public java.util.Collection<MapGroup> getChildGroups()

Specified by:

getChildGroups in class MapGroup

getMapGroups

public java.util.Collection<MapGroup> getMapGroups()

getItems

public java.util.Collection<MapItem> getItems()

Specified by:

getItems in class MapGroup

getMapItems

public java.util.Collection<MapItem> getMapItems()

getChildGroupById

public MapGroup getChildGroupById(long id)

Specified by:

getChildGroupById in class MapGroup

getItemById

public MapItem getItemById(long id)

Specified by:

getItemById in class MapGroup

containsItem

public boolean containsItem(MapItem item)

Overrides:

containsItem in class MapGroup

deepForEachItem

public boolean deepForEachItem(MapGroup.MapItemsCallback cb)

Specified by:

deepForEachItem in class MapGroup

forEachItem

public boolean forEachItem(MapGroup.MapItemsCallback cb)

Description copied from class: MapGroup

Executes the callback on each of this group's child items until a value of true is returned by the callback.

Specified by:

forEachItem in class MapGroup

Returns:

findClosestItem

public MapItem findClosestItem(GeoPoint location,
                               double threshold,
                               java.util.Map<java.lang.String,java.lang.String> metadata)

Description copied from class: MapGroup

Finds the closest MapItem to the specified point, that falls within the specified threshold.

Specified by:

findClosestItem in class MapGroup

Parameters:

location - The location

threshold - The search threshold, in meters. Only items that are within this distance from the point are considered. If no threshold is desired, the value 0.0d should be specified.

Returns:

findItems

public java.util.Collection<MapItem> findItems(GeoPoint location,
                                               double radius,
                                               java.util.Map<java.lang.String,java.lang.String> metadata)

Specified by:

findItems in class MapGroup

findItems

public java.util.Collection<MapItem> findItems(GeoBounds bounds,
                                               java.util.Map<java.lang.String,java.lang.String> metadata)

deepFindItems

public java.util.Collection<MapItem> deepFindItems(GeoBounds bounds,
                                                   java.util.Map<java.lang.String,java.lang.String> metadata)

Description copied from interface: DeepMapItemQuery

Find map items within given boundaries

Parameters:

bounds - Geodetic boundaries

metadata - Extra query metadata

Returns:

List of found map items or null if none found