Package com.luciad.wms.server.model

Class TLcdWMSCapabilities

java.lang.Object
com.luciad.wms.server.model.ALcdWMSCapabilities
com.luciad.wms.server.model.TLcdWMSCapabilities
All Implemented Interfaces:
ILcdCloneable, Cloneable
public class TLcdWMSCapabilities extends ALcdWMSCapabilities
This class is an implementation of the ALcdWMSCapabilities interface.
See Also:

  • Constructor Details

    • TLcdWMSCapabilities

      public TLcdWMSCapabilities()
      Creates a new empty TLcdWMSCapabilities instance.

    • TLcdWMSCapabilities

      public TLcdWMSCapabilities(ALcdWMSCapabilities aCapabilities)
      Creates a new TLcdWMSCapabilities instance based on the given capabilities. All content is copied from the given capabilities to this new instance: service metadata, layers, map formats, feature info formats, legend graphic formats, describe layer formats, spatial reference systems, the map data folder and the update sequence parameter. References to non-primitive objects are shared.
      Since:
      2014.0

  • Method Details

    • getWMSServiceMetaData

      public ALcdWMSServiceMetaData getWMSServiceMetaData()
      Description copied from class: ALcdWMSCapabilities
      Returns the service meta data of the WMS.
      Specified by:
      getWMSServiceMetaData in class ALcdWMSCapabilities
      Returns:
      the service meta data of the WMS.

    • setWMSServiceMetaData

      public void setWMSServiceMetaData(ALcdWMSServiceMetaData aWMSServiceMetaData)
      Sets the service meta data for this capabilities object.
      Parameters:
      aWMSServiceMetaData - the service meta data.
      See Also:

    • getRootWMSLayerCount

      public int getRootWMSLayerCount()
      Description copied from class: ALcdWMSCapabilities
      Returns the number of root layers.
      Specified by:
      getRootWMSLayerCount in class ALcdWMSCapabilities
      Returns:
      the number of root layers.

    • getRootWMSLayer

      public ALcdWMSLayer getRootWMSLayer(int aIndex) throws IndexOutOfBoundsException
      Description copied from class: ALcdWMSCapabilities
      Returns the top-level layer at an index.
      Specified by:
      getRootWMSLayer in class ALcdWMSCapabilities
      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.

    • findWMSLayer

      public ALcdWMSLayer findWMSLayer(String aLayerName)
      Description copied from class: ALcdWMSCapabilities
      Find the ALcdWMSLayer object for a layer name.
      Specified by:
      findWMSLayer in class ALcdWMSCapabilities
      Parameters:
      aLayerName - a String with name.
      Returns:
      the requested ALcdWMSLayer.

    • isAllowedStyleID

      public boolean isAllowedStyleID(String aLayerName, String aStyleID)
      Description copied from class: ALcdWMSCapabilities
      Returns true is a given style id is allowed for a given layer.
      Specified by:
      isAllowedStyleID in class ALcdWMSCapabilities
      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.

    • addRootWMSLayer

      public void addRootWMSLayer(ALcdWMSLayer aRootLayer)
      Adds a top-level layer. In order to be fully compliant with the OGC WMS specification and have optimal interoperability with WMS clients, only one top-level layer should be used.
      Parameters:
      aRootLayer - a ALcdWMSLayer.

    • removeRootWMSLayer

      public void removeRootWMSLayer(ALcdWMSLayer aRootLayer)
      Removes a top-level layer.
      Parameters:
      aRootLayer - a ALcdWMSLayer.

    • moveLayerAt

      public void moveLayerAt(ALcdWMSLayer aRootLayer, int aIndex)
      Moves a root layer to a different position in the list.
      Parameters:
      aRootLayer - an ALcdWMSLayer.
      aIndex - the new list index to which the layer should be moved.

    • getRootWMSLayerIndex

      public int getRootWMSLayerIndex(ALcdWMSLayer aLayer)
      Returns the index of a top-level layer in the list.
      Parameters:
      aLayer - an ALcdWMSLayer.
      Returns:
      the index of the specified layer in the list, or -1 if the layer is not found.

    • getMapFormatCount

      public int getMapFormatCount()
      Description copied from class: ALcdWMSCapabilities
      Returns the number of map formats.
      Specified by:
      getMapFormatCount in class ALcdWMSCapabilities
      Returns:
      the number of map formats.

    • getMapFormat

      public String getMapFormat(int aIndex) throws IndexOutOfBoundsException
      Description copied from class: ALcdWMSCapabilities
      Returns the map format at a given index (MIME type).
      Specified by:
      getMapFormat in class ALcdWMSCapabilities
      Parameters:
      aIndex - the index of the map format.
      Returns:
      the map format at a given index (MIME type).
      Throws:
      IndexOutOfBoundsException - if invalid index.

    • addMapFormat

      public void addMapFormat(String aMapFormatAsMIMEType)
      Adds a map format to be published.
      Parameters:
      aMapFormatAsMIMEType - the MIME type of the map format to be published.

    • removeMapFormat

      public void removeMapFormat(String aMapFormatAsMIMEType)
      Removes a map format to be published.
      Parameters:
      aMapFormatAsMIMEType - the MIME type of the map format.

    • getFeatureInfoFormatCount

      public int getFeatureInfoFormatCount()
      Description copied from class: ALcdWMSCapabilities
      Returns the number of feature info formats.
      Specified by:
      getFeatureInfoFormatCount in class ALcdWMSCapabilities
      Returns:
      the number of feature info formats.

    • getFeatureInfoFormat

      public String getFeatureInfoFormat(int aIndex) throws IndexOutOfBoundsException
      Description copied from class: ALcdWMSCapabilities
      Returns the feature info format at a given index (MIME type).
      Specified by:
      getFeatureInfoFormat in class ALcdWMSCapabilities
      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.

    • addFeatureInfoFormat

      public void addFeatureInfoFormat(String aFeatureInfoFormatAsMIMEType)
      Adds a feature info format to be published.
      Parameters:
      aFeatureInfoFormatAsMIMEType - the MIME type of the feature info format to be published.

    • removeFeatureInfoFormat

      public void removeFeatureInfoFormat(String aFeatureInfoFormatAsMIMEType)
      Removes a feature info format to be published.
      Parameters:
      aFeatureInfoFormatAsMIMEType - the MIME type of the feature info format.

    • getLegendGraphicFormatCount

      public int getLegendGraphicFormatCount()
      Description copied from class: ALcdWMSCapabilities
      Returns the number of legend graphic formats.
      Overrides:
      getLegendGraphicFormatCount in class ALcdWMSCapabilities
      Returns:
      the number of legend graphic formats.

    • getLegendGraphicFormat

      public String getLegendGraphicFormat(int aIndex) throws IndexOutOfBoundsException
      Description copied from class: ALcdWMSCapabilities
      Returns the legend graphic format at a given index (MIME type).
      Overrides:
      getLegendGraphicFormat in class ALcdWMSCapabilities
      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.

    • addLegendGraphicFormat

      public void addLegendGraphicFormat(String aLegendGraphicFormatAsMIMEType)
      Adds a legend graphic format to be published.
      Parameters:
      aLegendGraphicFormatAsMIMEType - the MIME type of the legend graphic format to be published.

    • removeLegendGraphicFormat

      public void removeLegendGraphicFormat(String aLegendGraphicFormatAsMIMEType)
      Removes a legend graphic format that is published.
      Parameters:
      aLegendGraphicFormatAsMIMEType - the MIME type of the legend graphic format.

    • getDescribeLayerFormatCount

      public int getDescribeLayerFormatCount()
      Description copied from class: ALcdWMSCapabilities
      Returns the number of describe layer formats.
      Overrides:
      getDescribeLayerFormatCount in class ALcdWMSCapabilities
      Returns:
      the number of describe layer formats.

    • getDescribeLayerFormat

      public String getDescribeLayerFormat(int aIndex) throws IndexOutOfBoundsException
      Description copied from class: ALcdWMSCapabilities
      Returns the describe layer format at a given index (MIME type).
      Overrides:
      getDescribeLayerFormat in class ALcdWMSCapabilities
      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.

    • addDescribeLayerFormat

      public void addDescribeLayerFormat(String aDescribeLayerFormatAsMIMEType)
      Adds a describe layer format to be published.
      Parameters:
      aDescribeLayerFormatAsMIMEType - the MIME type of the describe layer format to be published.

    • removeDescribeLayerFormat

      public void removeDescribeLayerFormat(String aDescribeLayerFormatAsMIMEType)
      Removes a describe layer format that is published.
      Parameters:
      aDescribeLayerFormatAsMIMEType - the MIME type of the describe layer format.

    • addSpatialReferenceSystem

      public void addSpatialReferenceSystem(String aSpatialReferenceSystem)
      Adds a spatial reference system to be published.
      Parameters:
      aSpatialReferenceSystem - the spatial reference system to add.

    • getSpatialReferenceSystemCount

      public int getSpatialReferenceSystemCount()
      Description copied from class: ALcdWMSCapabilities
      Returns the number of published spatial reference systems (SRS).
      Specified by:
      getSpatialReferenceSystemCount in class ALcdWMSCapabilities
      Returns:
      the number of published spatial reference systems (SRS).

    • getSpatialReferenceSystem

      public String getSpatialReferenceSystem(int aIndex) throws IndexOutOfBoundsException
      Description copied from class: ALcdWMSCapabilities
      Returns the published spatial reference system (SRS) at an index.
      Specified by:
      getSpatialReferenceSystem in class ALcdWMSCapabilities
      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.

    • setMapDataFolder

      public void setMapDataFolder(String aPath)
      Sets the path of the root folder from which map data is loaded.
      Parameters:
      aPath - the path of the root folder from which map data is loaded.
      See Also:

    • getMapDataFolder

      public String getMapDataFolder()
      Description copied from class: ALcdWMSCapabilities
      Returns the path of the root folder from which map data is loaded.
      Specified by:
      getMapDataFolder in class ALcdWMSCapabilities
      Returns:
      the path of the root folder from which map data is loaded.

    • getUpdateSequence

      public String getUpdateSequence()
      Description copied from class: ALcdWMSCapabilities
      Returns the update sequence value associated with this capabilities object.
      Specified by:
      getUpdateSequence in class ALcdWMSCapabilities
      Returns:
      the update sequence value associated with this capabilities object.

    • setUpdateSequence

      public void setUpdateSequence(String aUpdateSequence)
      Sets the update sequence value for this capabilities object. When the capabilities have been updated (e.g. a new layer), this method should be called to indicate a new version.
      Parameters:
      aUpdateSequence - the update sequence value for this capabilities object.

    • clone

      public Object clone()
      Returns a clone of this object. All content is shared except for the data structures listing the layers, formats (map, feature info, legend graphic, describe layer) and reference systems; these are cloned.
      Specified by:
      clone in interface ILcdCloneable
      Overrides:
      clone in class ALcdWMSCapabilities
      Returns:
      a clone of this object.
      Since:
      2014.0
      See Also: