com.atakmap.android.chat

Class ChatDatabase

java.lang.Object

com.atakmap.android.chat.ChatDatabase

public class ChatDatabase
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TAG
static int	VERSION

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.Long>	addChat(android.os.Bundle chatMessage) Ability to take a correctly formatted Chat Bundle and add it to the ChatDatabase.
void	addGroup(GroupContact gc, boolean local)
java.util.List<java.lang.String>	getAvailableConversations() Obtain the list of conversation identifiers.
android.os.Bundle	getChatMessage(java.lang.String messageId) Given a specific message identifier, retrieve the chat message associated.
java.util.List<java.lang.String>	getGroupInfo(java.lang.String conversationId) Returns the group information for a specific conversation identifier.
java.util.List<android.os.Bundle>	getHistory(java.lang.String conversationId) Returns the history of a given conversation as a list of bundles.
static ChatDatabase	getInstance(android.content.Context ignored) Get an instance of the ChatDabase for search, retrieval and archive of chat messages.
android.os.Bundle	getMessage(long id, java.lang.String table) Given an id and a table, return the bundle for a specific message.
java.util.List<java.lang.String>	getPersistedConversationIds() Returns a list of the persisted conversation identifiers.
boolean	removeChatMessage(java.lang.String messageId) The ability to remove a chat message from the database given a message identifier.
void	removeGroup(java.lang.String conversationId)
static void	writeToFile(java.lang.String filename, java.util.List<java.util.List<java.lang.String>> resultTable) Given a results table, write the values to a file.

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

VERSION

public static final int VERSION

See Also:

Constant Field Values

Method Detail

getInstance

public static ChatDatabase getInstance(android.content.Context ignored)

Get an instance of the ChatDabase for search, retrieval and archive of chat messages.

Parameters:

ignored - no longer used.

Returns:

the singleton instance of the ChatDatabase.

addChat

public java.util.List<java.lang.Long> addChat(android.os.Bundle chatMessage)

Ability to take a correctly formatted Chat Bundle and add it to the ChatDatabase.

Parameters:

chatMessage - a bundle created from ChatMessage.toBundle() or a bundle containing the following keys - "conversationName", "conversationId", "messageId", "senderUid", "senderCallsign", "parent", "paths", "deleteChild", "groupOwner", "message", status

Returns:

a list of longs, but effectively a single row based on the Chat Message bundle.

addGroup

public void addGroup(GroupContact gc,
                     boolean local)

removeGroup

public void removeGroup(java.lang.String conversationId)

getHistory

public java.util.List<android.os.Bundle> getHistory(java.lang.String conversationId)

Returns the history of a given conversation as a list of bundles.

Parameters:

conversationId - the chat conversation identification

Returns:

return an array of bundles that represent each line in the chat history where the bundle is a representation of the cursor return.

getPersistedConversationIds

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

Returns a list of the persisted conversation identifiers.

Returns:

the conversaiton identifiers for the system that have been persisted.

getGroupInfo

public java.util.List<java.lang.String> getGroupInfo(java.lang.String conversationId)

Returns the group information for a specific conversation identifier.

Parameters:

conversationId - the conversationId

Returns:

the group informtion in list form.

getAvailableConversations

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

Obtain the list of conversation identifiers.

Returns:

the list of string identifiers.

getMessage

public android.os.Bundle getMessage(long id,
                                    java.lang.String table)

Given an id and a table, return the bundle for a specific message.

Parameters:

id - the given message id

table - the table to pull from

Returns:

the bundle that represents the message.

getChatMessage

public android.os.Bundle getChatMessage(java.lang.String messageId)

Given a specific message identifier, retrieve the chat message associated.

Parameters:

messageId - the messageId

Returns:

the bundle that represents the chat message.

removeChatMessage

public boolean removeChatMessage(java.lang.String messageId)

The ability to remove a chat message from the database given a message identifier.

Parameters:

messageId - the message identifier.

Returns:

true if the deletion was sucessfull, false if the deletion failed.

writeToFile

public static void writeToFile(java.lang.String filename,
                               java.util.List<java.util.List<java.lang.String>> resultTable)
                        throws java.io.IOException

Given a results table, write the values to a file.

Parameters:

filename - the filename to write to

resultTable - the results table

Throws:

java.io.IOException - error if the write failed.