Package com.vividsolutions.wms

Class MapLayer

  • public class MapLayer
extends Object
    Represents a WMS Layer.
    Author:
    Chris Hodgson chodgson@refractions.net, Uwe Dalluege, uwe.dalluege@rzcn.haw-hamburg.de, Michael Michaud m.michael.michaud@orange.fr

    • Method Detail

      • getAllBoundingBoxList

        public List<BoundingBox> getAllBoundingBoxList()
        Returns:
        All BoundingBoxes If there is no BoundingBox for this MapLayer the parent-BoundingBox will be taken. [uwe dalluege]

      • getSubLayer

        public MapLayer getSubLayer​(int n)
        Returns the sub-layer at the specified index.
        Parameters:
        n - the index of the sub-layer to return
        Returns:
        the MapLayer sub-layer at the specified index

      • getSubLayerList

        public List<MapLayer> getSubLayerList()
        Gets a copy of the list of the sublayers of this layer.
        Returns:
        a copy of the Arraylist containing all the sub-layers of this layer

      • getLayerList

        public List<MapLayer> getLayerList()
        Returns a list of all the layers in order of a root-left-right traversal of the layer tree.
        Returns:
        a list of all the layers in order of a root-left-right traversal of the layer tree.

      • getTitle

        public String getTitle()
        Gets the title of this MapLayer. The title of a layer should be used for display purposes.
        Returns:
        the title of this Layer

      • getName

        public String getName()
        Gets the name of this Layer. The name of a layer is its 'back-end', ugly name, which generally shouldn't need to be used by others but is available anyway. Layers which do not have any data associated with them, such as container or grouping layers, might not have a name, in which case null will be returned.
        Returns:
        the name of the layer, or null if it doesn't have a name

      • getParent

        public MapLayer getParent()
        Gets the parent MapLayer of this MapLayer.
        Returns:
        the parent layer of this MapLayer, or null if the layer has no parent.

      • getBoundingBox

        public BoundingBox getBoundingBox()
        Gets the LatLonBoundingBox for this layer. If this layer doesn't have a LatLonBoundingBox specified, we recursively ask the parent layer for its bounding box. The WMS spec says that each layer should either have its own LatLonBoundingBox, or inherit one from its parent, so this recursive call should be successful. If not, null is returned. However, if a bounding box is returned, it will have the SRS string "LatLon". Note that the BoundingBox is not necessarily "tight".
        Returns:
        the BoundingBox for this layer, or null if the BBox is unknown

      • getBoundingBox

        public BoundingBox getBoundingBox​(String srs)
        Return the bounding box defined for this MapLayer in this SRS. If not found, the bounding box is searched in this Layer's children, then in its parents. If not found, return the whole earth in LonLat SRS.

      • getBoundingBox

        public static org.locationtech.jts.geom.Envelope getBoundingBox​(String srs,
                                                                MapLayer lyr,
                                                                org.locationtech.jts.geom.Envelope env)
        Return the envelope of this layer in the wished srs if a BoundingBox in this srs exists. Else if, layer's children are scanned recursively.

      • getLatLonBoundingBox

        public BoundingBox getLatLonBoundingBox()
        I think this name is better [uwe dalluege] Gets the LatLonBoundingBox for this layer. If this layer doesn't have a LatLonBoundingBox specified, we recursively ask the parent layer for its bounding box. The WMS spec says that each layer should either have its own LatLonBoundingBox, or inherit one from its parent, so this recursive call should be successful. If not, null is returned. However, if a bounding box is returned, it will have the SRS string "LatLon". Note that the BoundingBox is not necessarily "tight".
        Returns:
        the BoundingBox for this layer, or null if the BBox is unknown

      • getBoundingBoxList

        public List<BoundingBox> getBoundingBoxList()
        Gets the BoundingBoxList for this Layer
        Returns:
        the BoundingBoxList containing the BoundingBoxes

      • getSRSList

        public List<String> getSRSList()
        Returns a copy of the list of supported SRS's. Each SRS is a string in the format described by the WMS specification, such as "EPSG:1234".
        Returns:
        a copy of the list of supported SRS's

      • getFullSRSList

        public Collection<String> getFullSRSList()
        Returns:
        a list of the SRS list of this MapLayer and its ancestors

      • setSelectedStyle

        public void setSelectedStyle​(MapStyle selectedStyle)
        Sets the selected WMS layer style
        Parameters:
        selectedStyle - set the WMS Style for this MapLayer

      • getStyle

        public MapStyle getStyle​(String styleName)
        Gets the WMS layer style by name
        Parameters:
        styleName - name of the WMS layer style
        Returns:
        a MapStyle associated with this Layer

      • setSublayer

        public void setSublayer​(ArrayList<MapLayer> sublayer)
        Parameters:
        sublayer - WMS subLayers contained in this MapLayer

      • setStyles

        public void setStyles​(List<MapStyle> newStyles)
        Parameters:
        newStyles - WMS MapStyles to be associated to this MapLayer

      • toString

        public String toString()
        Returns a somewhat nicely-formatted string representing all of the details of this layer and its sub-layers (recursively).
        Overrides:
        toString in class Object
        Returns:
        a somewhat nicely-formatted string representing all of the details of this layer and its sub-layers (recursively).