| org.vfny.geoserver.wms.GetLegendGraphicProducer
All known Subclasses: org.vfny.geoserver.wms.responses.DefaultRasterLegendProducer,
| GetLegendGraphicProducer | | public interface GetLegendGraphicProducer (Code) | | Provides the skeleton for producers of a legend image, as required by the
GetLegendGraphic 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
produceLegendGraphic -> getContentType -> writeTo)
author:
Gabriel Roldan, Axios Engineering
version:
$Id: GetLegendGraphicProducer.java 6326 2007-03-15 18:36:40Z jdeolive $ |
| 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)
|
| produceLegendGraphic | | void produceLegendGraphic(GetLegendGraphicRequest request) throws WmsException(Code) | | Asks this legend graphic producer to create a graphic for the
GetLegenGraphic request parameters held in request
Parameters:
request - the "parsed" request, where "parsed" means that it'sproperties are already validated so this method must not takecare of verifying the requested layer exists and the like.
throws:
WmsException - something goes wrong |
| writeTo | | void writeTo(OutputStream out) throws IOException, ServiceException(Code) | | Writes the legend graphic created in produceLegendGraphic to the
destination stream, though it could be used to encode the legend 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:
IOException - if something goes wrong in the actual process ofwriting content to out.
throws:
ServiceException - if something else goes wrong. |
|
|