com.atakmap.android.importexport

Interface Marshal

All Known Subinterfaces:

CotEventMarshal

All Known Implementing Classes:

AbstractCotEventMarshal, AbstractMarshal, CotDeleteEventMarshal, ShapefileMarshal, WFSMarshal

public interface Marshal

Interface responsible for detecting the MIME type for data that represents a specified content.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getContentType() Returns the content type of the marshaled data.
int	getPriorityLevel() Returns the priority level of the marshal.
java.lang.String	marshal(java.io.InputStream inputStream, int probeSize) Analyzes the specified stream to determine if it contains the content associated with this Marshal.
java.lang.String	marshal(android.net.Uri uri) Analyzes the data at the specified Uri to determine if it contains the content associated with this Marshal.

Method Detail

getContentType

java.lang.String getContentType()

Returns the content type of the marshaled data.

Returns:

The content type of the marshaled data.

marshal

java.lang.String marshal(java.io.InputStream inputStream,
                         int probeSize)
                  throws java.io.IOException

Analyzes the specified stream to determine if it contains the content associated with this Marshal. If the stream does contain compatible content, the MIME type of the stream is returned, otherwise null is returned.

Only the number of bytes specified by probeSize may be read from the stream during analysis.

Parameters:

inputStream - A data stream

probeSize - The number of bytes that may be read from the stream

Returns:

The MIME type of the data if it contains the associated content, null otherwise.

Throws:

java.io.IOException - If an IO error occurs while reading data from the stream

marshal

java.lang.String marshal(android.net.Uri uri)
                  throws java.io.IOException

Analyzes the data at the specified Uri to determine if it contains the content associated with this Marshal. If the Uri does contain compatible content, the MIME type of the Uri is returned, otherwise null is returned.

Parameters:

uri - A URI

Returns:

The MIME type of the data if it contains the associated content, null otherwise.

Throws:

java.io.IOException - If an IO error occurs while reading data from the URI

getPriorityLevel

int getPriorityLevel()

Returns the priority level of the marshal. Marshals with higher priority levels are always invoked by the MarshalManager prior to marshals with lower priority levels.

The recommendation is that the priority level should increase when the content is identifiable through an increase in specificity for the data stream. For example, a Marshal that detects a stream as XML should return a priority level of 0. A Marshal that detects CoT should return a level of 1 and a Marshal that detects KML should return a level of 1 as both are direct derivatives of XML. A Marshal that detects a specific type of CoT should return a level of 2 to ensure it gets invoked prior to a generic CoT Marshal.

Returns:

The priority level