com.atakmap.android.importexport

Class ExportMarshal

java.lang.Object

com.atakmap.android.hierarchy.HierarchyListFilter

com.atakmap.android.importexport.ExportMarshal

Direct Known Subclasses:

ExportFileMarshal, MissionPackageExportMarshal

public abstract class ExportMarshal
extends HierarchyListFilter

Interface responsible for marshaling data based on MIME Type. Provides progress dialog and worker thread pattern, at the cost of some interface complexity. Also provides support for UI and late-binding export filtering Pattern: 1) Invoker initiates export by invoking execute. Implementations may confirm or collect additional information from the user 2) execute then invokes beginMarshal. Default implementation simply launches a worker thread to handle the marshaling (see ExportMarshalTask) 3) ExportMarshalTask displays a progress dialog while worker thread is busy 4) ExportMarshalTask invokes marshal on the worker thread to export the user specified data 5) ExportMarshalTask invokes finalizeMarshal on the worker thread to complete the exports 6) ExportMarshalTask invokes postMarshal on the UI thread. Implementations may notify the user of export completion

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ExportMarshal.Progress Interface for callback during export

Field Summary

Fields

Modifier and Type	Field and Description
protected ExportMarshal.Progress	progress Optional progress callback

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

sort

Constructor Summary

Constructors

Constructor and Description
ExportMarshal()

Method Summary

Modifier and Type	Method and Description
boolean	accept(HierarchyListItem item) Return true if item should be shown in the UI, otherwise item will be hidden
void	addFilter(ExportFilter filter)
protected void	beginMarshal(android.content.Context context, java.util.List<Exportable> exports) Begin the export.
protected abstract void	cancelMarshal() Cancel the export e.g.
abstract 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)
boolean	filterOverlay(MapOverlay overlay) Default implementation display 4 top level affiliations
protected abstract void	finalizeMarshal() Finalize the export, e.g.
abstract java.lang.String	getContentType() UI type and icon
ExportFilters	getFilters()
abstract int	getIconId()
abstract java.lang.String	getMIMEType()
abstract java.lang.Class<?>	getTargetClass() Target class this implementation exports to
boolean	hasProgress()
protected abstract boolean	marshal(java.util.Collection<Exportable> exports) Marshal or organize export for marshaling during finalize().
protected abstract void	postMarshal() Will be invoked on UI thread, upon successful export
void	setProgress(ExportMarshal.Progress progress)

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

acceptEntry, isDefaultFilter, toString

Methods inherited from class java.lang.Object

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

Field Detail

progress

protected ExportMarshal.Progress progress

Optional progress callback

Constructor Detail

ExportMarshal

public ExportMarshal()

Method Detail

hasProgress

public boolean hasProgress()

setProgress

public void setProgress(ExportMarshal.Progress progress)

getFilters

public ExportFilters getFilters()

addFilter

public void addFilter(ExportFilter filter)

getTargetClass

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

Target class this implementation exports to

Returns:

getContentType

public abstract java.lang.String getContentType()

UI type and icon

Returns:

getMIMEType

public abstract java.lang.String getMIMEType()

getIconId

public abstract int getIconId()

accept

public boolean accept(HierarchyListItem item)

Return true if item should be shown in the UI, otherwise item will be hidden

Overrides:

accept in class HierarchyListFilter

Parameters:

item -

Returns:

filterListItemImpl

public boolean filterListItemImpl(HierarchyListItem item)

Parameters:

item -

Returns:

true to filter (don't display) specified item

filterItem

public boolean filterItem(MapItem item)

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

Parameters:

item -

Returns:

true to filter (don't display) specified item

filterGroup

public boolean filterGroup(MapGroup group)

Default implementation filters on the "Layer Outlines" group

Parameters:

group -

Returns:

true to filter (don't display) specified group

filterOverlay

public boolean filterOverlay(MapOverlay overlay)

Default implementation display 4 top level affiliations

Parameters:

overlay -

Returns:

true to filter (don't display) specified overlay

execute

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

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

Parameters:

exports -

Throws:

java.io.IOException

FormatNotSupportedException

beginMarshal

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

Begin the export. Default implementations does so on a background task

Parameters:

context -

exports -

marshal

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

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

Parameters:

exports -

Returns:

Throws:

java.io.IOException

FormatNotSupportedException

finalizeMarshal

protected abstract void finalizeMarshal()
                                 throws java.io.IOException

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

Throws:

java.io.IOException

postMarshal

protected abstract void postMarshal()

Will be invoked on UI thread, upon successful export

cancelMarshal

protected abstract void cancelMarshal()

Cancel the export e.g. user pressed back button