com.atakmap.android.contact

Class GroupContact

java.lang.Object

com.atakmap.android.hierarchy.items.AbstractHierarchyListItem2

com.atakmap.android.contact.Contact

com.atakmap.android.contact.GroupContact

All Implemented Interfaces:

HashtagSearch, Action, Search, HierarchyListItem, HierarchyListItem2

Direct Known Subclasses:

RoleGroup, TeamGroup

public class GroupContact
extends Contact
implements Search

A group containing multiple contacts Custom group classes should extend off this

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GroupContact.OnGroupContactChangedListener

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.Map<java.lang.String,Contact>	_contacts
protected int	_filteredUnread
protected boolean	_hideIfEmpty
protected boolean	_hideLockedGroups
protected java.lang.String	_iconUri
protected int	_totalUnread
protected boolean	_unmodifiable
protected boolean	_userCreated
static java.lang.String	TAG

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
GroupContact(java.lang.String uid, java.lang.String callsign)
GroupContact(java.lang.String uid, java.lang.String callsign, boolean userCreated)
GroupContact(java.lang.String uid, java.lang.String callsign, java.util.List<Contact> contacts, boolean userCreated) A group that has a multiple endpoints.

Method Summary

Modifier and Type	Method and Description
void	addContact(Contact c)
void	addContacts(java.util.List<Contact> contacts) Add a list of contacts to the master (pre-filtered) list
void	addOnGroupContactChangedListener(GroupContact.OnGroupContactChangedListener listener) Adds a listener that is notified when there is a change to the group contact
boolean	alwaysShow()
int	calculateUnread() Calculate the total unread count for all items in this group hierarchy This does not depend on the result stored by refreshImpl
void	clearHierarchy() Clear this groups hierarchy without invalidating any contacts This is mainly used when building the group hierarchy
java.util.Set<HierarchyListItem>	find(java.lang.String terms)
java.util.List<java.lang.String[]>	findChildPaths(java.lang.String uid) Find the path to the child contact UID to this contact
protected void	fireOnGroupContactChanged()
java.util.List<Contact>	getAllContacts(boolean recursive) Get all contacts (no filtering) within this group
java.util.List<java.lang.String>	getAllContactUIDs(boolean recursive)
java.util.List<java.lang.String>	getContactUids()
android.view.View	getExtraView() Returns the extra view, if any, associated with the node.
java.lang.String	getIconUri() Returns the URI for the icon for the node.
java.util.List<java.lang.String>	getOnlineContactUids()
GroupContact	getRootUserGroup() Return the root user group that contains this group
boolean	getUnmodifiable() Return the modifiable state of this group
java.util.List<Contact>	getUnreadContacts()
java.util.List<Contact>	getUnreadContacts(boolean filtered) Get list of contacts under this group which contain unread messages
int	getUnreadCount()
int	getUnreadCount(boolean filtered) Count total unread messages within and under this group
java.util.List<IndividualContact>	getUsers()
java.util.List<IndividualContact>	getUsers(boolean recursive) Get all individual contacts within this group (no filtering)
java.util.List<java.lang.String>	getUserUIDs()
java.util.List<java.lang.String>	getUserUIDs(boolean recursive)
boolean	hasContact(Contact c, boolean recursive) Determine if this group contact has a contact or sub-contact.
boolean	hideIfEmpty() Count towards parent children if this item's children is empty
boolean	isChildSupported() Check if list item can contain children
boolean	isEmpty()
static boolean	isGroup(Contact c)
boolean	isUserCreated() Check if this group was created by the user
boolean	isVisible()
void	lockGroup(boolean lock)
void	lockGroups(boolean lock) Recursively set this group and all children groups to unmodifiable
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
void	removeAllUsers() Remove all individuals from this group and its sub-groups
void	removeContact(Contact c)
void	removeContacts(java.util.List<Contact> contacts) Remove list of contacts from the master list
void	removeOnGroupContactChangedListener(GroupContact.OnGroupContactChangedListener listener) Removes a listener that is notified when there is a change to the group contact
void	setContacts(java.util.List<Contact> contacts) Set the master (pre-filtered) contact list
void	setContactUIDs(java.util.List<java.lang.String> uids)
void	setHideIfEmpty(boolean hide)
void	setHideLockedGroups(boolean hide)
void	setIconUri(java.lang.String iconUri)
void	setUnmodifiable(boolean state) Set the modifiable state (locked/unlocked) of this group Locked means the user cannot chat within this group
java.lang.String	toString()
void	updateLocks() Update the group locks on every sub-group
protected boolean	validChild(HierarchyListItem item) Check if a child item is valid Assumes item is already part of this.children

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

descendedFrom, dispatchChangeEvent, dispose, getAction, getBackgroundColor, getChildContacts, getDescendantCount, getExtras, getFiltered, getFilteredUIDs, getHierarchyPath, getName, getParent, getParentContacts, getParentHierarchy, getParentUID, getPresenceColor, getTextColor, getTitle, getUID, getUpdateStatus, getUserObject, notifyListener, refresh, refresh, setDispatch, setExtras, setListener, setName, setParentUID, setUid, setUnreadCount, setUpdateStatus, updateChildren

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

async, buildQueryParams, delete, disposeChildren, disposeItems, findChild, getAssociationKey, getChildActions, getChildAt, getChildCount, getChildren, getCustomLayout, getDefaultSortModes, getDeleteActions, getDescription, getDropDownSize, getExtraView, getFilter, getFooterView, getHeaderView, getIconColor, 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

_contacts

protected final java.util.Map<java.lang.String,Contact> _contacts

_userCreated

protected boolean _userCreated

_unmodifiable

protected boolean _unmodifiable

_hideIfEmpty

protected boolean _hideIfEmpty

_hideLockedGroups

protected boolean _hideLockedGroups

_totalUnread

protected int _totalUnread

_filteredUnread

protected int _filteredUnread

_iconUri

protected java.lang.String _iconUri

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

Constructor Detail

GroupContact

public GroupContact(java.lang.String uid,
                    java.lang.String callsign,
                    java.util.List<Contact> contacts,
                    boolean userCreated)

A group that has a multiple endpoints.

Parameters:

uid - UID of group

callsign - Display name of group

contacts - List of contacts under this group

userCreated - True if the group was user-created

GroupContact

public GroupContact(java.lang.String uid,
                    java.lang.String callsign,
                    boolean userCreated)

GroupContact

public GroupContact(java.lang.String uid,
                    java.lang.String callsign)

Method Detail

getAllContacts

public java.util.List<Contact> getAllContacts(boolean recursive)

Get all contacts (no filtering) within this group

Parameters:

recursive - True to include descendant contacts False to only include direct children

Returns:

List of all contacts

getAllContactUIDs

public java.util.List<java.lang.String> getAllContactUIDs(boolean recursive)

hasContact

public boolean hasContact(Contact c,
                          boolean recursive)

Determine if this group contact has a contact or sub-contact.

Parameters:

c - the contact to search for

recursive - whether to traverse down sub group contacts

Returns:

boolean true if it contains the contact

getUsers

public java.util.List<IndividualContact> getUsers(boolean recursive)

Get all individual contacts within this group (no filtering)

Returns:

List of user contacts

getUsers

public java.util.List<IndividualContact> getUsers()

getUserUIDs

public java.util.List<java.lang.String> getUserUIDs(boolean recursive)

getUserUIDs

public java.util.List<java.lang.String> getUserUIDs()

getContactUids

public java.util.List<java.lang.String> getContactUids()

getOnlineContactUids

public java.util.List<java.lang.String> getOnlineContactUids()

setContacts

public void setContacts(java.util.List<Contact> contacts)

Set the master (pre-filtered) contact list

Parameters:

contacts - List of contacts

setContactUIDs

public void setContactUIDs(java.util.List<java.lang.String> uids)

isUserCreated

public boolean isUserCreated()

Check if this group was created by the user

Returns:

True if created locally, false if created automatically

setUnmodifiable

public void setUnmodifiable(boolean state)

Set the modifiable state (locked/unlocked) of this group Locked means the user cannot chat within this group

Parameters:

state - True to lock, false to unlock

lockGroup

public void lockGroup(boolean lock)

lockGroups

public void lockGroups(boolean lock)

Recursively set this group and all children groups to unmodifiable

Parameters:

lock - True to lock, false to unlock

updateLocks

public void updateLocks()

Update the group locks on every sub-group

getUnmodifiable

public boolean getUnmodifiable()

Return the modifiable state of this group

Returns:

True if the group is locked, false if unlocked

addContact

public void addContact(Contact c)

addContacts

public void addContacts(java.util.List<Contact> contacts)

Add a list of contacts to the master (pre-filtered) list

Parameters:

contacts - List of contacts

removeContact

public void removeContact(Contact c)

removeContacts

public void removeContacts(java.util.List<Contact> contacts)

Remove list of contacts from the master list

Parameters:

contacts - List of contacts

removeAllUsers

public void removeAllUsers()

Remove all individuals from this group and its sub-groups

getExtraView

public android.view.View getExtraView()

Description copied from interface: HierarchyListItem

Returns the extra view, if any, associated with the node. The extra view occupies the space to the right of the line item and can be defined as the developer sees fit. Clicks should be passed through so you can include simple stuff like text, or more interactive things like buttons or check boxes. Should occupy space nicely with range and bearing values if any are present. If no extra view is associated with the node, the space will be empty.

Specified by:

getExtraView in interface HierarchyListItem

Overrides:

getExtraView in class Contact

Returns:

The extra view associated with this node, or null if there is no view.

setIconUri

public void setIconUri(java.lang.String iconUri)

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.

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:

isVisible

public boolean isVisible()

Overrides:

isVisible in class AbstractHierarchyListItem2

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

setHideIfEmpty

public void setHideIfEmpty(boolean hide)

setHideLockedGroups

public void setHideLockedGroups(boolean hide)

alwaysShow

public boolean alwaysShow()

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

getUnreadCount

public int getUnreadCount(boolean filtered)

Count total unread messages within and under this group

Parameters:

filtered - True to only count filtered contacts

Returns:

Unread message count

getUnreadCount

public int getUnreadCount()

Overrides:

getUnreadCount in class Contact

calculateUnread

public int calculateUnread()

Calculate the total unread count for all items in this group hierarchy This does not depend on the result stored by refreshImpl

Returns:

Total unread count

getUnreadContacts

public java.util.List<Contact> getUnreadContacts(boolean filtered)

Get list of contacts under this group which contain unread messages

Parameters:

filtered - True to only count filtered contacts

Returns:

List of contacts with unread messages

getUnreadContacts

public java.util.List<Contact> getUnreadContacts()

getRootUserGroup

public GroupContact getRootUserGroup()

Return the root user group that contains this group

Returns:

The root user group, or null if not applicable

validChild

protected boolean validChild(HierarchyListItem item)

Description copied from class: Contact

Check if a child item is valid Assumes item is already part of this.children

Overrides:

validChild in class Contact

Parameters:

item - Item to test

Returns:

True if item is a valid contact

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

find

public java.util.Set<HierarchyListItem> find(java.lang.String terms)

Specified by:

find in interface Search

Overrides:

find in class AbstractHierarchyListItem2

clearHierarchy

public void clearHierarchy()

Clear this groups hierarchy without invalidating any contacts This is mainly used when building the group hierarchy

isEmpty

public boolean isEmpty()

isGroup

public static boolean isGroup(Contact c)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

addOnGroupContactChangedListener

public void addOnGroupContactChangedListener(GroupContact.OnGroupContactChangedListener listener)

Adds a listener that is notified when there is a change to the group contact

Parameters:

listener - the listener to be added.

removeOnGroupContactChangedListener

public void removeOnGroupContactChangedListener(GroupContact.OnGroupContactChangedListener listener)

Removes a listener that is notified when there is a change to the group contact

Parameters:

listener - the listener to be remove.

fireOnGroupContactChanged

protected void fireOnGroupContactChanged()