com.atakmap.android.maps.tilesets.mobac

Class WebMapLayer

java.lang.Object

com.atakmap.android.maps.tilesets.mobac.WebMapLayer

public abstract class WebMapLayer
extends java.lang.Object

Class to represent a map service layer. Layers have a name and a title; name is the programmatic name while title is the human-readable name. If a layer is not displayable, it will not have a name. isDisplayable() may also be called to determine if a layer is displayable. Layers may contain children, forming a recursive tree structure. Branch nodes in this tree may be displayable as layers in their own right, or they may be merely logical containers. SRIDs and Styles are inheritable from parent Layers. This inheritance is all handled by this class, so that a call to getStyles() or getSRIDs() will return all inherited items as well as the ones directly specified by the map server for this layer.

Field Summary

Fields

Modifier and Type	Field and Description
protected GeoBounds	bounds
protected java.util.List<WebMapLayer>	children
protected java.lang.String	name
protected WebMapLayer	parent
protected QueryLayers	queryLayer
protected java.util.Set<java.lang.Integer>	srids
protected java.util.Collection<QueryLayers.Style>	styles
protected java.lang.String	title

Constructor Summary

Constructors

Constructor and Description
WebMapLayer(java.lang.String name, java.lang.String title, QueryLayers queryLayer, GeoBounds bounds, java.util.Set<java.lang.Integer> srids, java.util.List<WebMapLayer> children, java.util.Collection<QueryLayers.Style> styles) Create a new Layer.

Method Summary

Modifier and Type	Method and Description
void	addToLayersDatabase(QueryLayers.Style style, android.content.Context context) Adds this map server layer to the LayersDatabase.
static void	addToLayersDatabase(Service service, android.content.Context ignored) Adds this map server layer to the LayersDatabase.
GeoBounds	getBounds() Returns this layer's bounds.
java.util.List<WebMapLayer>	getChildren() Return the list of child Layers.
protected static java.io.File	getDefaultXmlFile(java.lang.String title, ServiceType type)
java.lang.String	getName() Return the machine-usable name for this layer.
java.util.Set<java.lang.Integer>	getSRIDs() Return the list of SRIDs this layer supports.
java.util.Collection<QueryLayers.Style>	getStyles() Return the list of styles this layer supports.
java.lang.String	getTitle() Return the human-readable name of this layer.
boolean	isDisplayable() Indicates whether this layer is displayable in its own right.
void	setParent(WebMapLayer parent)
abstract java.io.File	writeMobacXML(QueryLayers.Style style)

Methods inherited from class java.lang.Object

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

Field Detail

queryLayer

protected final QueryLayers queryLayer

title

protected final java.lang.String title

name

protected final java.lang.String name

bounds

protected final GeoBounds bounds

srids

protected final java.util.Set<java.lang.Integer> srids

styles

protected final java.util.Collection<QueryLayers.Style> styles

parent

protected WebMapLayer parent

children

protected final java.util.List<WebMapLayer> children

Constructor Detail

WebMapLayer

public WebMapLayer(java.lang.String name,
                   java.lang.String title,
                   QueryLayers queryLayer,
                   GeoBounds bounds,
                   java.util.Set<java.lang.Integer> srids,
                   java.util.List<WebMapLayer> children,
                   java.util.Collection<QueryLayers.Style> styles)

Create a new Layer.

Method Detail

setParent

public void setParent(WebMapLayer parent)

getChildren

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

Return the list of child Layers.

getBounds

public GeoBounds getBounds()

Returns this layer's bounds. Bounds that were directly specified for this layer will be returned if present; otherwise the parent layer is queried for its bounds.

getStyles

public java.util.Collection<QueryLayers.Style> getStyles()

Return the list of styles this layer supports. Styles may be inherited from parent layers; any inherited styles will be returned in this collection. An empty collection may be returned if no styles were defined. (Note the WMS spec requires a style to be specified in GetMap calls, so a style name of "default" should be used in the case no styles are defined.)

getSRIDs

public java.util.Set<java.lang.Integer> getSRIDs()

Return the list of SRIDs this layer supports. SRIDs may be inherited from parent layers; any inherited styles will be returned in this set.

getTitle

public java.lang.String getTitle()

Return the human-readable name of this layer.

getName

public java.lang.String getName()

Return the machine-usable name for this layer. This is the name that must be provided in tile queries. Returns null if this layer is not displayable.

isDisplayable

public boolean isDisplayable()

Indicates whether this layer is displayable in its own right. If this method returns false, the layer is intended to be used as a logical container rather than a true layer.

addToLayersDatabase

public void addToLayersDatabase(QueryLayers.Style style,
                                android.content.Context context)
                         throws java.io.IOException

Adds this map server layer to the LayersDatabase. This will write out an XML file (see writeMobacXML()) to persist the layer across invocations of atak, and then add it to the LayersDatabase so it may be used for the current invocation. The 'style' argument defines which style is used to generate this layer.

Parameters:

style - the style with which this layer should be displayed

Throws:

java.io.IOException - in case of error

writeMobacXML

public abstract java.io.File writeMobacXML(QueryLayers.Style style)
                                    throws java.io.IOException

Throws:

java.io.IOException

getDefaultXmlFile

protected static java.io.File getDefaultXmlFile(java.lang.String title,
                                                ServiceType type)

addToLayersDatabase

public static void addToLayersDatabase(Service service,
                                       android.content.Context ignored)
                                throws java.io.IOException

Adds this map server layer to the LayersDatabase. This will write out an XML file (see writeMobacXML()) to persist the layer across invocations of atak, and then add it to the LayersDatabase so it may be used for the current invocation. The 'style' argument defines which style is used to generate this layer.

Throws:

java.io.IOException - in case of error