org.geotools.ows.wms.map

Class WMSCoverageReader

Object

AbstractGridCoverage2DReader

WMSCoverageReader

All Implemented Interfaces:

GridCoverage2DReader, GridCoverageReader

public class WMSCoverageReader
extends AbstractGridCoverage2DReader

A grid coverage readers backing onto a WMS server by issuing GetMap

Field Summary

Fields

Modifier and Type	Field and Description
static Logger	LOGGER The logger for the map module.

Fields inherited from class AbstractGridCoverage2DReader

closeMe, coverageFactory, coverageName, crs, dtLayout, EPS, gzipped, highestRes, hints, inStream, inStreamSPI, numOverviews, offsets, originalEnvelope, originalGridRange, overViewResolutions, raster2Model, scales, source

Fields inherited from interface GridCoverage2DReader

ELEVATION_DOMAIN, ELEVATION_DOMAIN_MAXIMUM, ELEVATION_DOMAIN_MINIMUM, ELEVATION_DOMAIN_RESOLUTION, FILE_SOURCE_PROPERTY, HAS_ELEVATION_DOMAIN, HAS_TIME_DOMAIN, MULTICRS_EPSGCODES, MULTICRS_READER, REPROJECTING_READER, SOURCE_URL_PROPERTY, TIME_DOMAIN, TIME_DOMAIN_MAXIMUM, TIME_DOMAIN_MINIMUM, TIME_DOMAIN_RESOLUTION

Constructor Summary

Constructors

Constructor and Description
WMSCoverageReader(WebMapServer wms, Layer layer) Builds a new WMS coverage reader
WMSCoverageReader(WebMapServer wms, Layer layer, String style)
WMSCoverageReader(WebMapServer wms, Layer layer, String style, String preferredFormat)

Method Summary

Modifier and Type	Method and Description
String	getDefaultFormat(List<String> formats)
InputStream	getFeatureInfo(DirectPosition2D pos, String infoFormat, int featureCount, GetMapRequest getmap) Issues GetFeatureInfo against a point using the params of the last GetMap request
Format	getFormat() Returns the format handled by this GridCoverageReader.
List<Layer>	getLayers() fetch the WMS Layers used in this coverage.
String[]	getMetadataNames() Returns the list of metadata keywords associated with the input source as a whole (not associated with any particular grid coverage).
String	getMetadataValue(String name) Retrieve the metadata value for a given metadata name.
List<String>	getStyles() fetch the names of the styles used in this layer.
GridCoverage2D	read(GeneralParameterValue[] parameters) Read the current grid coverage from the stream.
void	updateBounds() Returns the layer bounds

Methods inherited from class AbstractGridCoverage2DReader

addAllSiblings, addSiblings, checkName, collectScaleOffset, createImageCoverage, createImageCoverage, createImageCoverage, createImageCoverage, decimationOnReadingControl, dispose, finalize, getCoordinateReferenceSystem, getCoordinateReferenceSystem, getDatasetLayout, getDatasetLayout, getDynamicParameters, getDynamicParameters, getFiles, getGridCoverageCount, getGridCoverageNames, getGroundControlPoints, getGroundControlPoints, getHighestRes, getImageLayout, getImageLayout, getInfo, getInfo, getMetadataNames, getMetadataValue, getMultiLevelROIProvider, getOriginalEnvelope, getOriginalEnvelope, getOriginalGridRange, getOriginalGridRange, getOriginalGridToWorld, getOriginalGridToWorld, getOverviewGridEnvelope, getOverviewGridEnvelope, getReadingResolutions, getReadingResolutions, getRescaledRasterToModel, getResolution, getResolutionLevels, getResolutionLevels, getSibling, getSource, getSourceAsFile, read, setlayout, setLayout, setReadParams, setReadParams

Methods inherited from class Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOGGER

public static final Logger LOGGER

The logger for the map module.

Constructor Detail

WMSCoverageReader

public WMSCoverageReader(WebMapServer wms,
                         Layer layer)

Builds a new WMS coverage reader

WMSCoverageReader

public WMSCoverageReader(WebMapServer wms,
                         Layer layer,
                         String style)

WMSCoverageReader

public WMSCoverageReader(WebMapServer wms,
                         Layer layer,
                         String style,
                         String preferredFormat)

Method Detail

getDefaultFormat

public String getDefaultFormat(List<String> formats)

getFeatureInfo

public InputStream getFeatureInfo(DirectPosition2D pos,
                                  String infoFormat,
                                  int featureCount,
                                  GetMapRequest getmap)
                           throws IOException

Issues GetFeatureInfo against a point using the params of the last GetMap request

Throws:

IOException

read

public GridCoverage2D read(GeneralParameterValue[] parameters)
                    throws IllegalArgumentException,
                           IOException

Description copied from class: AbstractGridCoverage2DReader

Read the current grid coverage from the stream.

Example:

Specified by:

read in interface GridCoverage2DReader

Specified by:

read in interface GridCoverageReader

Specified by:

read in class AbstractGridCoverage2DReader

Parameters:

parameters - Optional parameters matching Format.getReadParameters().

Returns:

a grid coverage from the input source.

Throws:

InvalidParameterNameException - if a parameter in parameters doesn't have a recognized name.

InvalidParameterValueException - if a parameter in parameters doesn't have a valid value.

ParameterNotFoundException - if a parameter was required for the operation but was not provided in the parameters list.

IOException - if a read operation failed for some other input/output reason, including FileNotFoundException if no file with the given name can be found, or IIOException if an error was thrown by the underlying image library.

IllegalArgumentException

getFormat

public Format getFormat()

Description copied from interface: GridCoverageReader

Returns the format handled by this GridCoverageReader.

updateBounds

public void updateBounds()

Returns the layer bounds

getMetadataNames

public String[] getMetadataNames()

Description copied from interface: GridCoverageReader

Returns the list of metadata keywords associated with the input source as a whole (not associated with any particular grid coverage). If no metadata is available, the array will be empty.

Specified by:

getMetadataNames in interface GridCoverageReader

Overrides:

getMetadataNames in class AbstractGridCoverage2DReader

Returns:

The list of metadata keywords for the input source.

See Also:

GridCoverageReader.getMetadataNames()

getMetadataValue

public String getMetadataValue(String name)

Description copied from interface: GridCoverageReader

Retrieve the metadata value for a given metadata name.

Specified by:

getMetadataValue in interface GridCoverageReader

Overrides:

getMetadataValue in class AbstractGridCoverage2DReader

Parameters:

name - Metadata keyword for which to retrieve metadata.

Returns:

The metadata value for the given metadata name. Should be one of the name returned by GridCoverageReader.getMetadataNames().

See Also:

GridCoverageReader.getMetadataValue(java.lang.String)

getLayers

public List<Layer> getLayers()

fetch the WMS Layers used in this coverage.

Returns:

the layers

getStyles

public List<String> getStyles()

fetch the names of the styles used in this layer. Empty string means the default style.

Returns:

the style names.