com.atakmap.android.items

Class MapItemsDatabase

java.lang.Object

com.atakmap.android.items.MapItemsDatabase

public abstract class MapItemsDatabase
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MapItemsDatabase.ContentListener
static class	MapItemsDatabase.FilteredMetaDataHolderCursor<T extends MetaDataHolder>
static interface	MapItemsDatabase.MetaDataHolderCursor<T extends MetaDataHolder>

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set<MapItemsDatabase.ContentListener>	contentListeners

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MapItemsDatabase()

Method Summary

Modifier and Type	Method and Description
void	addContentListener(MapItemsDatabase.ContentListener l)
protected void	checkReadOnly()
abstract void	close()
double	computeDistance(MapItem databaseMapItem, GeoPoint point)
void	deleteChildGroups(long serialId)
protected abstract void	deleteChildGroupsImpl(long serialId) Deletes all child groups of a group.
void	deleteGroup(long serialId)
protected abstract void	deleteGroupImpl(long serialId) Deletes the specified group.
void	deleteItem(long serialId)
protected abstract void	deleteItemImpl(long serialId)
void	deleteItems(long parentGroupSerialId)
protected abstract void	deleteItemsImpl(long parentGroupSerialId) Deletes all items for a specified group; not recursive.
protected void	dispatchContentChanged()
protected void	dispatchContentChangedNoSync()
abstract MapGroup	getGroup(long serialId) Returns the group with the specified serial ID.
abstract MapItemsDatabase.MetaDataHolderCursor<MapGroup>	getGroups(long parentGroupSerialId) Returns the child groups of the specified group.
abstract boolean	getGroupVisible(long serialId) Returns the visible property of the specified group.
abstract MapItem	getItem(long serialId)
abstract MapGroup	getParentGroup(long childSerialId) Returns the parent group of the specified group.
MapGroup	insertGroup(long parentSerialId, java.lang.String friendlyName, boolean rootGroup)
void	insertGroup(MapGroup groupToAdd, boolean rootGroup)
protected abstract MapGroup	insertGroupImpl(long parentSerialId, java.lang.String friendlyName, boolean rootGroup) Inserts the specified group.
protected abstract void	insertGroupImpl(MapGroup groupToAdd, boolean rootGroup) Inserts the specified group.
void	insertItem(long parentGroupSerialId, MapItem item)
protected abstract void	insertItemImpl(long parentGroupSerialId, MapItem item) Insert the specified item into the specified group.
abstract boolean	isReadOnly() Returns a flag indicating whether or not the database is read-only.
MapItem	queryClosestItem(long parentGroupSerialId, boolean recurse, GeoPoint location, double mapScale, java.util.Map<java.lang.String,java.lang.String> metadata, boolean visibleOnly) Finds the item closest to the specified point.
MapItemsDatabase.MetaDataHolderCursor<MapItem>	queryItems(GeoPoint upperLeft, GeoPoint lowerRight, double mapScale)
MapItemsDatabase.MetaDataHolderCursor<MapItem>	queryItems(GeoPoint upperLeft, GeoPoint lowerRight, double mapScale, boolean visibleOnly)
MapItemsDatabase.MetaDataHolderCursor<MapItem>	queryItems(GeoPoint upperLeft, GeoPoint lowerRight, double mapScale, java.util.Map<java.lang.String,java.lang.String> metadata)
MapItemsDatabase.MetaDataHolderCursor<MapItem>	queryItems(GeoPoint upperLeft, GeoPoint lowerRight, double mapScale, java.util.Map<java.lang.String,java.lang.String> metadata, boolean visibleOnly)
MapItemsDatabase.MetaDataHolderCursor<MapItem>	queryItems(GeoPoint upperLeft, GeoPoint lowerRight, double mapScale, java.lang.String key, java.lang.String value)
MapItemsDatabase.MetaDataHolderCursor<MapItem>	queryItems(GeoPoint upperLeft, GeoPoint lowerRight, double mapScale, java.lang.String key, java.lang.String value, boolean visibleOnly)
MapItemsDatabase.MetaDataHolderCursor<MapItem>	queryItems(GeoPoint upperLeft, GeoPoint lowerRight, java.util.Map<java.lang.String,java.lang.String> metadata)
MapItemsDatabase.MetaDataHolderCursor<MapItem>	queryItems(GeoPoint upperLeft, GeoPoint lowerRight, java.util.Map<java.lang.String,java.lang.String> metadata, boolean visibleOnly)
MapItemsDatabase.MetaDataHolderCursor<MapItem>	queryItems(GeoPoint upperLeft, GeoPoint lowerRight, java.lang.String key, java.lang.String value)
MapItemsDatabase.MetaDataHolderCursor<MapItem>	queryItems(GeoPoint upperLeft, GeoPoint lowerRight, java.lang.String key, java.lang.String value, boolean visibleOnly)
MapItemsDatabase.MetaDataHolderCursor<MapItem>	queryItems(long parentGroupSerialId, boolean recurse, GeoPoint center, double radius, double mapScale, java.util.Map<java.lang.String,java.lang.String> metadata, boolean visibleOnly)
MapItemsDatabase.MetaDataHolderCursor<MapItem>	queryItems(long parentGroupSerialId, boolean recurse, GeoPoint upperLeft, GeoPoint lowerRight, double mapScale, java.util.Map<java.lang.String,java.lang.String> metadata, boolean visibleOnly)
MapItemsDatabase.MetaDataHolderCursor<MapItem>	queryItems(java.util.Map<java.lang.String,java.lang.String> metadata)
MapItemsDatabase.MetaDataHolderCursor<MapItem>	queryItems(java.util.Map<java.lang.String,java.lang.String> metadata, boolean visibleOnly)
MapItemsDatabase.MetaDataHolderCursor<MapItem>	queryItems(java.lang.String key, java.lang.String value)
MapItemsDatabase.MetaDataHolderCursor<MapItem>	queryItems(java.lang.String key, java.lang.String value, boolean visibleOnly)
protected MapItemsDatabase.MetaDataHolderCursor<MapItem>	queryItemsImpl(long parentGroupSerialId, boolean recurse, GeoPoint center, double radius, double mapScale, java.util.Map<java.lang.String,java.lang.String> metadata, boolean visibleOnly) Queries items about a point within a specified radius.
protected abstract MapItemsDatabase.MetaDataHolderCursor<MapItem>	queryItemsImpl(long parentGroupSerialId, boolean recurse, GeoPoint upperLeft, GeoPoint lowerRight, double mapScale, java.util.Map<java.lang.String,java.lang.String> metadata, boolean visibleOnly)
void	removeContentListener(MapItemsDatabase.ContentListener l)
protected abstract void	updateGroup(long serialId, boolean visible) Updates the visibility property of a group.
void	updateGroup(long serialId, java.lang.String friendlyName)
protected abstract void	updateGroupImpl(long serialId, java.lang.String friendlyName) Updates the friendly name of a group.

Methods inherited from class java.lang.Object

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

Field Detail

contentListeners

protected final java.util.Set<MapItemsDatabase.ContentListener> contentListeners

Constructor Detail

MapItemsDatabase

protected MapItemsDatabase()

Method Detail

close

public abstract void close()

isReadOnly

public abstract boolean isReadOnly()

Returns a flag indicating whether or not the database is read-only.

Returns:

true if the database is read-only, false otherwise.

checkReadOnly

protected void checkReadOnly()

getGroup

public abstract MapGroup getGroup(long serialId)

Returns the group with the specified serial ID.

Parameters:

serialId - The serial ID of the group.

Returns:

The group with the specified serial ID or null in the case that no group with that serial ID is present.

getGroups

public abstract MapItemsDatabase.MetaDataHolderCursor<MapGroup> getGroups(long parentGroupSerialId)

Returns the child groups of the specified group. If 0 is specified, the root groups available from the database are returned.

Parameters:

parentGroupSerialId - The serial ID of a group. If 0 is specified, the root groups available from this database are returned.

Returns:

The child groups (immediate descendants) of the specified group.

getParentGroup

public abstract MapGroup getParentGroup(long childSerialId)

Returns the parent group of the specified group.

Parameters:

childSerialId - The group serial ID

Returns:

The parent of the specified group or null if the specified group does not have a parent.

getGroupVisible

public abstract boolean getGroupVisible(long serialId)

Returns the visible property of the specified group.

Parameters:

serialId - The group serial ID

Returns:

The visible property of the specified group.

insertGroup

public void insertGroup(MapGroup groupToAdd,
                        boolean rootGroup)

insertGroupImpl

protected abstract void insertGroupImpl(MapGroup groupToAdd,
                                        boolean rootGroup)

Inserts the specified group. The parent that the group should be added to can be derived by invoking MapGroup.getParentGroup() on groupToAdd.

Parameters:

groupToAdd - The group to be added.

insertGroup

public MapGroup insertGroup(long parentSerialId,
                            java.lang.String friendlyName,
                            boolean rootGroup)

insertGroupImpl

protected abstract MapGroup insertGroupImpl(long parentSerialId,
                                            java.lang.String friendlyName,
                                            boolean rootGroup)

Inserts the specified group.

Parameters:

parentSerialId - The serial ID for the parent that the new group will be added to

friendlyName - The friendly name of the new group

Returns:

The group that was newly added.

deleteChildGroups

public void deleteChildGroups(long serialId)

deleteChildGroupsImpl

protected abstract void deleteChildGroupsImpl(long serialId)

Deletes all child groups of a group.

Parameters:

serialId - The group serial ID.

deleteGroup

public void deleteGroup(long serialId)

deleteGroupImpl

protected abstract void deleteGroupImpl(long serialId)

Deletes the specified group. All subgroups and items will also be deleted.

Parameters:

serialId - The serial ID of the group

updateGroup

public void updateGroup(long serialId,
                        java.lang.String friendlyName)

updateGroupImpl

protected abstract void updateGroupImpl(long serialId,
                                        java.lang.String friendlyName)

Updates the friendly name of a group.

Parameters:

serialId - The group serial ID

friendlyName - The new friendly name for the group.

updateGroup

protected abstract void updateGroup(long serialId,
                                    boolean visible)

Updates the visibility property of a group.

Parameters:

serialId - The group serial ID

visible - The new value for the visible state of the group.

insertItem

public void insertItem(long parentGroupSerialId,
                       MapItem item)

insertItemImpl

protected abstract void insertItemImpl(long parentGroupSerialId,
                                       MapItem item)

Insert the specified item into the specified group.

Parameters:

parentGroupSerialId - The serial ID of the parent group for the item.

item - The item to be inserted.

deleteItems

public void deleteItems(long parentGroupSerialId)

deleteItem

public void deleteItem(long serialId)

deleteItemsImpl

protected abstract void deleteItemsImpl(long parentGroupSerialId)

Deletes all items for a specified group; not recursive.

Parameters:

parentGroupSerialId - The group serial ID

deleteItemImpl

protected abstract void deleteItemImpl(long serialId)

Parameters:

serialId - Item serial ID

getItem

public abstract MapItem getItem(long serialId)

Parameters:

serialId - The item serial ID

Returns:

The item with the associated serial ID

queryItems

public MapItemsDatabase.MetaDataHolderCursor<MapItem> queryItems(java.lang.String key,
                                                                 java.lang.String value)

queryItems

public MapItemsDatabase.MetaDataHolderCursor<MapItem> queryItems(java.lang.String key,
                                                                 java.lang.String value,
                                                                 boolean visibleOnly)

queryItems

public MapItemsDatabase.MetaDataHolderCursor<MapItem> queryItems(java.util.Map<java.lang.String,java.lang.String> metadata)

queryItems

public MapItemsDatabase.MetaDataHolderCursor<MapItem> queryItems(java.util.Map<java.lang.String,java.lang.String> metadata,
                                                                 boolean visibleOnly)

queryItems

public MapItemsDatabase.MetaDataHolderCursor<MapItem> queryItems(GeoPoint upperLeft,
                                                                 GeoPoint lowerRight,
                                                                 java.lang.String key,
                                                                 java.lang.String value)

queryItems

public MapItemsDatabase.MetaDataHolderCursor<MapItem> queryItems(GeoPoint upperLeft,
                                                                 GeoPoint lowerRight,
                                                                 java.lang.String key,
                                                                 java.lang.String value,
                                                                 boolean visibleOnly)

queryItems

public MapItemsDatabase.MetaDataHolderCursor<MapItem> queryItems(GeoPoint upperLeft,
                                                                 GeoPoint lowerRight,
                                                                 java.util.Map<java.lang.String,java.lang.String> metadata)

queryItems

public MapItemsDatabase.MetaDataHolderCursor<MapItem> queryItems(GeoPoint upperLeft,
                                                                 GeoPoint lowerRight,
                                                                 java.util.Map<java.lang.String,java.lang.String> metadata,
                                                                 boolean visibleOnly)

queryItems

public MapItemsDatabase.MetaDataHolderCursor<MapItem> queryItems(GeoPoint upperLeft,
                                                                 GeoPoint lowerRight,
                                                                 double mapScale)

queryItems

public MapItemsDatabase.MetaDataHolderCursor<MapItem> queryItems(GeoPoint upperLeft,
                                                                 GeoPoint lowerRight,
                                                                 double mapScale,
                                                                 boolean visibleOnly)

queryItems

public MapItemsDatabase.MetaDataHolderCursor<MapItem> queryItems(GeoPoint upperLeft,
                                                                 GeoPoint lowerRight,
                                                                 double mapScale,
                                                                 java.lang.String key,
                                                                 java.lang.String value)

queryItems

public MapItemsDatabase.MetaDataHolderCursor<MapItem> queryItems(GeoPoint upperLeft,
                                                                 GeoPoint lowerRight,
                                                                 double mapScale,
                                                                 java.lang.String key,
                                                                 java.lang.String value,
                                                                 boolean visibleOnly)

queryItems

public MapItemsDatabase.MetaDataHolderCursor<MapItem> queryItems(GeoPoint upperLeft,
                                                                 GeoPoint lowerRight,
                                                                 double mapScale,
                                                                 java.util.Map<java.lang.String,java.lang.String> metadata)

queryItems

public MapItemsDatabase.MetaDataHolderCursor<MapItem> queryItems(GeoPoint upperLeft,
                                                                 GeoPoint lowerRight,
                                                                 double mapScale,
                                                                 java.util.Map<java.lang.String,java.lang.String> metadata,
                                                                 boolean visibleOnly)

queryItems

public MapItemsDatabase.MetaDataHolderCursor<MapItem> queryItems(long parentGroupSerialId,
                                                                 boolean recurse,
                                                                 GeoPoint upperLeft,
                                                                 GeoPoint lowerRight,
                                                                 double mapScale,
                                                                 java.util.Map<java.lang.String,java.lang.String> metadata,
                                                                 boolean visibleOnly)

queryItems

public MapItemsDatabase.MetaDataHolderCursor<MapItem> queryItems(long parentGroupSerialId,
                                                                 boolean recurse,
                                                                 GeoPoint center,
                                                                 double radius,
                                                                 double mapScale,
                                                                 java.util.Map<java.lang.String,java.lang.String> metadata,
                                                                 boolean visibleOnly)

queryItemsImpl

protected abstract MapItemsDatabase.MetaDataHolderCursor<MapItem> queryItemsImpl(long parentGroupSerialId,
                                                                                 boolean recurse,
                                                                                 GeoPoint upperLeft,
                                                                                 GeoPoint lowerRight,
                                                                                 double mapScale,
                                                                                 java.util.Map<java.lang.String,java.lang.String> metadata,
                                                                                 boolean visibleOnly)

Parameters:

parentGroupSerialId - The serial ID for the top-most group to include in the query. If 0 is specified, a deep search over all groups may be performed by specifying recurse as true

recurse - true to perform a recursive query, false to limit only to the specified group.

upperLeft - The upper-left bound of the region of interest for the query. If both upperLeft and lowerRight are null, the query will not be restricted to a geographic extent.

lowerRight - The lower-right bound of the region of interest for the query. If both upperLeft and lowerRight are null, the query will not be restricted to a geographic extent.

mapScale - The map scale for the query. Only items that should be displayed at the specified scale should be included in the results. If specified as Double.NaN, the query should not be constrained by scale.

metadata - The metadata for the query. If non-empty, only items with matching metadata should be included in the results.

visibleOnly - If true only items that are currently visible should be included in the results.

Returns:

The query result.

queryItemsImpl

protected MapItemsDatabase.MetaDataHolderCursor<MapItem> queryItemsImpl(long parentGroupSerialId,
                                                                        boolean recurse,
                                                                        GeoPoint center,
                                                                        double radius,
                                                                        double mapScale,
                                                                        java.util.Map<java.lang.String,java.lang.String> metadata,
                                                                        boolean visibleOnly)

Queries items about a point within a specified radius.

The default implementation performs a query about a radius by performing a bounding box query and excluding all results with a distance greater than radius from center. This method relies on the implementations of computeDistance(MapItem, GeoPoint). The default implementation is inefficient and should be replaced as the underlying database allows.

Parameters:

parentGroupSerialId - The serial ID for the top-most group to include in the query. If 0 is specified, a deep search over all groups may be performed by specifying recurse as true

recurse - true to perform a recursive query, false to limit only to the specified group.

center - The center point for the query's region of interest. May not be null.

radius - The radius of the query's region of interest specified in meters.

mapScale - The map scale for the query. Only items that should be displayed at the specified scale should be included in the results. If specified as Double.NaN, the query should not be constrained by scale.

metadata - The metadata for the query. If non-empty, only items with matching metadata should be included in the results.

visibleOnly - If true only items that are currently visible should be included in the results.

Returns:

The query result.

queryClosestItem

public MapItem queryClosestItem(long parentGroupSerialId,
                                boolean recurse,
                                GeoPoint location,
                                double mapScale,
                                java.util.Map<java.lang.String,java.lang.String> metadata,
                                boolean visibleOnly)

Finds the item closest to the specified point. The default implementation performs a brute-force search.

Parameters:

parentGroupSerialId - The serial ID for the top-most group to include in the query. If 0 is specified, a deep search over all groups may be performed by specifying recurse as true

recurse - true to perform a recursive query, false to limit only to the specified group.

location - The location for the query. May not be' null.

mapScale - The map scale for the query. Only items that should be displayed at the specified scale should be included in the results. If specified as Double.NaN, the query should not be constrained by scale.

metadata - The metadata for the query. If non-empty, only items with matching metadata should be included in the results.

visibleOnly - If true only items that are currently visible should be included in the results.

Returns:

The query result.

computeDistance

public double computeDistance(MapItem databaseMapItem,
                              GeoPoint point)

addContentListener

public void addContentListener(MapItemsDatabase.ContentListener l)

removeContentListener

public void removeContentListener(MapItemsDatabase.ContentListener l)

dispatchContentChanged

protected void dispatchContentChanged()

dispatchContentChangedNoSync

protected void dispatchContentChangedNoSync()