Interface ILcdCoverageOffering

All Known Implementing Classes:
TLcdCoverageOffering, TLcdDefaultCoverageOffering

public interface ILcdCoverageOffering
This interface represents a WCS coverage offering.
  • Method Details

    • getName

      String getName()
      Returns a unique ID for the coverage offering.
    • getSource

      default String getSource()
      Returns the source.
      Since:
      2017.0
    • getLabel

      String getLabel()
      Returns a label for the coverage offering, which can be displayed to the user instead of the unique ID.
    • getDescription

      String getDescription()
      Returns a brief description of the coverage offering.
    • getMetadataLink

      String getMetadataLink()
      Returns a link to the metadata associated with the coverage offering.
    • getKeywordCount

      int getKeywordCount()
      Returns the number of keywords associated with the coverage offering.
    • getKeyword

      String getKeyword(int aIndex) throws IndexOutOfBoundsException
      Returns the keyword at the given index.
      Throws:
      IndexOutOfBoundsException
    • getWGS84Bounds

      ILcdBounds getWGS84Bounds()
      Returns the WGS84 bounding box of the coverage data.
    • getCoverageOfferingDetail

      ILcdCoverageOfferingDetail getCoverageOfferingDetail()
      Returns an ILcdCoverageOfferingDetail containing additional information about the coverage offering.
    • getExpiryDate

      default Long getExpiryDate()
      Returns the expiry date of this coverage. By default, null is returned.
      Since:
      2017.0
    • getModificationDate

      default Long getModificationDate()
      Returns the modification date of this coverage. By default, null is returned.
      Since:
      2017.0
    • getUpdateSequence

      default String getUpdateSequence()

      Returns the update sequence value associated with this coverage object. This update sequence identifies the state of the coverage, including all dependencies such as data source, bounds etc...

      The update sequence should comply with a number of conditions:

      • The sequence number should be different from all previous update sequences for this WCS coverage (if the WCS coverage has changed).
      • If the WCS coverage is different (i.e. different data/style/...), the sequence number should be different as well. Failing to do so will cause malfunctions in combination with caching.
      • If the WCS coverage doesn't change, the sequence number should also remain the same. Failing to do so lowers the effect of caching, and will result in worse performance.
      • The sequence number should be unique across sessions. Failing to do so may cause malfunctions in combination with caching. An easy mistake to make would for example be to use a counter that is reset when the server is restarted.

      By default, this method always returns "0". This means that the default implementation assumes that WCS coverages never change.

      One way to generate update sequences would be to use a (persistent) counter that gets incremented on every change. Another way would be to use System.currentTimeMillis() from a correct clock.

      Returns:
      the update sequence value associated with this coverage object, never null.
      Since:
      2020.1