com.atakmap.android.missionpackage.file

Class MissionPackageManifest

java.lang.Object

com.atakmap.android.missionpackage.file.MissionPackageManifest

All Implemented Interfaces:

android.os.Parcelable

public class MissionPackageManifest
extends java.lang.Object
implements android.os.Parcelable

Maintains current state of Mission Package being built by user. The Mission Package may or may not exist on the SD card, and may or may not match the current state of an instance of this class. Mission Package Tool allows multiple user edits to package before "saving" the changes, at which point the Mission Package .zip file on the SD is (re)created. Parcelable - can be passed via intents XML Serializable - can be stored to file as XML/string

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<MissionPackageManifest>	CREATOR
static long	MAP_ITEM_ESTIMATED_SIZE
static long	POINT_ESTIMATED_SIZE
static long	ROUTE_POINT_ESTIMATED_SIZE

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
MissionPackageManifest() ctor
MissionPackageManifest(MissionPackageManifest copy) copy ctor
MissionPackageManifest(java.lang.String name, java.lang.String dir) ctor
MissionPackageManifest(java.lang.String name, java.lang.String uid, java.lang.String dir)

Method Summary

Modifier and Type	Method and Description
boolean	addContent(MissionPackageContent content)
boolean	addFile(java.io.File file, java.lang.String attachedUID) Add specified file to the data package and optionally attach to a map item
boolean	addFile(java.io.File file, java.lang.String contentType, java.lang.String attachedUID) Add specified file to the data package and optionally attach to a map item
boolean	addMapItem(java.lang.String uid) Add Map Item to the Mission Package
boolean	addMapItems(java.lang.String... mapItemUIDArray) Add Map Items to the Mission Package
void	clear() Clear Map Items and Files
int	describeContents()
boolean	equals(MissionPackageManifest rhsc)
boolean	equals(java.lang.Object o)
static long	estimateMapItemSize(MapItem item) Estimate the size of a map item CoT message
static MissionPackageManifest	fromXml(java.lang.String xml, java.lang.String filePath)
static MissionPackageManifest	fromXml(java.lang.String xml, java.lang.String filePath, boolean calcSizes) Parse the specified Mission Package manifest XML to a manifest object
MissionPackageConfiguration	getConfiguration()
MissionPackageContents	getContents()
int	getCount()
int	getFileCount() Get number of files in the Mission Package
java.util.List<MissionPackageContent>	getFiles() Get list of file paths in the Mission Package
long	getFilesSize() Get total uncompressed size of files in the Mission Package
java.util.Collection<java.lang.String>	getHashtags()
java.lang.String	getLastSavedPath() Get last path the Mission Package was saved to
java.util.List<java.io.File>	getLocalFiles() Same as above but the actual list of files is returned, not metadata
long	getMapDataSize() Get uncompressed (or otherwise estimated) size of all Map Items in the Mission Package
int	getMapItemCount() Get number of Map Items in the Mission Package
java.util.List<MissionPackageContent>	getMapItems() Get list of UIDs for Map Items in the Mission Package
java.lang.String	getName() Get user provided name for the package
java.lang.String	getPath() Get path (including directory and filename)
java.lang.String	getRemarks() Get user provided remarks for the package
long	getTotalSize() Get total estimated uncompressed size of all contents in the Mission Package
java.lang.String	getUID() Get Unique ID (UUID)
int	getVersion() Get content listing version
boolean	hasFile(MissionPackageContent content) Check if the specified file is in the Mission Package
boolean	hasFiles() True if Mission Package has files
int	hashCode()
boolean	hasMapItems() True if Mission Package has Map Items
boolean	isEmpty() Empty if no Map Items and no Files
boolean	isValid()
boolean	pathExists()
boolean	removeContent(MissionPackageContent content)
boolean	removeFile(MissionPackageContent content) Remove file from the Mission Package
boolean	removeMapItem(MissionPackageListMapItem item) Remove Map Item from the Mission Package
void	setName(java.lang.String name) Set user provided name for the package
void	setName(java.lang.String name, java.lang.String dir) Set name and update path
void	setPath(java.lang.String path) Set path (including directory and filename)
void	setRemarks(java.lang.String remarks) Set user provided remarks for the package
java.lang.String	toString()
java.lang.String	toXml(boolean localManifest) Serialize the content listing out to String
void	writeToParcel(android.os.Parcel parcel, int flags)

Methods inherited from class java.lang.Object

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

Field Detail

MAP_ITEM_ESTIMATED_SIZE

public static final long MAP_ITEM_ESTIMATED_SIZE

See Also:

Constant Field Values

POINT_ESTIMATED_SIZE

public static final long POINT_ESTIMATED_SIZE

See Also:

Constant Field Values

ROUTE_POINT_ESTIMATED_SIZE

public static final long ROUTE_POINT_ESTIMATED_SIZE

See Also:

Constant Field Values

CREATOR

public static final android.os.Parcelable.Creator<MissionPackageManifest> CREATOR

Constructor Detail

MissionPackageManifest

public MissionPackageManifest()

ctor

MissionPackageManifest

public MissionPackageManifest(java.lang.String name,
                              java.lang.String dir)

ctor

Parameters:

name - Name of Mission Package

dir - Directory to store Mission Package

MissionPackageManifest

public MissionPackageManifest(java.lang.String name,
                              java.lang.String uid,
                              java.lang.String dir)

MissionPackageManifest

public MissionPackageManifest(MissionPackageManifest copy)

copy ctor

Parameters:

copy -

Method Detail

isValid

public boolean isValid()

getContents

public MissionPackageContents getContents()

getConfiguration

public MissionPackageConfiguration getConfiguration()

isEmpty

public boolean isEmpty()

Empty if no Map Items and no Files

Returns:

clear

public void clear()

Clear Map Items and Files

getUID

public java.lang.String getUID()

Get Unique ID (UUID)

Returns:

getName

public java.lang.String getName()

Get user provided name for the package

Returns:

setName

public void setName(java.lang.String name)

Set user provided name for the package

getRemarks

public java.lang.String getRemarks()

Get user provided remarks for the package

Returns:

setRemarks

public void setRemarks(java.lang.String remarks)

Set user provided remarks for the package

setName

public void setName(java.lang.String name,
                    java.lang.String dir)

Set name and update path

Parameters:

name -

dir -

getPath

public java.lang.String getPath()

Get path (including directory and filename)

Returns:

pathExists

public boolean pathExists()

setPath

public void setPath(java.lang.String path)

Set path (including directory and filename)

hasMapItems

public boolean hasMapItems()

True if Mission Package has Map Items

Returns:

hasFiles

public boolean hasFiles()

True if Mission Package has files

Returns:

getFileCount

public int getFileCount()

Get number of files in the Mission Package

Returns:

getFiles

public java.util.List<MissionPackageContent> getFiles()

Get list of file paths in the Mission Package

Returns:

getLocalFiles

public java.util.List<java.io.File> getLocalFiles()

Same as above but the actual list of files is returned, not metadata

Returns:

List of files

getMapItems

public java.util.List<MissionPackageContent> getMapItems()

Get list of UIDs for Map Items in the Mission Package

Returns:

getCount

public int getCount()

addFile

public boolean addFile(java.io.File file,
                       java.lang.String contentType,
                       java.lang.String attachedUID)

Add specified file to the data package and optionally attach to a map item

Parameters:

file - File to add

contentType - Content type of the file (null if N/A)

attachedUID - Map item UID (null if not an attachment)

Returns:

True if added

addFile

public boolean addFile(java.io.File file,
                       java.lang.String attachedUID)

Add specified file to the data package and optionally attach to a map item

Parameters:

file - File to add

attachedUID - Map item UID (null if not an attachment)

Returns:

True if added

addContent

public boolean addContent(MissionPackageContent content)

addMapItems

public boolean addMapItems(java.lang.String... mapItemUIDArray)

Add Map Items to the Mission Package

Parameters:

mapItemUIDArray -

Returns:

addMapItem

public boolean addMapItem(java.lang.String uid)

Add Map Item to the Mission Package

Parameters:

uid -

Returns:

removeContent

public boolean removeContent(MissionPackageContent content)

removeFile

public boolean removeFile(MissionPackageContent content)

Remove file from the Mission Package

Parameters:

content -

Returns:

hasFile

public boolean hasFile(MissionPackageContent content)

Check if the specified file is in the Mission Package

Parameters:

content -

Returns:

removeMapItem

public boolean removeMapItem(MissionPackageListMapItem item)

Remove Map Item from the Mission Package

Parameters:

item -

Returns:

getMapItemCount

public int getMapItemCount()

Get number of Map Items in the Mission Package

Returns:

getFilesSize

public long getFilesSize()

Get total uncompressed size of files in the Mission Package

Returns:

Size in bytes

getMapDataSize

public long getMapDataSize()

Get uncompressed (or otherwise estimated) size of all Map Items in the Mission Package

Returns:

Size in bytes

getTotalSize

public long getTotalSize()

Get total estimated uncompressed size of all contents in the Mission Package

Returns:

estimateMapItemSize

public static long estimateMapItemSize(MapItem item)

Estimate the size of a map item CoT message

Parameters:

item - Map item

Returns:

Size in bytes

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel parcel,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

toXml

public java.lang.String toXml(boolean localManifest)

Serialize the content listing out to String

Parameters:

localManifest - true for local manifest (extra data included), false for package manifest

Returns:

fromXml

public static MissionPackageManifest fromXml(java.lang.String xml,
                                             java.lang.String filePath,
                                             boolean calcSizes)

Parse the specified Mission Package manifest XML to a manifest object

Parameters:

xml - Manifest XML

filePath - Local file path of the Mission Package ZIP

calcSizes - True to calculate the compressed and uncompressed size of all content inside the manifest

Returns:

Mission Package manifest object

fromXml

public static MissionPackageManifest fromXml(java.lang.String xml,
                                             java.lang.String filePath)

getLastSavedPath

public java.lang.String getLastSavedPath()

Get last path the Mission Package was saved to

Returns:

getHashtags

public java.util.Collection<java.lang.String> getHashtags()

getVersion

public int getVersion()

Get content listing version

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

equals

public boolean equals(MissionPackageManifest rhsc)