Package com.luciad.wms.server.model

Class ALcdWMSCapabilities

java.lang.Object
com.luciad.wms.server.model.ALcdWMSCapabilities
All Implemented Interfaces:
ILcdCloneable, Cloneable
Direct Known Subclasses:
TLcdWMSCapabilities
public abstract class ALcdWMSCapabilities extends Object implements ILcdCloneable
Represents the capabilities of a WMS. Implementations of this class define what the WMS can show : which layers, which srs, which styles, etc.

  • Constructor Details

    • ALcdWMSCapabilities

      public ALcdWMSCapabilities()

  • Method Details

    • getRootWMSLayerCount

      public abstract int getRootWMSLayerCount()
      Returns the number of root layers.
      Returns:
      the number of root layers.

    • getRootWMSLayer

      public abstract ALcdWMSLayer getRootWMSLayer(int aIndex) throws IndexOutOfBoundsException
      Returns the top-level layer at an index.
      Parameters:
      aIndex - the index of the root layer.
      Returns:
      the top-level ALcdWMSLayer at an index.
      Throws:
      IndexOutOfBoundsException - if the index is out of bounds.

    • getWMSServiceMetaData

      public abstract ALcdWMSServiceMetaData getWMSServiceMetaData()
      Returns the service meta data of the WMS.
      Returns:
      the service meta data of the WMS.

    • findWMSLayer

      public abstract ALcdWMSLayer findWMSLayer(String aLayerName)
      Find the ALcdWMSLayer object for a layer name.
      Parameters:
      aLayerName - a String with name.
      Returns:
      the requested ALcdWMSLayer.

    • isAllowedStyleID

      public abstract boolean isAllowedStyleID(String aLayerName, String aStyleID)
      Returns true is a given style id is allowed for a given layer.
      Parameters:
      aLayerName - a String with the layername.
      aStyleID - a String with the style id to be checked.
      Returns:
      true if the style ID is allowed, else false.

    • getMapFormatCount

      public abstract int getMapFormatCount()
      Returns the number of map formats.
      Returns:
      the number of map formats.

    • getMapFormat

      public abstract String getMapFormat(int aIndex) throws IndexOutOfBoundsException
      Returns the map format at a given index (MIME type).
      Parameters:
      aIndex - the index of the map format.
      Returns:
      the map format at a given index (MIME type).
      Throws:
      IndexOutOfBoundsException - if invalid index.

    • getFeatureInfoFormatCount

      public abstract int getFeatureInfoFormatCount()
      Returns the number of feature info formats.
      Returns:
      the number of feature info formats.

    • getFeatureInfoFormat

      public abstract String getFeatureInfoFormat(int aIndex) throws IndexOutOfBoundsException
      Returns the feature info format at a given index (MIME type).
      Parameters:
      aIndex - the index of the feature info format.
      Returns:
      the feature info format at a given index (MIME type).
      Throws:
      IndexOutOfBoundsException - if invalid index.

    • getLegendGraphicFormatCount

      public int getLegendGraphicFormatCount()
      Returns the number of legend graphic formats.
      Returns:
      the number of legend graphic formats.

    • getLegendGraphicFormat

      public String getLegendGraphicFormat(int aIndex) throws IndexOutOfBoundsException
      Returns the legend graphic format at a given index (MIME type).
      Parameters:
      aIndex - the index of the legend graphic format.
      Returns:
      the legend graphic format at a given index (MIME type).
      Throws:
      IndexOutOfBoundsException - if invalid index.

    • getDescribeLayerFormatCount

      public int getDescribeLayerFormatCount()
      Returns the number of describe layer formats.
      Returns:
      the number of describe layer formats.

    • getDescribeLayerFormat

      public String getDescribeLayerFormat(int aIndex) throws IndexOutOfBoundsException
      Returns the describe layer format at a given index (MIME type).
      Parameters:
      aIndex - the index of the describe layer format.
      Returns:
      the describe layer format at a given index (MIME type).
      Throws:
      IndexOutOfBoundsException - if invalid index.

    • getSpatialReferenceSystemCount

      public abstract int getSpatialReferenceSystemCount()
      Returns the number of published spatial reference systems (SRS).
      Returns:
      the number of published spatial reference systems (SRS).

    • getSpatialReferenceSystem

      public abstract String getSpatialReferenceSystem(int aIndex) throws IndexOutOfBoundsException
      Returns the published spatial reference system (SRS) at an index.
      Parameters:
      aIndex - the index of the spatial reference system.
      Returns:
      the published spatial reference system (SRS) at an index.
      Throws:
      IndexOutOfBoundsException - if index is out of bounds.

    • getMapDataFolder

      public abstract String getMapDataFolder()
      Returns the path of the root folder from which map data is loaded.
      Returns:
      the path of the root folder from which map data is loaded.

    • getUpdateSequence

      public abstract String getUpdateSequence()
      Returns the update sequence value associated with this capabilities object.
      Returns:
      the update sequence value associated with this capabilities object.

    • clone

      public Object clone()
      Returns a clone of this object.
      Specified by:
      clone in interface ILcdCloneable
      Overrides:
      clone in class Object
      Returns:
      a clone of this object.
      Since:
      2014.0
      See Also: