Package com.esri.arcgisruntime.ogc.wms

Class WmsLayerInfo

  • public final class WmsLayerInfo
extends java.lang.Object
    Represents metadata for an individual layer in a Web Map Service (WMS).
    Since:
    100.2.0
    See Also:
    WmsServiceInfo

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDescription()
      Gets the description of the layer.
      Envelope getExtent()
      Gets the extent of the layer.
      int getFixedImageHeight()
      Gets the fixed height of maps the service can produce for this layer, or 0 if the map height is not fixed.
      int getFixedImageWidth()
      Gets the fixed width of maps the service can produce for this layer, or 0 if the map width is not fixed.
      java.util.List<java.lang.String> getKeywords()
      Gets a list of keywords used to describe the layer.
      java.lang.String getName()
      Gets the name of the layer.
      java.util.List<SpatialReference> getSpatialReferences()
      Gets the spatial references supported by the layer.
      java.util.List<java.lang.String> getStyles()
      Gets the names of styles that may be applied to the layer.
      java.util.List<WmsLayerInfo> getSublayerInfos()
      Gets a list of WmsLayerInfo objects for the layer's sublayers.
      java.lang.String getTitle()
      Gets the title of the layer.
      boolean isOpaque()
      Indicates if the layer's content should be considered "opaque".
      boolean isQueryable()
      Indicates if the layer is queryable.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • getDescription

        public java.lang.String getDescription()
        Gets the description of the layer.
        Returns:
        the description of the layer
        Since:
        100.2.0

      • getExtent

        public Envelope getExtent()
        Gets the extent of the layer.
        Returns:
        the extent of the layer
        Since:
        100.2.0

      • getFixedImageHeight

        public int getFixedImageHeight()
        Gets the fixed height of maps the service can produce for this layer, or 0 if the map height is not fixed.
        Returns:
        the fixed height in pixels, or 0 if the height is not fixed
        Since:
        100.2.0
        See Also:
        getFixedImageWidth()

      • getFixedImageWidth

        public int getFixedImageWidth()
        Gets the fixed width of maps the service can produce for this layer, or 0 if the map width is not fixed.
        Returns:
        the fixed width in pixels, or 0 if the width is not fixed
        Since:
        100.2.0
        See Also:
        getFixedImageHeight()

      • getKeywords

        public java.util.List<java.lang.String> getKeywords()
        Gets a list of keywords used to describe the layer.
        Returns:
        an unmodifiable list of keywords
        Since:
        100.2.0

      • getName

        public java.lang.String getName()
        Gets the name of the layer.

        WMS layers have both a name and a title property. Title is mandatory but name is optional. A layer can be displayed only if it has a name. A layer without a name is only a category title for sublayers nested within. A layer with a name may also have sublayers, which are all displayed if the parent layer is displayed.

        Returns:
        the name of the layer
        Since:
        100.2.0
        See Also:
        getTitle()

      • isOpaque

        public boolean isOpaque()
        Indicates if the layer's content should be considered "opaque".

        The WMS layer opaque property describes the layer's data content, not the picture format of the map response. A true value indicates that map data are mostly or completely opaque. A false value indicates that map data represent vector features that probably do not completely fill space. In practice, a layer with opaque set to true is a good candidate for use as a basemap.

        Returns:
        true if the layer's content is mostly or completely opaque; false otherwise
        Since:
        100.2.0

      • isQueryable

        public boolean isQueryable()
        Indicates if the layer is queryable.
        Returns:
        true if the layer is queryable; false otherwise
        Since:
        100.2.0

      • getSpatialReferences

        public java.util.List<SpatialReference> getSpatialReferences()
        Gets the spatial references supported by the layer.
        Returns:
        an unmodifiable list of spatial references supported by the layer
        Since:
        100.2.0

      • getStyles

        public java.util.List<java.lang.String> getStyles()
        Gets the names of styles that may be applied to the layer.

        Styles are server-defined options for how the layer and its information are displayed. Note that the order of styles returned does not indicate which style is the default.

        Returns:
        an unmodifiable list of styles
        Since:
        100.2.0

      • getSublayerInfos

        public java.util.List<WmsLayerInfo> getSublayerInfos()
        Gets a list of WmsLayerInfo objects for the layer's sublayers.
        Returns:
        an unmodifiable list of WmsLayerInfo objects
        Since:
        100.2.0

      • getTitle

        public java.lang.String getTitle()
        Gets the title of the layer.

        The title is intended for use as a human-readable layer identification. The title is not unique. Note also that a layer with a title but no name describes a category for use as a container for sublayers.

        Returns:
        the title of the layer
        Since:
        100.2.0
        See Also:
        getName()