/*
* Copyright 1998-2009 University Corporation for Atmospheric Research/Unidata
*
* Portions of this software were developed by the Unidata Program at the
* University Corporation for Atmospheric Research.
*
* Access and use of this software shall impose the following obligations
* and understandings on the user. The user is granted the right, without
* any fee or cost, to use, copy, modify, alter, enhance and distribute
* this software, and any derivative works thereof, and its supporting
* documentation for any purpose whatsoever, provided that this entire
* notice appears in all copies of the software, derivative works and
* supporting documentation. Further, UCAR requests that the user credit
* UCAR/Unidata in any publications that result from the use of this
* software or in any product that includes this software. The names UCAR
* and/or Unidata, however, may not be used in any advertising or publicity
* to endorse or promote any products or commercial entity unless specific
* written permission is obtained from UCAR/Unidata. The user also
* understands that UCAR/Unidata is not obligated to provide the user with
* any support, consulting, training or assistance of any kind with regard
* to the use, operation and performance of this software nor to provide
* the user with any updates, revisions, new versions or "bug fixes."
*
* THIS SOFTWARE IS PROVIDED BY UCAR/UNIDATA "AS IS" AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL UCAR/UNIDATA BE LIABLE FOR ANY SPECIAL,
* INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
* FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
* NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
* WITH THE ACCESS, USE OR PERFORMANCE OF THIS SOFTWARE.
*/
package thredds.wcs.v1_0_0_1;
import java.io.File;
import ucar.nc2.time.CalendarDateRange;
import ucar.unidata.geoloc.LatLonRect;
import ucar.unidata.geoloc.LatLonPointImpl;
import ucar.nc2.dt.GridCoordSystem;
import thredds.wcs.Request;
/**
* _more_
*
* @author edavis
* @since 4.0
*/
public class GetCoverage extends WcsRequest
{
private static org.slf4j.Logger log =
org.slf4j.LoggerFactory.getLogger( GetCoverage.class );
private WcsCoverage coverage;
private LatLonRect bboxLatLonRect = null;
private CalendarDateRange timeRange;
private WcsCoverage.VerticalRange rangeSetAxisValueRange;
private Request.Format format;
// GeoTIFF only supported for requests for a single time and a single vertical level.
private boolean isSingleTimeRequest = false;
private boolean isSingleVerticalRequest = false;
public GetCoverage( Request.Operation operation, String version, WcsDataset dataset,
String coverageId, String crs, String responseCRS,
Request.BoundingBox bbox, CalendarDateRange timeRange,
WcsCoverage.VerticalRange verticalRange, Request.Format format )
throws WcsException
{
super( operation, version, dataset);
// Validate coverage ID parameter.
if ( coverageId == null )
throw new WcsException( WcsException.Code.MissingParameterValue, "coverage", "Coverage identifier required." );
if ( ! this.getDataset().isAvailableCoverageName( coverageId ) )
throw new WcsException( WcsException.Code.InvalidParameterValue, "coverage", "Unknown coverage identifier [" + coverageId + "]." );
this.coverage = this.getDataset().getAvailableCoverage( coverageId );
if ( this.coverage == null ) // Double check just in case.
throw new WcsException( WcsException.Code.InvalidParameterValue, "coverage", "Unknown coverage identifier [" + coverageId + "]." );
// Assign and validate request and response CRS parameters.
if ( crs == null )
crs = this.coverage.getDefaultRequestCrs(); // The WCS 1.0.0 spec requires CRS.
//throw new WcsException( WcsException.Code.MissingParameterValue, "CRS", "Request CRS required.");
if ( ! crs.equalsIgnoreCase( this.coverage.getDefaultRequestCrs() ) )
throw new WcsException( WcsException.Code.InvalidParameterValue, "CRS", "Request CRS [" + crs + "] not allowed [" + this.coverage.getDefaultRequestCrs() + "]." );
// Response CRS not required if data is in latLon ("OGC:CRS84"). Default is request CRS.
if ( responseCRS == null )
{
responseCRS = this.coverage.getNativeCrs();
}
else if ( ! responseCRS.equalsIgnoreCase( this.coverage.getNativeCrs()))
throw new WcsException( WcsException.Code.InvalidParameterValue, "response_CRS", "Response CRS [" + responseCRS + "] not the supported CRS [" + this.coverage.getNativeCrs() + "]." );
// Assign and validate BBOX and TIME parameters.
// -----
// WCS Spec says at least one of BBOX and TIME are required in a request.
// We will not require, default is everything.
//
// if ( bbox == null && time == null )
// throw new WcsException( WcsException.Code.MissingParameterValue, "BBOX", "BBOX and/or TIME required.");
// -----
if ( bbox != null )
bboxLatLonRect = convertBoundingBox( bbox, coverage.getCoordinateSystem());
this.timeRange = timeRange;
if ( timeRange != null )
this.isSingleTimeRequest = timeRange.isPoint();
else
this.isSingleTimeRequest = ( null == this.coverage.getCoordinateSystem().getTimeAxis());
// WIDTH, HEIGHT, DEPTH parameters not needed since the only interpolation method is "NONE".
// RESX, RESY, RESZ parameters not needed since the only interpolation method is "NONE".
// Assign and validate PARAMETER ("Vertical") parameter.
this.rangeSetAxisValueRange = verticalRange;
if ( verticalRange != null )
this.isSingleVerticalRequest = verticalRange.isSinglePoint();
else
this.isSingleVerticalRequest = ( null == this.coverage.getCoordinateSystem().getVerticalAxis());
// Assign and validate FORMAT parameter.
if ( format == null )
{
log.debug( "GetCoverage(): FORMAT parameter required.");
throw new WcsException( WcsException.Code.InvalidParameterValue, "FORMAT", "FORMAT parameter required.");
}
if ( ! this.coverage.isSupportedCoverageFormat( format ))
{
String msg = "Unsupported format value [" + format + "].";
log.debug( "GetCoverage(): " + msg );
throw new WcsException( WcsException.Code.InvalidParameterValue, "FORMAT", msg );
}
this.format = format;
if ( this.format == Request.Format.GeoTIFF || this.format == Request.Format.GeoTIFF_Float)
{
// Check that request is for one time and one vertical level
// since that is all we support for GeoTIFF[-Float].
if ( ! this.isSingleTimeRequest && ! this.isSingleVerticalRequest )
{
StringBuffer msgB = new StringBuffer( "GeoTIFF supported only for requests at a single time [");
if ( this.timeRange != null )
msgB.append( this.timeRange);
msgB.append( "] and a single vertical level [");
if ( verticalRange != null )
msgB.append( verticalRange );
msgB.append( "].");
log.debug( "GetCoverage(): " + msgB );
throw new WcsException( WcsException.Code.InvalidParameterValue, "FORMAT", msgB.toString() );
}
}
}
public Request.Format getFormat() { return format; }
public File writeCoverageDataToFile()
throws WcsException
{
return this.coverage.writeCoverageDataToFile( this.format,
this.bboxLatLonRect,
this.rangeSetAxisValueRange,
this.timeRange);
}
private LatLonRect convertBoundingBox( Request.BoundingBox bbox, GridCoordSystem gcs)
throws WcsException
{
if ( bbox == null )
return null;
LatLonPointImpl minll = new LatLonPointImpl( bbox.getMinPointValue( 1 ), bbox.getMinPointValue( 0 ));
LatLonPointImpl maxll = new LatLonPointImpl( bbox.getMaxPointValue( 1 ), bbox.getMaxPointValue( 0 ) );
LatLonRect bboxLatLonRect = new LatLonRect( minll, maxll );
// if ( ! bboxLatLonRect.containedIn( covLatLonRect))
// {
// log.error( "convertBoundingBox(): BBOX [" + bbox + "] not contained in coverage BBOX ["+ covLatLonRect.toString2()+"].");
// throw new WcsException( WcsException.Code.InvalidParameterValue, "BBOX", "BBOX [" + bbox + "] not contained in coverage.");
// }
return bboxLatLonRect;
}
}