com.atakmap.android.maps.tilesets.mobac

Class QueryLayers

java.lang.Object

com.atakmap.android.maps.tilesets.mobac.QueryLayers

Direct Known Subclasses:

WMSQueryLayers, WMTSQueryLayers

public abstract class QueryLayers
extends java.lang.Object

Class to query a web map server's GetCapabilities function and provide metadata about the layers it serves.

To use this class, first instantiate a new object, then call process(). If process() returns successfully, then metadata about the layers and the server itself may be queried using getLayers(), getServerName(), etc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryLayers.Style Class to encapsulate a layer style.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.net.URL	baseURL
protected java.lang.String	getMapURL
protected boolean	isProcessed
protected java.util.List<WebMapLayer>	layers
protected java.util.Set<java.lang.String>	mimeTypes
protected java.lang.String	serviceTitle

Constructor Summary

Constructors

Constructor and Description
QueryLayers()

Method Summary

Modifier and Type	Method and Description
java.net.URL	getBaseURL() Return the URL that this object was created with.
java.lang.String	getGetMapURL() Return the URL string that should be used for this map server's GetMap calls.
java.util.List<WebMapLayer>	getLayers() Return the list of layers provided by this map server.
java.util.Set<java.lang.String>	getMimeTypes() Return the list of map imagery formats this map server provides, in mime-type form (e.g.
java.lang.String	getServiceTitle() Return the human-readable title of this map server.
boolean	isProcessed() Returns true if process() has been called successfully.
abstract void	process() Actually perform the query of the map server.

Methods inherited from class java.lang.Object

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

Field Detail

serviceTitle

protected java.lang.String serviceTitle

layers

protected java.util.List<WebMapLayer> layers

mimeTypes

protected java.util.Set<java.lang.String> mimeTypes

getMapURL

protected java.lang.String getMapURL

baseURL

protected java.net.URL baseURL

isProcessed

protected boolean isProcessed

Constructor Detail

QueryLayers

public QueryLayers()

Method Detail

getBaseURL

public java.net.URL getBaseURL()

Return the URL that this object was created with.

getLayers

public java.util.List<WebMapLayer> getLayers()

Return the list of layers provided by this map server. Since Layer objects may contain children, this list may form a recursive tree structure. This method should only be called after a successful call to process().

getServiceTitle

public java.lang.String getServiceTitle()

Return the human-readable title of this map server.

getMimeTypes

public java.util.Set<java.lang.String> getMimeTypes()

Return the list of map imagery formats this map server provides, in mime-type form (e.g. "image/jpeg"). This method should only be called after a successful call to process().

getGetMapURL

public java.lang.String getGetMapURL()

Return the URL string that should be used for this map server's GetMap calls.

isProcessed

public boolean isProcessed()

Returns true if process() has been called successfully. Many functions on this class return undefined results if isProcessed() returns false.

process

public abstract void process()
                      throws java.io.IOException

Actually perform the query of the map server. An exception will be thrown in case of any failure. This function performs network access.

Throws:

java.io.IOException - in case of error.