com.atakmap.android.contact

Class IndividualContact

java.lang.Object

com.atakmap.android.hierarchy.items.AbstractHierarchyListItem2

com.atakmap.android.contact.Contact

com.atakmap.android.contact.IndividualContact

All Implemented Interfaces:

HashtagSearch, HierarchyListItem, HierarchyListItem2, MapItemUser

Direct Known Subclasses:

TadilJContact

public class IndividualContact
extends Contact
implements MapItemUser

Nested Class Summary

Nested classes/interfaces inherited from class com.atakmap.android.contact.Contact

Contact.UpdateStatus

Nested classes/interfaces inherited from interface com.atakmap.android.hierarchy.HierarchyListItem

HierarchyListItem.ComparatorSort, HierarchyListItem.Sort, HierarchyListItem.SortAlphabet, HierarchyListItem.SortAlphabetDesc, HierarchyListItem.SortDistanceFrom

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.HashMap<java.lang.String,Connector>	connectors
static java.lang.String	DEFAULT_CONNECTOR

Fields inherited from class com.atakmap.android.contact.Contact

BACKGROUND_COLOR_ALIVE, BACKGROUND_COLOR_DEAD, BACKGROUND_COLOR_NA, BACKGROUND_COLOR_STALE, contactUUID, FOREGROUND_COLOR_ALIVE, FOREGROUND_COLOR_DEAD, FOREGROUND_COLOR_STALE

Fields inherited from class com.atakmap.android.hierarchy.items.AbstractHierarchyListItem2

asyncRefresh, children, disposed, filter, listener, postFilter, reusable, uiHandler

Constructor Summary

Constructors

Constructor and Description
IndividualContact(java.lang.String name)
IndividualContact(java.lang.String name, java.lang.String uuid)
IndividualContact(java.lang.String name, java.lang.String uuid, MapItem assocItem)
IndividualContact(java.lang.String name, java.lang.String uuid, MapItem assocItem, NetConnectString ncs) ctor
IndividualContact(java.lang.String name, java.lang.String uuid, NetConnectString ncs)

Method Summary

Modifier and Type	Method and Description
boolean	addConnector(Connector connector) Add or update connector of the specified type
void	current() Set status to CURRENT
void	die() Set status to DEAD
java.util.List<java.lang.String[]>	findChildPaths(java.lang.String uid) Find the path to the child contact UID to this contact
int	getBackgroundColor() Get the color of the contact view background
Connector	getConnector(java.lang.String type) Get connector of the specified type
java.util.Collection<Connector>	getConnectors(boolean bUserOnly) Get unmodifiable collection of connectors
AvatarFeature	getDefaultAvatar() Get default avatar Currently takes first avatar from any connector profile TODO build avatar inherent to TAK?
Connector	getDefaultConnector(android.content.SharedPreferences prefs) Get the default connector for this contact, in this order: 1) Check if only a single connector available, if so use it 2) Last user selected connector 3) Use highest priority connector available
ActionBroadcastData	getDefaultProfile() Get default profile intent First checks if there is an associated marker (e.g.
java.util.List<Contact>	getFiltered(boolean online, boolean incParents) Return a complete list of filtered contacts This includes descendant contacts
java.lang.String[]	getHierarchyPath() Get the path to this contact as a string array Form is [name1, uid1, name2, uid2, ..., nameN, uidN] This is used specifically for CoT events
int	getIconColor() Returns the color to be applied to the icon.
java.lang.String	getIconUri() Returns the URI for the icon for the node.
MapItem	getMapItem()
java.lang.String	getParentUID() Return the UID of this contact's parent For individual contacts this is "Root"
java.lang.Integer	getPresenceColor() Get color of presence indicator, or null if not applicable
static java.lang.Integer	getPresenceColor(Contact.UpdateStatus status)
java.lang.String	getServerFrom() Get the preferred connection string for this contact i.e.
int	getUnreadCount()
int	getUnreadCount(Connector connector)
boolean	hasConnector(java.lang.String type) Check if contact has the specified connector type
boolean	hasLocation()
boolean	hasProfile()
boolean	hideIfEmpty() Count towards parent children if this item's children is empty
boolean	isChildSupported() Check if list item can contain children
boolean	isVisible()
boolean	onSelected(android.content.SharedPreferences prefs) If location is available, zoom to it Otherwise initiate default comms
protected void	refreshImpl() Refresh implementation to be run on a background thread If your class doesn't need to refresh then override the filter method above to avoid unnecessary threading
Connector	removeConnector(java.lang.String type) Remove the specified connector type
void	setMapItem(MapItem mi)
void	setName(java.lang.String name) Set the display name of the contact
void	setParentUID(java.lang.String uid) Set the parent UID of this contact For groups, should typically let addContact handle this
void	stale() Set status to STALE
java.lang.String	toString()
boolean	zoom()

Methods inherited from class com.atakmap.android.contact.Contact

descendedFrom, dispatchChangeEvent, dispose, getAction, getChildContacts, getDescendantCount, getExtras, getExtraView, getFilteredUIDs, getName, getParent, getParentContacts, getParentHierarchy, getTextColor, getTitle, getUID, getUpdateStatus, getUserObject, notifyListener, refresh, refresh, setDispatch, setExtras, setListener, setUid, setUnreadCount, setUpdateStatus, updateChildren, validChild

Methods inherited from class com.atakmap.android.hierarchy.items.AbstractHierarchyListItem2

async, buildQueryParams, delete, disposeChildren, disposeItems, find, findChild, getAssociationKey, getChildActions, getChildAt, getChildCount, getChildren, getCustomLayout, getDefaultSortModes, getDeleteActions, getDescription, getDropDownSize, getExtraView, getFilter, getFooterView, getHeaderView, getIconDrawable, getListItemView, getLocalData, getLocalData, getPreferredListIndex, getSorts, getVisibility, isDisposed, isGetChildrenSupported, isMultiSelectSupported, notifyListener, postAccept, postRefresh, refresh, refresh, refresh, requestRefresh, requestRefresh, search, setLocalData, setPostFilter, setVisible, sortItems, syncRefresh

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONNECTOR

public static final java.lang.String DEFAULT_CONNECTOR

See Also:

Constant Field Values

connectors

protected final java.util.HashMap<java.lang.String,Connector> connectors

Constructor Detail

IndividualContact

public IndividualContact(java.lang.String name)

IndividualContact

public IndividualContact(java.lang.String name,
                         java.lang.String uuid)

IndividualContact

public IndividualContact(java.lang.String name,
                         java.lang.String uuid,
                         MapItem assocItem)

IndividualContact

public IndividualContact(java.lang.String name,
                         java.lang.String uuid,
                         NetConnectString ncs)

IndividualContact

public IndividualContact(java.lang.String name,
                         java.lang.String uuid,
                         MapItem assocItem,
                         NetConnectString ncs)

ctor

Parameters:

name - the name of the contact

uuid - the unique identifier for the contact

assocItem - if there is an associated map item

ncs - if provided, connectors are added: IpConnector, GeoChatConnector, MissionPackageConnector

Method Detail

setName

public void setName(java.lang.String name)

Description copied from class: Contact

Set the display name of the contact

Overrides:

setName in class Contact

Parameters:

name - Display name

getParentUID

public java.lang.String getParentUID()

Description copied from class: Contact

Return the UID of this contact's parent For individual contacts this is "Root"

Overrides:

getParentUID in class Contact

Returns:

Parent UID

setParentUID

public void setParentUID(java.lang.String uid)

Description copied from class: Contact

Set the parent UID of this contact For groups, should typically let addContact handle this

Overrides:

setParentUID in class Contact

Parameters:

uid - Parent UID

getHierarchyPath

public java.lang.String[] getHierarchyPath()

Description copied from class: Contact

Get the path to this contact as a string array Form is [name1, uid1, name2, uid2, ..., nameN, uidN] This is used specifically for CoT events

Overrides:

getHierarchyPath in class Contact

Returns:

String array of names and UIDs

findChildPaths

public java.util.List<java.lang.String[]> findChildPaths(java.lang.String uid)

Description copied from class: Contact

Find the path to the child contact UID to this contact

Overrides:

findChildPaths in class Contact

Parameters:

uid - Child contact UID

Returns:

The full path to the child contact, or null if not found

getFiltered

public java.util.List<Contact> getFiltered(boolean online,
                                           boolean incParents)

Description copied from class: Contact

Return a complete list of filtered contacts This includes descendant contacts

Overrides:

getFiltered in class Contact

Parameters:

online - True to only include valid (online) contacts

incParents - True to include contacts that are members of any parent groups

Returns:

List of filtered contacts

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

addConnector

public boolean addConnector(Connector connector)

Add or update connector of the specified type

Parameters:

connector -

Returns:

true if added or updated

getDefaultConnector

public Connector getDefaultConnector(android.content.SharedPreferences prefs)

Get the default connector for this contact, in this order: 1) Check if only a single connector available, if so use it 2) Last user selected connector 3) Use highest priority connector available

Returns:

getConnector

public Connector getConnector(java.lang.String type)

Get connector of the specified type

Parameters:

type -

Returns:

connector, or null if none found for the specified type

getConnectors

public java.util.Collection<Connector> getConnectors(boolean bUserOnly)

Get unmodifiable collection of connectors

Parameters:

bUserOnly - true to get only user selectable connectors

Returns:

hasConnector

public boolean hasConnector(java.lang.String type)

Check if contact has the specified connector type

Parameters:

type -

Returns:

removeConnector

public Connector removeConnector(java.lang.String type)

Remove the specified connector type

Parameters:

type -

Returns:

getServerFrom

public java.lang.String getServerFrom()

Get the preferred connection string for this contact i.e. if we're connected over WiFi, use null if we're ONLY connected over TAK server, use the TAK server

Returns:

Preferred connection string

current

public void current()

Set status to CURRENT

stale

public void stale()

Set status to STALE

die

public void die()

Set status to DEAD

getBackgroundColor

public int getBackgroundColor()

Description copied from class: Contact

Get the color of the contact view background

Overrides:

getBackgroundColor in class Contact

Returns:

Color as integer (gray by default)

getPresenceColor

public java.lang.Integer getPresenceColor()

Description copied from class: Contact

Get color of presence indicator, or null if not applicable

Overrides:

getPresenceColor in class Contact

Returns:

the integer representing the color of the presence indicator

getPresenceColor

public static java.lang.Integer getPresenceColor(Contact.UpdateStatus status)

getIconUri

public java.lang.String getIconUri()

Description copied from interface: HierarchyListItem

Returns the URI for the icon for the node.

Specified by:

getIconUri in interface HierarchyListItem

Overrides:

getIconUri in class AbstractHierarchyListItem2

Returns:

The URI for the icon for the node, null if the node has no icon, or "gone" to remove the icon space entirely.

getIconColor

public int getIconColor()

Description copied from interface: HierarchyListItem

Returns the color to be applied to the icon.

Specified by:

getIconColor in interface HierarchyListItem

Overrides:

getIconColor in class AbstractHierarchyListItem2

Returns:

The color to be applied to the icon, return 0xFFFFFFFF (-1) to use the original color.

getMapItem

public MapItem getMapItem()

Specified by:

getMapItem in interface MapItemUser

setMapItem

public void setMapItem(MapItem mi)

isVisible

public boolean isVisible()

Overrides:

isVisible in class AbstractHierarchyListItem2

isChildSupported

public boolean isChildSupported()

Description copied from interface: HierarchyListItem

Check if list item can contain children

Specified by:

isChildSupported in interface HierarchyListItem

Overrides:

isChildSupported in class AbstractHierarchyListItem2

Returns:

refreshImpl

protected void refreshImpl()

Description copied from class: AbstractHierarchyListItem2

Refresh implementation to be run on a background thread If your class doesn't need to refresh then override the filter method above to avoid unnecessary threading

Specified by:

refreshImpl in class AbstractHierarchyListItem2

hideIfEmpty

public boolean hideIfEmpty()

Description copied from interface: HierarchyListItem2

Count towards parent children if this item's children is empty

Specified by:

hideIfEmpty in interface HierarchyListItem2

Returns:

True to hide, false to always show

getDefaultAvatar

public AvatarFeature getDefaultAvatar()

Get default avatar Currently takes first avatar from any connector profile TODO build avatar inherent to TAK?

Returns:

getDefaultProfile

public ActionBroadcastData getDefaultProfile()

Get default profile intent First checks if there is an associated marker (e.g. a TAK user), then takes first profile from any connector

Returns:

hasProfile

public boolean hasProfile()

getUnreadCount

public int getUnreadCount()

Overrides:

getUnreadCount in class Contact

getUnreadCount

public int getUnreadCount(Connector connector)

hasLocation

public boolean hasLocation()

onSelected

public boolean onSelected(android.content.SharedPreferences prefs)

If location is available, zoom to it Otherwise initiate default comms

Parameters:

prefs -

Returns:

zoom

public boolean zoom()