Package com.luciad.ogc.wcs.model
Class TLcdDefaultCoverageOffering
java.lang.Object
com.luciad.ogc.wcs.model.TLcdDefaultCoverageOffering
- All Implemented Interfaces:
ILcdCoverageOffering
The default implementation of
ILcdCoverageOffering
.- Since:
- 2017.0
-
Constructor Summary
ConstructorDescriptionTLcdDefaultCoverageOffering
(String aName, String aSource, ILcdBounds aWGS84Bounds, ILcdCoverageOfferingDetail aCoverageOfferingDetail) -
Method Summary
Modifier and TypeMethodDescriptionReturns anILcdCoverageOfferingDetail
containing additional information about the coverage offering.Returns a brief description of the coverage offering.Returns the expiry date of this coverage.getKeyword
(int aIndex) Returns the keyword at the given index.int
Returns the number of keywords associated with the coverage offering.getLabel()
Returns a label for the coverage offering, which can be displayed to the user instead of the unique ID.Returns a link to the metadata associated with the coverage offering.Returns the modification date of this coverage.getName()
Returns a unique ID for the coverage offering.Returns the source.Returns the update sequence value associated with this coverage object.Returns the WGS84 bounding box of the coverage data.void
setCoverageOfferingDetail
(ILcdCoverageOfferingDetail aCoverageOfferingDetail) void
setDescription
(String aDescription) void
setExpiryDate
(long aDate) Sets an expiry date for this coverage.void
setKeywords
(List<String> aKeywords) void
void
setMetadataLink
(String aMetadataLink) void
setModificationDate
(Long aDate) Sets a modification date for this coverage.void
void
void
setUpdateSequence
(String aUpdateSequence) Sets the update sequence value associated with this capabilities object.void
setWGS84Bounds
(ILcdBounds aWGS84Bounds)
-
Constructor Details
-
TLcdDefaultCoverageOffering
public TLcdDefaultCoverageOffering(String aName, String aSource, ILcdBounds aWGS84Bounds, ILcdCoverageOfferingDetail aCoverageOfferingDetail)
-
-
Method Details
-
getName
Description copied from interface:ILcdCoverageOffering
Returns a unique ID for the coverage offering.- Specified by:
getName
in interfaceILcdCoverageOffering
-
setName
-
getSource
Description copied from interface:ILcdCoverageOffering
Returns the source.- Specified by:
getSource
in interfaceILcdCoverageOffering
-
setSource
-
getLabel
Description copied from interface:ILcdCoverageOffering
Returns a label for the coverage offering, which can be displayed to the user instead of the unique ID.- Specified by:
getLabel
in interfaceILcdCoverageOffering
-
setLabel
-
getDescription
Description copied from interface:ILcdCoverageOffering
Returns a brief description of the coverage offering.- Specified by:
getDescription
in interfaceILcdCoverageOffering
-
setDescription
-
getMetadataLink
Description copied from interface:ILcdCoverageOffering
Returns a link to the metadata associated with the coverage offering.- Specified by:
getMetadataLink
in interfaceILcdCoverageOffering
-
getKeywordCount
public int getKeywordCount()Description copied from interface:ILcdCoverageOffering
Returns the number of keywords associated with the coverage offering.- Specified by:
getKeywordCount
in interfaceILcdCoverageOffering
-
getKeyword
Description copied from interface:ILcdCoverageOffering
Returns the keyword at the given index.- Specified by:
getKeyword
in interfaceILcdCoverageOffering
- Throws:
IndexOutOfBoundsException
-
setMetadataLink
-
getKeywords
-
setKeywords
-
getWGS84Bounds
Description copied from interface:ILcdCoverageOffering
Returns the WGS84 bounding box of the coverage data.- Specified by:
getWGS84Bounds
in interfaceILcdCoverageOffering
-
setWGS84Bounds
-
getCoverageOfferingDetail
Description copied from interface:ILcdCoverageOffering
Returns anILcdCoverageOfferingDetail
containing additional information about the coverage offering.- Specified by:
getCoverageOfferingDetail
in interfaceILcdCoverageOffering
-
setCoverageOfferingDetail
-
setExpiryDate
public void setExpiryDate(long aDate) Sets an expiry date for this coverage. The date is expressed by the number of milliseconds since January 1, 1970, 00:00:00 GMT. When set, the date is used to fill in theExpires
HTTP header onGetCoverage
andDescribeCoverage
responses.- Parameters:
aDate
- an expiry date for this coverage- See Also:
-
getExpiryDate
Returns the expiry date of this coverage. By default,null
is returned.- Specified by:
getExpiryDate
in interfaceILcdCoverageOffering
- Returns:
- the expiry date associated with this coverage
- See Also:
-
setModificationDate
Sets a modification date for this coverage. The date is expressed by the number of milliseconds since January 1, 1970, 00:00:00 GMT. When set, the date is used to fill in theLast-Modified
HTTP header onGetCoverage
andDescribeCoverage
responses.- Parameters:
aDate
- a modification date for this coverage- See Also:
-
getModificationDate
Returns the modification date of this coverage. By default,null
is returned.- Specified by:
getModificationDate
in interfaceILcdCoverageOffering
- Returns:
- the modification date associated with this coverage.
- See Also:
-
getUpdateSequence
Description copied from interface:ILcdCoverageOffering
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.- Specified by:
getUpdateSequence
in interfaceILcdCoverageOffering
- Returns:
- the update sequence value associated with this coverage object, never
null
.
-
setUpdateSequence
Sets the update sequence value associated with this capabilities object. See
getUpdateSequence()
for more information.- Parameters:
aUpdateSequence
- the new update sequence.- Since:
- 2020.1
-