com.atakmap.android.icons

Class UserIcon

java.lang.Object

com.atakmap.android.icons.UserIcon

public class UserIcon
extends java.lang.Object

Icon may be loaded from XML and or SQLite

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IconsetPath Iconset path is 3-tuple formatted as: //
static java.lang.String[][]	META_DATA_LABELS

Constructor Summary

Constructors

Constructor and Description
UserIcon() Default Constructor
UserIcon(int id, java.lang.String iconsetUid, java.lang.String group, java.lang.String fileName, java.lang.String cotType, android.graphics.Bitmap bitmap, int usecnt)

Method Summary

Modifier and Type	Method and Description
static android.graphics.Bitmap	decodeBitMap(byte[] blob)
boolean	equals(java.lang.Object rhs)
java.lang.String	get2525cType()
android.graphics.Bitmap	getBitMap()
java.lang.String	getFileName()
java.lang.Object	getFromMetaDataLabel(java.lang.String label)
java.lang.String	getGroup()
static UserIcon	GetIcon(java.lang.String query, boolean bBitmap, android.content.Context context) Get Bitmap based on query created via GetIconBitmapQuery
static android.graphics.Bitmap	GetIconBitmap(java.lang.String queryUri, android.content.Context context) Get Bitmap based on query created via GetIconBitmapQuery
java.lang.String	getIconBitmapQuery()
static java.lang.String	GetIconBitmapQuery(int id) Create an optimized query based on id (indexed primary key), query only returns "bitmap" column
static java.lang.String	GetIconBitmapQueryFromIconsetPath(java.lang.String iconsetPath, android.content.Context context) Lookup icon and create an optimzed bitmap query
static byte[]	GetIconBytes(java.lang.String queryUri, android.content.Context context) Get Bitmap based on query created via GetIconBitmapQuery
static UserIcon	GetIconFromIconsetPath(java.lang.String iconsetPath, boolean bBitmap, android.content.Context context) Lookup icon based on iconset
static int	GetIconID(java.lang.String query) Get icon ID based on query created via GetIconBitmapQuery
java.lang.String	getIconsetPath() Get iconset path uniquely describing this icon
static java.lang.String	GetIconsetPath(java.lang.String iconsetUid, java.lang.String group, java.lang.String fileName)
java.lang.String	getIconsetUid()
int	getId()
static MapGroup	GetOrAddSubGroup(MapGroup group, java.lang.String iconsetPath, android.content.Context context) Get subgroup for the specified iconset path
int	getUseCount()
int	hashCode()
boolean	isValid()
static boolean	IsValidIconsetPath(java.lang.String iconsetPath, boolean requireDatabaseMatch, android.content.Context context) Check if iconset is well-formed and references an icon currently stored on this device.
static boolean	IsValidIconsetPath(java.lang.String iconsetPath, android.content.Context context) Check if iconset is well-formed and references an icon currently stored on this device.
void	set2525cType(java.lang.String t)
void	setBitMap(android.graphics.Bitmap bitMap)
void	setFileName(java.lang.String fileName)
void	setGroup(java.lang.String group)
static void	setGroupIcon(MapGroup group, java.lang.String groupFilter, android.content.Context context)
void	setIconsetUid(java.lang.String uid)
void	setId(int id)
void	setUseCount(int useCnt)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

IconsetPath

public static final java.lang.String IconsetPath

Iconset path is 3-tuple formatted as: //

See Also:

Constant Field Values

META_DATA_LABELS

public static final java.lang.String[][] META_DATA_LABELS

Constructor Detail

UserIcon

public UserIcon()

Default Constructor

UserIcon

public UserIcon(int id,
                java.lang.String iconsetUid,
                java.lang.String group,
                java.lang.String fileName,
                java.lang.String cotType,
                android.graphics.Bitmap bitmap,
                int usecnt)

Method Detail

IsValidIconsetPath

public static boolean IsValidIconsetPath(java.lang.String iconsetPath,
                                         boolean requireDatabaseMatch,
                                         android.content.Context context)

Check if iconset is well-formed and references an icon currently stored on this device. Note returns false for 2525C and Spot Map iconset paths

Parameters:

iconsetPath -

requireDatabaseMatch -

Returns:

IsValidIconsetPath

public static boolean IsValidIconsetPath(java.lang.String iconsetPath,
                                         android.content.Context context)

Check if iconset is well-formed and references an icon currently stored on this device. Note returns false for 2525C and Spot Map iconset paths. Also returns false if the icon is not currently in the local database

Parameters:

iconsetPath -

Returns:

getFromMetaDataLabel

public java.lang.Object getFromMetaDataLabel(java.lang.String label)

getId

public int getId()

setId

public void setId(int id)

getIconsetUid

public java.lang.String getIconsetUid()

setIconsetUid

public void setIconsetUid(java.lang.String uid)

getFileName

public java.lang.String getFileName()

setFileName

public void setFileName(java.lang.String fileName)

get2525cType

public java.lang.String get2525cType()

set2525cType

public void set2525cType(java.lang.String t)

getBitMap

public android.graphics.Bitmap getBitMap()

setBitMap

public void setBitMap(android.graphics.Bitmap bitMap)

getUseCount

public int getUseCount()

setUseCount

public void setUseCount(int useCnt)

getGroup

public java.lang.String getGroup()

setGroup

public void setGroup(java.lang.String group)

isValid

public boolean isValid()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object rhs)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getIconBitmapQuery

public java.lang.String getIconBitmapQuery()

GetIconBitmapQuery

public static java.lang.String GetIconBitmapQuery(int id)

Create an optimized query based on id (indexed primary key), query only returns "bitmap" column

Parameters:

id -

Returns:

getIconsetPath

public java.lang.String getIconsetPath()

Get iconset path uniquely describing this icon

Returns:

the iconset path

GetIconsetPath

public static java.lang.String GetIconsetPath(java.lang.String iconsetUid,
                                              java.lang.String group,
                                              java.lang.String fileName)

GetIconFromIconsetPath

public static UserIcon GetIconFromIconsetPath(java.lang.String iconsetPath,
                                              boolean bBitmap,
                                              android.content.Context context)

Lookup icon based on iconset

Parameters:

iconsetPath - the iconset path that describes a iconset icon starting with the uuid for the iconset and then the path.

bBitmap - if the bitmap is required in the return

Returns:

the bitmap if the iconset is found, otherwise null.

GetIconBitmapQueryFromIconsetPath

public static java.lang.String GetIconBitmapQueryFromIconsetPath(java.lang.String iconsetPath,
                                                                 android.content.Context context)

Lookup icon and create an optimzed bitmap query

Parameters:

iconsetPath - the iconset path that describes a iconset icon starting with the uuid for the iconset and then the path.

context - to use when getting the UserIconDatabase

Returns:

the string that represents the query

GetOrAddSubGroup

public static MapGroup GetOrAddSubGroup(MapGroup group,
                                        java.lang.String iconsetPath,
                                        android.content.Context context)

Get subgroup for the specified iconset path

Parameters:

group -

iconsetPath -

context -

Returns:

setGroupIcon

public static void setGroupIcon(MapGroup group,
                                java.lang.String groupFilter,
                                android.content.Context context)

GetIconBytes

public static byte[] GetIconBytes(java.lang.String queryUri,
                                  android.content.Context context)

Get Bitmap based on query created via GetIconBitmapQuery

Parameters:

queryUri -

Returns:

GetIconBitmap

public static android.graphics.Bitmap GetIconBitmap(java.lang.String queryUri,
                                                    android.content.Context context)

Get Bitmap based on query created via GetIconBitmapQuery

Parameters:

queryUri - the uri to use for getting the bitmap.

Returns:

GetIconID

public static int GetIconID(java.lang.String query)

Get icon ID based on query created via GetIconBitmapQuery

Parameters:

query -

Returns:

-1 upon error

GetIcon

public static UserIcon GetIcon(java.lang.String query,
                               boolean bBitmap,
                               android.content.Context context)

Get Bitmap based on query created via GetIconBitmapQuery

Parameters:

query -

bBitmap -

Returns:

decodeBitMap

public static android.graphics.Bitmap decodeBitMap(byte[] blob)