| org.vfny.geoserver.wms.GetMapProducer
All known Subclasses: org.vfny.geoserver.wms.responses.map.georss.RSSGeoRSSMapProducer, org.vfny.geoserver.wms.responses.map.openlayers.OpenLayersMapProducer, org.vfny.geoserver.wms.responses.map.svg.SVGMapProducer, org.vfny.geoserver.wms.responses.map.metatile.MetatileMapProducer, org.vfny.geoserver.wms.responses.AbstractGetMapProducer, org.vfny.geoserver.wms.responses.map.kml.KMZMapProducer, org.vfny.geoserver.wms.responses.map.svg.SVGBatikMapProducer, org.vfny.geoserver.wms.responses.map.kml.KMLMapProducer, org.vfny.geoserver.wms.responses.map.georss.AtomGeoRSSMapProducer,
| GetMapProducer | | public interface GetMapProducer (Code) | | Provides the skeleton for producers of map image, as required by the
GetMap WMS request.
To incorporate a new producer specialized in one or many output formats,
there must be a
registered
that can provide instances of that concrete implementation.
The methods defined in this interface respects the general parse
request/produce response/get mime type/write content workflow, so they
should raise an exception if are called in the wrong order (which is
produceMap -> getContentType -> writeTo)
author:
Gabriel Roldan, Axios Engineering
author:
Simone Giannecchini, GeoSolutions
version:
$Id: GetMapProducer.java 7467 2007-08-28 22:29:03Z afabiani $ |
| abort | | void abort()(Code) | | asks the legend graphic producer to stop processing since it will be no
longer needed (for example, because the request was interrupted by the
user)
|
| getContentDisposition | | String getContentDisposition()(Code) | | The content disposition is the file name of the returned result. If there
is no file name, null is returned. The returned string should be in the
form: "inline; filename=name.ext" You need the "inline;" prefix and the
filename can be whatever you want. An example would be: "inline;
filename=states.pdf"
Header information for setting the file name |
| getOutputFormat | | public String getOutputFormat()(Code) | | Gets the output map type of the output image.
the desired output map format. |
| produceMap | | void produceMap() throws WmsException(Code) | | Asks this map producer to create a map image for the passed
, which contains enough information for doing such a
process.
throws:
WmsException - something goes wrong |
| setMapContext | | public void setMapContext(WMSMapContext mapContext)(Code) | | Sets the
MapContext for this MapProducer.
Parameters:
mapContext - to use for producing a map. |
| setOutputFormat | | public void setOutputFormat(String format)(Code) | | Sets the MIME type of the output image.
Parameters:
format - the desired output map format. |
| writeTo | | void writeTo(OutputStream out) throws ServiceException, IOException(Code) | | Writes the map created in produceMap to the destination stream, though
it could be used to encode the map to the proper output format,
provided that there are almost no risk that the encoding fails.
Parameters:
out - an open stream where to send the produced legend graphic to.
throws:
ServiceException - if something else goes wrong.
throws:
IOException - if something goes wrong in the actual process ofwriting content to out. |
|
|
