com.atakmap.android.missionpackage.export

Class MissionPackageExportMarshal

java.lang.Object

com.atakmap.android.hierarchy.HierarchyListFilter

com.atakmap.android.importexport.ExportMarshal

com.atakmap.android.missionpackage.export.MissionPackageExportMarshal

public class MissionPackageExportMarshal
extends ExportMarshal

Marshals Export instances to a mission package

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	MissionPackageExportMarshal.MapItemSet List of non-duplicate map items

Nested classes/interfaces inherited from class com.atakmap.android.importexport.ExportMarshal

ExportMarshal.Progress

Field Summary

Fields

Modifier and Type	Field and Description
protected android.content.Context	context
protected java.util.List<java.lang.String>	filepaths
static java.lang.String	IGNORE_IN_MP_KEY
protected java.util.List<java.lang.String>	mapItemUIDs
static android.text.InputFilter	NAME_FILTER

Fields inherited from class com.atakmap.android.importexport.ExportMarshal

progress

Fields inherited from class com.atakmap.android.hierarchy.HierarchyListFilter

sort

Constructor Summary

Constructors

Constructor and Description
MissionPackageExportMarshal(android.content.Context context)
MissionPackageExportMarshal(android.content.Context context, java.lang.Boolean incAtt)

Method Summary

Modifier and Type	Method and Description
boolean	acceptEntry(HierarchyListItem list) Test to allow user to enter this item's sub-list
static void	addGroupNameToAllow(java.lang.String groupName) The ability to add a group name to allow when considering what can be exported.
static void	addParentGroupNameToAllow(java.lang.String groupName) The ability to add a parent group name to allow when considering what can be exported.
protected void	beginMarshal(android.content.Context context, java.util.List<Exportable> exports) Begin the export, do not display progress dialog
protected void	cancelMarshal() Cancel the export e.g.
void	execute(java.util.List<Exportable> exports) Initiate export.
boolean	filterGroup(MapGroup group) Default implementation filters on the "Layer Outlines" group
boolean	filterItem(MapItem item) Default implementation filters non-Exportable and then defers to the ExportFilters
boolean	filterListItemImpl(HierarchyListItem item)
void	finalizeMarshal() Finalize the export, e.g.
protected void	findAssociatedItems(MapView mv, java.lang.String uid, MissionPackageExportMarshal.MapItemSet itemSet)
java.lang.String	getContentType() UI type and icon
int	getIconId()
java.lang.String	getMIMEType()
java.lang.Class<?>	getTargetClass() Target class this implementation exports to
boolean	isIncChildren()
boolean	marshal(java.util.Collection<Exportable> exports) Marshal or organize export for marshaling during finalize().
void	postMarshal() Will be invoked on UI thread, upon successful export
static void	removeGroupNameToAllow(java.lang.String groupName) The ability to remove a group name to allow when considering what can be exported.
static void	removeParentGroupNameToAllow(java.lang.String groupName) The ability to add a parent group name to allow when considering what can be exported.
void	setIncChildren(boolean incChildren)
void	setMissionPackageUID(java.lang.String uid)

Methods inherited from class com.atakmap.android.importexport.ExportMarshal

accept, addFilter, filterOverlay, getFilters, hasProgress, setProgress

Methods inherited from class com.atakmap.android.hierarchy.HierarchyListFilter

isDefaultFilter, toString

Methods inherited from class java.lang.Object

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

Field Detail

IGNORE_IN_MP_KEY

public static final java.lang.String IGNORE_IN_MP_KEY

See Also:

Constant Field Values

mapItemUIDs

protected final java.util.List<java.lang.String> mapItemUIDs

filepaths

protected final java.util.List<java.lang.String> filepaths

context

protected final android.content.Context context

NAME_FILTER

public static final android.text.InputFilter NAME_FILTER

Constructor Detail

MissionPackageExportMarshal

public MissionPackageExportMarshal(android.content.Context context,
                                   java.lang.Boolean incAtt)

MissionPackageExportMarshal

public MissionPackageExportMarshal(android.content.Context context)

Method Detail

addGroupNameToAllow

public static void addGroupNameToAllow(java.lang.String groupName)

The ability to add a group name to allow when considering what can be exported.

Parameters:

groupName - the groupName to add.

removeGroupNameToAllow

public static void removeGroupNameToAllow(java.lang.String groupName)

The ability to remove a group name to allow when considering what can be exported.

Parameters:

groupName - the groupName to remove.

addParentGroupNameToAllow

public static void addParentGroupNameToAllow(java.lang.String groupName)

The ability to add a parent group name to allow when considering what can be exported.

Parameters:

groupName - the groupName to add.

removeParentGroupNameToAllow

public static void removeParentGroupNameToAllow(java.lang.String groupName)

The ability to add a parent group name to allow when considering what can be exported.

Parameters:

groupName - the groupName to remove.

setMissionPackageUID

public void setMissionPackageUID(java.lang.String uid)

getTargetClass

public java.lang.Class<?> getTargetClass()

Description copied from class: ExportMarshal

Target class this implementation exports to

Specified by:

getTargetClass in class ExportMarshal

Returns:

isIncChildren

public boolean isIncChildren()

setIncChildren

public void setIncChildren(boolean incChildren)

execute

public void execute(java.util.List<Exportable> exports)
             throws java.io.IOException,
                    FormatNotSupportedException

Description copied from class: ExportMarshal

Initiate export. Provides implementations an opportunity to confirm the export with the user (on UI thread) prior to beginning export on background task If confirmed, implementations should invoke: beginMarshal

Specified by:

execute in class ExportMarshal

Throws:

java.io.IOException

FormatNotSupportedException

beginMarshal

protected void beginMarshal(android.content.Context context,
                            java.util.List<Exportable> exports)

Begin the export, do not display progress dialog

Overrides:

beginMarshal in class ExportMarshal

Parameters:

context - the context to use during the beginMarshal task

exports - the list of exportable items

marshal

public boolean marshal(java.util.Collection<Exportable> exports)
                throws java.io.IOException,
                       FormatNotSupportedException

Description copied from class: ExportMarshal

Marshal or organize export for marshaling during finalize(). Default pattern is for this to be invoked indirectly by ExportMarshalTask as a result of invoking confirm May be invoked on non-UI thread

Specified by:

marshal in class ExportMarshal

Returns:

Throws:

java.io.IOException

FormatNotSupportedException

findAssociatedItems

protected void findAssociatedItems(MapView mv,
                                   java.lang.String uid,
                                   MissionPackageExportMarshal.MapItemSet itemSet)

finalizeMarshal

public void finalizeMarshal()

Description copied from class: ExportMarshal

Finalize the export, e.g. close file handles or clean up other resources Default pattern is for this to be invoked indirectly by ExportMarshalTask as a result of invoking confirm May be invoked on non-UI thread

Specified by:

finalizeMarshal in class ExportMarshal

postMarshal

public void postMarshal()

Description copied from class: ExportMarshal

Will be invoked on UI thread, upon successful export

Specified by:

postMarshal in class ExportMarshal

cancelMarshal

protected void cancelMarshal()

Description copied from class: ExportMarshal

Cancel the export e.g. user pressed back button

Specified by:

cancelMarshal in class ExportMarshal

getContentType

public java.lang.String getContentType()

Description copied from class: ExportMarshal

UI type and icon

Specified by:

getContentType in class ExportMarshal

Returns:

getMIMEType

public java.lang.String getMIMEType()

Specified by:

getMIMEType in class ExportMarshal

getIconId

public int getIconId()

Specified by:

getIconId in class ExportMarshal

acceptEntry

public boolean acceptEntry(HierarchyListItem list)

Description copied from class: HierarchyListFilter

Test to allow user to enter this item's sub-list

Overrides:

acceptEntry in class HierarchyListFilter

Parameters:

list - List item

Returns:

True to allow entry into sub-list, false otherwise

filterListItemImpl

public boolean filterListItemImpl(HierarchyListItem item)

Overrides:

filterListItemImpl in class ExportMarshal

Returns:

true to filter (don't display) specified item

filterItem

public boolean filterItem(MapItem item)

Description copied from class: ExportMarshal

Default implementation filters non-Exportable and then defers to the ExportFilters

Overrides:

filterItem in class ExportMarshal

Returns:

true to filter (don't display) specified item

filterGroup

public boolean filterGroup(MapGroup group)

Description copied from class: ExportMarshal

Default implementation filters on the "Layer Outlines" group

Overrides:

filterGroup in class ExportMarshal

Returns:

true to filter (don't display) specified group