com.atakmap.android.maps

Class MapGroup

java.lang.Object

com.atakmap.android.maps.FilterMetaDataHolder

com.atakmap.android.maps.MapGroup

All Implemented Interfaces:

HashtagSearch, DeepMapItemQuery, MetaDataHolder

Direct Known Subclasses:

DefaultMapGroup

public abstract class MapGroup
extends FilterMetaDataHolder
implements DeepMapItemQuery, HashtagSearch

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 interface	MapGroup.MapItemsCallback
static interface	MapGroup.OnFriendlyNameChangedListener
static interface	MapGroup.OnGroupListChangedListener
static class	MapGroup.OnItemCallback<T extends MapItem>
static interface	MapGroup.OnItemListChangedListener
static interface	MapGroup.OnVisibleChangedListener

Field Summary

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

metadata

Constructor Summary

Constructors

Modifier	Constructor and Description
	MapGroup() Create an empty MapGroup with a new serial ID.
protected	MapGroup(long serialId)
protected	MapGroup(long serialId, MetaDataHolder metadata)
	MapGroup(MetaDataHolder metadata)

Method Summary

Modifier and Type	Method and Description
abstract MapGroup	addGroup() Create and add a MapGroup
abstract MapGroup	addGroup(MapGroup groupIface) Add a MapGroup
abstract MapGroup	addGroup(java.lang.String friendlyName) Create and add a MapGroup with a friendly display name
void	addItem(MapItem item) Add an item to the group.
protected abstract void	addItemImpl(MapItem item) Performs the actual addition of the item.
void	addOnFriendlyNameChangedListener(MapGroup.OnFriendlyNameChangedListener l)
void	addOnGroupListChangedListener(MapGroup.OnGroupListChangedListener listener) Add a groupList listener
void	addOnItemListChangedListener(MapGroup.OnItemListChangedListener listener) Add a itemList listener
void	addOnVisibleChangedListener(MapGroup.OnVisibleChangedListener l)
abstract void	clearGroups()
abstract void	clearItems()
boolean	containsItem(MapItem item)
static long	createMapGroupSerialId() Returns a serial ID that across an invocation of ATAK that is unique against all other IDs returned by this method.
Marker	createMarker(GeoPoint point, java.lang.String uid) Create a marker and specifically add it to the this group.
MapItem	deepFindClosestItem(GeoPoint location)
MapItem	deepFindClosestItem(GeoPoint location, double threshold)
MapItem	deepFindClosestItem(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	deepFindClosestItem(GeoPoint location, double threshold, java.lang.String key, java.lang.String value)
MapItem	deepFindClosestItem(GeoPoint location, java.util.Map<java.lang.String,java.lang.String> metadata)
MapItem	deepFindClosestItem(GeoPoint location, java.lang.String key, java.lang.String value)
static MapGroup	deepFindGroupByNameBreadthFirst(MapGroup group, java.lang.String friendlyname)
static MapGroup	deepFindGroupByNameDepthFirst(MapGroup group, java.lang.String friendlyname)
static MapGroup	deepFindGroupBySerialIdBreadthFirst(MapGroup group, long serialId)
static MapGroup	deepFindGroupBySerialIdDepthFirst(MapGroup group, long serialId)
abstract 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.
MapItem	deepFindItem(java.lang.String key, java.lang.String value) Deep traverse the map group to find an item that matches search constraints.
java.util.Collection<MapItem>	deepFindItems(GeoPoint location, double radius)
java.util.Collection<MapItem>	deepFindItems(GeoPoint location, double radius, java.util.Map<java.lang.String,java.lang.String> metadata) Find map items within a given area
java.util.Collection<MapItem>	deepFindItems(GeoPoint location, double radius, java.lang.String key, java.lang.String value)
java.util.List<MapItem>	deepFindItems(java.lang.String key, java.lang.String value) Deep traverse the map group to find all items that matches search constraints.
static int	deepFindItemsWithMetaString(java.util.List<MapItem> outList, MapGroup group, java.util.Map<java.lang.String,java.lang.String> metadata) Finds all descendant items that match the specified metadata filter.
static int	deepFindItemsWithMetaString(java.util.List<MapItem> outList, MapGroup group, java.lang.String key, java.lang.String value) Finds all descendant items that match the specified metadata filter.
static MapItem	deepFindItemWithMetaString(MapGroup group, java.util.Map<java.lang.String,java.lang.String> metadata)
static MapItem	deepFindItemWithMetaString(MapGroup group, java.lang.String key, java.lang.String value)
static MapItem	deepFindItemWithSerialId(MapGroup group, long serialId)
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.
abstract boolean	deepForEachItem(MapGroup.MapItemsCallback cb)
MapItem	deepHitTest(int xpos, int ypos, GeoPoint point, MapView view) Perform a hit-test for map items
java.util.SortedSet<MapItem>	deepHitTestItems(int xpos, int ypos, GeoPoint point, MapView view) Perform a hit-test for map items
static boolean	deepMapItems(MapGroup group, MapGroup.MapItemsCallback func)
static int	deepMapItemsCount(MapGroup group)
static int	deepMapItemsCount(MapGroup group, MapGroup.MapItemsCallback func)
protected void	dispatchFriendlyNameChanged()
protected void	dispatchGroupAdded(MapGroup group) Invoked when a MapGroup is added
protected void	dispatchGroupRemoved(MapGroup group) Invoked when a MapGroup is removed
protected void	dispatchItemAdded(MapItem itemIface) Invoked when a MapItem is added
protected void	dispatchItemRemoved(MapItem itemIface) Invoked when a MapItem is removed
protected void	dispatchVisibleChanged()
MapItem	findClosestItem(GeoPoint location) Find the closest item to the geosptial point or an empty map if nothing is found.
MapItem	findClosestItem(GeoPoint location, double threshold) Finds the closest MapItem to the specified point, that falls within the specified threshold.
abstract 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	findClosestItem(GeoPoint location, double threshold, java.lang.String key, java.lang.String value)
MapItem	findClosestItem(GeoPoint location, java.util.Map<java.lang.String,java.lang.String> metadata)
MapItem	findClosestItem(GeoPoint location, java.lang.String key, java.lang.String value)
abstract MapItem	findItem(java.util.Map<java.lang.String,java.lang.String> metadata)
MapItem	findItem(java.lang.String key, java.lang.String value)
java.util.Collection<MapItem>	findItems(GeoPoint location, double radius) Finds all MapItems within the radius around the specified point.
abstract java.util.Collection<MapItem>	findItems(GeoPoint location, double radius, java.util.Map<java.lang.String,java.lang.String> metadata)
java.util.Collection<MapItem>	findItems(GeoPoint location, double radius, java.lang.String key, java.lang.String value)
abstract java.util.List<MapItem>	findItems(java.util.Map<java.lang.String,java.lang.String> metadata)
java.util.List<MapItem>	findItems(java.lang.String key, java.lang.String value)
static int	findItemsWithMetaString(java.util.List<MapItem> outList, MapGroup group, java.util.Map<java.lang.String,java.lang.String> metadata) Finds all child items that match the specified metadata filter.
static MapItem	findItemWithMetaString(MapGroup group, java.util.Map<java.lang.String,java.lang.String> metadata) Finds the first child item that match the specified metadata filter.
static MapItem	findItemWithMetaString(MapGroup group, java.lang.String key, java.lang.String value)
static MapItem	findItemWithMetaStringImpl(MapGroup group, java.util.Map<java.lang.String,java.lang.String> literal, java.util.Map<java.lang.String,java.lang.String> regex) Finds the first matching child item
static MapGroup	findMapGroup(MapGroup group, java.lang.String friendlyName)
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'.
abstract 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.
abstract MapGroup	getChildGroupById(long id)
abstract java.util.Collection<MapGroup>	getChildGroups()
abstract java.lang.String	getFriendlyName() Get the friendly name of the MapGroup
abstract int	getGroupCount() Get the number of child MapGroups
abstract MapItem	getItemById(long id)
abstract int	getItemCount() Get the number of MapItems in the group
abstract java.util.Collection<MapItem>	getItems()
java.util.Collection<MapItem>	getItemsRecursive() Get a flat list of all map items in the group hierarchy
MapGroup	getParentGroup() Get the parent MapGroup
static java.lang.String	getPath(MapGroup group)
long	getSerialId()
abstract boolean	getVisible()
protected boolean	hasItemListChangedListeners()
protected MapItem	hitTest(int xpos, int ypos, GeoPoint point, MapView view) Deprecated. This is now handled by the RootMapGroup via HitTestControl. Implementation will be kept intact until deprecation removal.
protected java.util.SortedSet<MapItem>	hitTestItems(int xpos, int ypos, GeoPoint point, MapView view) Deprecated. This is now handled by the RootMapGroup via HitTestControl. Implementation will be kept intact until deprecation removal.
static boolean	mapItems(MapGroup group, MapGroup.MapItemsCallback func)
static int	mapItemsCount(MapGroup group, MapGroup.MapItemsCallback func)
static boolean	matchItemWithMetaString(MapItem item, java.util.Map<java.lang.String,java.lang.String> metadata) Check if the specified item matches the metadata filter
static boolean	matchItemWithMetaString(MapItem item, java.util.Map<java.lang.String,java.lang.String> literal, java.util.Map<java.lang.String,java.lang.String> regex) Check if the map item matches the literal & regex expressions
static boolean	matchItemWithMetaString(MapItem item, java.lang.String key, java.lang.String value) Check if the specified item matches the key/value pair
protected void	onAddedNoSync(MapGroup newParent)
protected void	onRemovedNoSync()
boolean	removeGroup(MapGroup group) Remove a MapGroup if it belongs to this one.
protected abstract boolean	removeGroupImpl(MapGroup group, boolean referenceOnly) Implements group removal.
void	removeItem(MapItem item) Removes the given MapItem from this map group, if it is a member.
protected abstract boolean	removeItemImpl(MapItem item) Implementation for removing an item from a map group.
void	removeOnFriendlyNameChangedListener(MapGroup.OnFriendlyNameChangedListener l)
void	removeOnGroupListChangedListener(MapGroup.OnGroupListChangedListener listener) Remove a groupList listener
void	removeOnItemListChangedListener(MapGroup.OnItemListChangedListener listener) Add a itemList listener
void	removeOnVisibleChangedListener(MapGroup.OnVisibleChangedListener l)
java.util.Collection<HashtagContent>	search(java.util.Collection<java.lang.String> tags) Search for content based on tags
void	setDefaultZOrder(double zOrder) Set the default z-order for any items added to this group
abstract void	setFriendlyName(java.lang.String friendlyName)
abstract 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.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

Methods inherited from interface com.atakmap.android.maps.DeepMapItemQuery

deepFindItems, deepFindItems

Constructor Detail

MapGroup

public MapGroup()

Create an empty MapGroup with a new serial ID.

MapGroup

public MapGroup(MetaDataHolder metadata)

MapGroup

protected MapGroup(long serialId)

MapGroup

protected MapGroup(long serialId,
                   MetaDataHolder metadata)

Method Detail

getSerialId

public final long getSerialId()

clearItems

public abstract void clearItems()

clearGroups

public abstract void clearGroups()

setVisible

public abstract void setVisible(boolean visible)

setVisibleIgnoreChildren

public void setVisibleIgnoreChildren(boolean visible)

Set group visibility without modifying the visibility of children items

getVisible

public abstract boolean getVisible()

setDefaultZOrder

public void setDefaultZOrder(double zOrder)

Set the default z-order for any items added to this group

Parameters:

zOrder - Z-order or NaN to ignore

addOnGroupListChangedListener

public final void addOnGroupListChangedListener(MapGroup.OnGroupListChangedListener listener)

Add a groupList listener

Parameters:

listener - the listener

removeOnGroupListChangedListener

public final void removeOnGroupListChangedListener(MapGroup.OnGroupListChangedListener listener)

Remove a groupList listener

Parameters:

listener - the listener

getGroupCount

public abstract int getGroupCount()

Get the number of child MapGroups

Returns:

the number of child groups

removeGroup

public final boolean removeGroup(MapGroup group)

Remove a MapGroup if it belongs to this one. If the group has its permaGroup metadata set to true, it will remain a child BUT all of its child groups and items will be removed.

Parameters:

group - the MapGroup to remove

Returns:

true if group belonged and was removed

removeGroupImpl

protected abstract boolean removeGroupImpl(MapGroup group,
                                           boolean referenceOnly)

Implements group removal.

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 abstract MapGroup addGroup(MapGroup groupIface)

Add a MapGroup

Parameters:

groupIface - the MapGroup to add

addGroup

public abstract MapGroup addGroup()

Create and add a MapGroup

Returns:

the freshly created and added MapGroup

addGroup

public abstract MapGroup addGroup(java.lang.String friendlyName)

Create and add a MapGroup with a friendly display name

Parameters:

friendlyName - the friendly display name

Returns:

the freshly created and added MapGroup

addOnItemListChangedListener

public final void addOnItemListChangedListener(MapGroup.OnItemListChangedListener listener)

Add a itemList listener

Parameters:

listener - the listener

removeOnItemListChangedListener

public final void removeOnItemListChangedListener(MapGroup.OnItemListChangedListener listener)

Add a itemList listener

Parameters:

listener - the listener

getItemCount

public abstract int getItemCount()

Get the number of MapItems in the group

Returns:

the number of map items without counting any sub groups.

getParentGroup

public MapGroup getParentGroup()

Get the parent MapGroup

Returns:

null if is a root group or belongs to no group

addItem

public void addItem(MapItem item)

Add an item to the group. If the item exists in another group, remove it first.

Parameters:

item - the item to add

createMarker

public Marker createMarker(GeoPoint point,
                           java.lang.String uid)

Create a marker and specifically add it to the this group.

addItemImpl

protected abstract void addItemImpl(MapItem item)

Performs the actual addition of the item. The dispatchItemAdded(MapItem) method will be invoked immediately after this method returns.

Parameters:

item - The item to be added

findItem

public MapItem findItem(java.lang.String key,
                        java.lang.String value)

findItem

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

findItems

public java.util.List<MapItem> findItems(java.lang.String key,
                                         java.lang.String value)

findItems

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

deepFindUID

public MapItem deepFindUID(java.lang.String uid)

Stock implementation of searching for a UID.

deepFindItem

public MapItem deepFindItem(java.lang.String key,
                            java.lang.String value)

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

Parameters:

key - the key to seach on

value - the value for the key

Returns:

the first map item that contains the key specified with the matching value.

deepFindItem

public abstract 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.

Specified by:

deepFindItem in interface DeepMapItemQuery

Parameters:

metadata - the map of keys and values that need to be matched when searching for an item.

Returns:

the first map item that contains the all of the keys and values matched.

deepFindItems

public java.util.List<MapItem> deepFindItems(java.lang.String key,
                                             java.lang.String value)

Deep traverse the map group to find all items that matches search constraints.

Parameters:

key - the key to seach on

value - the value for the key

Returns:

the list of map items that contains the key specified with the matching value.

findClosestItem

public MapItem findClosestItem(GeoPoint location)

Find the closest item to the geosptial point or an empty map if nothing is found.

Parameters:

location - the point to search with.

findClosestItem

public MapItem findClosestItem(GeoPoint location,
                               java.lang.String key,
                               java.lang.String value)

findClosestItem

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

findClosestItem

public MapItem findClosestItem(GeoPoint location,
                               double threshold)

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

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:

findClosestItem

public MapItem findClosestItem(GeoPoint location,
                               double threshold,
                               java.lang.String key,
                               java.lang.String value)

findClosestItem

public abstract 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.

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.

metadata -

Returns:

deepFindClosestItem

public MapItem deepFindClosestItem(GeoPoint location)

deepFindClosestItem

public MapItem deepFindClosestItem(GeoPoint location,
                                   java.lang.String key,
                                   java.lang.String value)

deepFindClosestItem

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

deepFindClosestItem

public MapItem deepFindClosestItem(GeoPoint location,
                                   double threshold)

deepFindClosestItem

public MapItem deepFindClosestItem(GeoPoint location,
                                   double threshold,
                                   java.lang.String key,
                                   java.lang.String value)

deepFindClosestItem

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

Description copied from interface: DeepMapItemQuery

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

Specified by:

deepFindClosestItem in interface DeepMapItemQuery

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.

metadata - Extra query metadata

Returns:

Closest map item or null if none found

findItems

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

Finds all MapItems within the radius around the specified point.

Parameters:

location - The location

radius - The search threshold, in meters.

Returns:

the collection of map items that fall within the radius of the specified location.

findItems

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

findItems

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

deepFindItems

public java.util.Collection<MapItem> deepFindItems(GeoPoint location,
                                                   double radius)

deepFindItems

public java.util.Collection<MapItem> deepFindItems(GeoPoint location,
                                                   double radius,
                                                   java.lang.String key,
                                                   java.lang.String value)

deepFindItems

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

Description copied from interface: DeepMapItemQuery

Find map items within a given area

Specified by:

deepFindItems in interface DeepMapItemQuery

Parameters:

location - Geodetic location

radius - Radius in meters

metadata - Extra query metadata

Returns:

List of found map items or null if none found

hitTest

@Deprecated
protected MapItem hitTest(int xpos,
                                      int ypos,
                                      GeoPoint point,
                                      MapView view)

Deprecated. This is now handled by the RootMapGroup via HitTestControl. Implementation will be kept intact until deprecation removal.

hitTestItems

@Deprecated
protected java.util.SortedSet<MapItem> hitTestItems(int xpos,
                                                                int ypos,
                                                                GeoPoint point,
                                                                MapView view)

Deprecated. This is now handled by the RootMapGroup via HitTestControl. Implementation will be kept intact until deprecation removal.

deepHitTest

public MapItem deepHitTest(int xpos,
                           int ypos,
                           GeoPoint point,
                           MapView view)

Description copied from interface: DeepMapItemQuery

Perform a hit-test for map items

Specified by:

deepHitTest in interface DeepMapItemQuery

Parameters:

xpos - X-position

ypos - Y-position

point - Ppoint on the map that was touched

view - Map view

Returns:

Map item that was hit or null if none hit

deepHitTestItems

public java.util.SortedSet<MapItem> deepHitTestItems(int xpos,
                                                     int ypos,
                                                     GeoPoint point,
                                                     MapView view)

Description copied from interface: DeepMapItemQuery

Perform a hit-test for map items

Specified by:

deepHitTestItems in interface DeepMapItemQuery

Parameters:

xpos - X-position

ypos - Y-position

point - Ppoint on the map that was touched

view - Map view

Returns:

Map items that were hit or null if none hit

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.

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.

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

forEachItem

public abstract 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.

Parameters:

cb -

Returns:

deepForEachItem

public abstract boolean deepForEachItem(MapGroup.MapItemsCallback cb)

getFriendlyName

public abstract java.lang.String getFriendlyName()

Get the friendly name of the MapGroup

Returns:

setFriendlyName

public abstract void setFriendlyName(java.lang.String friendlyName)

dispatchItemAdded

protected final void dispatchItemAdded(MapItem itemIface)

Invoked when a MapItem is added

Parameters:

itemIface - the MapItem that was added

dispatchItemRemoved

protected void dispatchItemRemoved(MapItem itemIface)

Invoked when a MapItem is removed

Parameters:

itemIface - the MapItem that was removed

dispatchGroupAdded

protected final void dispatchGroupAdded(MapGroup group)

Invoked when a MapGroup is added

Parameters:

group - the MapGroup that was added

dispatchGroupRemoved

protected final void dispatchGroupRemoved(MapGroup group)

Invoked when a MapGroup is removed

Parameters:

group - the MapGroup that was removed

dispatchVisibleChanged

protected final void dispatchVisibleChanged()

dispatchFriendlyNameChanged

protected final void dispatchFriendlyNameChanged()

addOnVisibleChangedListener

public void addOnVisibleChangedListener(MapGroup.OnVisibleChangedListener l)

removeOnVisibleChangedListener

public final void removeOnVisibleChangedListener(MapGroup.OnVisibleChangedListener l)

addOnFriendlyNameChangedListener

public final void addOnFriendlyNameChangedListener(MapGroup.OnFriendlyNameChangedListener l)

removeOnFriendlyNameChangedListener

public final void removeOnFriendlyNameChangedListener(MapGroup.OnFriendlyNameChangedListener l)

onAddedNoSync

protected final void onAddedNoSync(MapGroup newParent)

onRemovedNoSync

protected final void onRemovedNoSync()

hasItemListChangedListeners

protected final boolean hasItemListChangedListeners()

removeItem

public final void removeItem(MapItem item)

Removes the given MapItem from this map group, if it is a member. If it was not a member, returns normally, without throwing an exception.

removeItemImpl

protected abstract boolean removeItemImpl(MapItem item)

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.

getChildGroups

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

getItems

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

getChildGroupById

public abstract MapGroup getChildGroupById(long id)

getItemById

public abstract MapItem getItemById(long id)

containsItem

public boolean containsItem(MapItem item)

getItemsRecursive

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

Get a flat list of all map items in the group hierarchy

Returns:

List of map items

search

public java.util.Collection<HashtagContent> search(java.util.Collection<java.lang.String> tags)

Description copied from interface: HashtagSearch

Search for content based on tags

Specified by:

search in interface HashtagSearch

Parameters:

tags - List of hashtags to search for

Returns:

List of matching content

deepFindItemWithMetaString

public static MapItem deepFindItemWithMetaString(MapGroup group,
                                                 java.lang.String key,
                                                 java.lang.String value)

getPath

public static java.lang.String getPath(MapGroup group)

deepFindItemWithMetaString

public static MapItem deepFindItemWithMetaString(MapGroup group,
                                                 java.util.Map<java.lang.String,java.lang.String> metadata)

findItemWithMetaString

public static MapItem findItemWithMetaString(MapGroup group,
                                             java.lang.String key,
                                             java.lang.String value)

findItemWithMetaString

public static MapItem findItemWithMetaString(MapGroup group,
                                             java.util.Map<java.lang.String,java.lang.String> metadata)

Finds the first child item that match the specified metadata filter. Metadata matching is case-insensitive; the asterisk ('*') character may be used as the wildcard.

Parameters:

group -

metadata -

Returns:

findItemWithMetaStringImpl

public static MapItem findItemWithMetaStringImpl(MapGroup group,
                                                 java.util.Map<java.lang.String,java.lang.String> literal,
                                                 java.util.Map<java.lang.String,java.lang.String> regex)

Finds the first matching child item

Parameters:

group -

literal -

regex -

Returns:

matchItemWithMetaString

public static boolean matchItemWithMetaString(MapItem item,
                                              java.lang.String key,
                                              java.lang.String value)

Check if the specified item matches the key/value pair

Parameters:

item -

key -

value -

Returns:

matchItemWithMetaString

public static boolean matchItemWithMetaString(MapItem item,
                                              java.util.Map<java.lang.String,java.lang.String> metadata)

Check if the specified item matches the metadata filter

Parameters:

item -

metadata -

Returns:

matchItemWithMetaString

public static boolean matchItemWithMetaString(MapItem item,
                                              java.util.Map<java.lang.String,java.lang.String> literal,
                                              java.util.Map<java.lang.String,java.lang.String> regex)

Check if the map item matches the literal & regex expressions

Parameters:

item -

literal -

regex -

Returns:

deepFindItemsWithMetaString

public static int deepFindItemsWithMetaString(java.util.List<MapItem> outList,
                                              MapGroup group,
                                              java.lang.String key,
                                              java.lang.String value)

Finds all descendant items that match the specified metadata filter. Metadata matching is case-insensitive; the asterisk ('*') character may be used as the wildcard.

Parameters:

outList -

group -

key -

Returns:

See Also:

findItemsWithMetaString(List, MapGroup, Map)

deepFindItemsWithMetaString

public static int deepFindItemsWithMetaString(java.util.List<MapItem> outList,
                                              MapGroup group,
                                              java.util.Map<java.lang.String,java.lang.String> metadata)

Finds all descendant items that match the specified metadata filter. Metadata matching is case-insensitive; the asterisk ('*') character may be used as the wildcard.

Parameters:

outList -

group -

metadata -

Returns:

See Also:

findItemsWithMetaString(List, MapGroup, Map)

findItemsWithMetaString

public static int findItemsWithMetaString(java.util.List<MapItem> outList,
                                          MapGroup group,
                                          java.util.Map<java.lang.String,java.lang.String> metadata)

Finds all child items that match the specified metadata filter. Metadata matching is case-insensitive; the asterisk ('*') character may be used as the wildcard.

Parameters:

outList -

group -

metadata -

Returns:

deepFindItemWithSerialId

public static MapItem deepFindItemWithSerialId(MapGroup group,
                                               long serialId)

deepFindGroupByNameDepthFirst

public static MapGroup deepFindGroupByNameDepthFirst(MapGroup group,
                                                     java.lang.String friendlyname)

deepFindGroupByNameBreadthFirst

public static MapGroup deepFindGroupByNameBreadthFirst(MapGroup group,
                                                       java.lang.String friendlyname)

deepFindGroupBySerialIdDepthFirst

public static MapGroup deepFindGroupBySerialIdDepthFirst(MapGroup group,
                                                         long serialId)

deepFindGroupBySerialIdBreadthFirst

public static MapGroup deepFindGroupBySerialIdBreadthFirst(MapGroup group,
                                                           long serialId)

mapItems

public static boolean mapItems(MapGroup group,
                               MapGroup.MapItemsCallback func)

deepMapItems

public static boolean deepMapItems(MapGroup group,
                                   MapGroup.MapItemsCallback func)

createMapGroupSerialId

public static long createMapGroupSerialId()

Returns a serial ID that across an invocation of ATAK that is unique against all other IDs returned by this method.

ALL IMPLEMENTERS OF MapGroup SHOULD DERIVE THEIR SERIAL ID USING THIS METHOD!

Returns:

mapItemsCount

public static int mapItemsCount(MapGroup group,
                                MapGroup.MapItemsCallback func)

deepMapItemsCount

public static int deepMapItemsCount(MapGroup group,
                                    MapGroup.MapItemsCallback func)

deepMapItemsCount

public static int deepMapItemsCount(MapGroup group)

findMapGroup

public static MapGroup findMapGroup(MapGroup group,
                                    java.lang.String friendlyName)