Java Doc for GetLegendGraphicRequest.java in  » GIS » GeoServer » org » vfny » geoserver » wms » requests » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » GIS » GeoServer » org.vfny.geoserver.wms.requests 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.vfny.geoserver.wms.requests.WMSRequest
   org.vfny.geoserver.wms.requests.GetLegendGraphicRequest

GetLegendGraphicRequest
public class GetLegendGraphicRequest extends WMSRequest (Code)
Holds the parsed parameters for a GetLegendGraphic WMS request.

The GET parameters of the GetLegendGraphic operation are defined as follows (from SLD 1.0 spec, ch.12):

 
ParameterRequiredDescription
VERSION Required Version as required by OGC interfaces.
REQUEST Required Value must be GetLegendRequest .
LAYER Required Layer for which to produce legend graphic.
STYLE Optional Style of layer for which to produce legend graphic. If not present, the default style is selected. The style may be any valid style available for a layer, including non-SLD internally-defined styles.
FEATURETYPE Optional Feature type for which to produce the legend graphic. This is not needed if the layer has only a single feature type.
RULE Optional Rule of style to produce legend graphic for, if applicable. In the case that a style has multiple rules but no specific rule is selected, then the map server is obligated to produce a graphic that is representative of all of the rules of the style.
SCALE Optional In the case that a RULE is not specified for a style, this parameter may assist the server in selecting a more appropriate representative graphic by eliminating internal rules that are outof- scope. This value is a standardized scale denominator, defined in Section 10.2
SLD Optional This parameter specifies a reference to an external SLD document. It works in the same way as the SLD= parameter of the WMS GetMap operation.
SLD_BODY Optional This parameter allows an SLD document to be included directly in an HTTP-GET request. It works in the same way as the SLD_BODY= parameter of the WMS GetMap operation.
FORMAT Required This gives the MIME type of the file format in which to return the legend graphic. Allowed values are the same as for the FORMAT= parameter of the WMS GetMap request.
WIDTH Optional This gives a hint for the width of the returned graphic in pixels. Vector-graphics can use this value as a hint for the level of detail to include.
HEIGHT Optional This gives a hint for the height of the returned graphic in pixels.
EXCEPTIONS Optional This gives the MIME type of the format in which to return exceptions. Allowed values are the same as for the EXCEPTIONS= parameter of the WMS GetMap request.
TRANSPARENT Optional true if the legend image background should be transparent. Defaults to false.

The GetLegendGraphic operation itself is optional for an SLD-enabled WMS. It provides a general mechanism for acquiring legend symbols, beyond the LegendURL reference of WMS Capabilities. Servers supporting the GetLegendGraphic call might code LegendURL references as GetLegendGraphic for interface consistency. Vendorspecific parameters may be added to GetLegendGraphic requests and all of the usual OGC-interface options and rules apply. No XML-POST method for GetLegendGraphic is presently defined.


author:
   Gabriel Roldan, Axios Engineering
version:
   $Id: GetLegendGraphicRequest.java 7728 2007-11-09 01:53:31Z groldan $


Field Summary
final public static  StringDEFAULT_FORMAT
     The default image format in which to produce a legend graphic.
final public static  intDEFAULT_HEIGHT
    
final public static  intDEFAULT_WIDTH
    
final public static  StringSLD_VERSION
    

Constructor Summary
public  GetLegendGraphicRequest(WMService service)
     Creates a new GetLegendGraphicRequest object.

Method Summary
public  StringgetExceptionsFormat()
    
public  StringgetFeatureType()
    
public  StringgetFormat()
    
public  intgetHeight()
    
public  FeatureTypegetLayer()
    
public  MapgetLegendOptions()
    
public  RulegetRule()
    
public  doublegetScale()
    
public  StylegetStyle()
    
public  intgetWidth()
    
public  booleanisTransparent()
     Returns the value of the optional request parameter TRANSPARENT, which might be either the literal true or false and specifies if the background of the legend graphic to return shall be transparent or not.
public  voidsetExceptionsFormat(String exceptionsFormat)
    
public  voidsetFeatureType(String featureType)
    
public  voidsetFormat(String format)
    
public  voidsetHeight(int height)
    
public  voidsetLayer(FeatureType layer)
    
public  voidsetLegendOptions(Map legendOptions)
    
public  voidsetRule(Rule rule)
    
public  voidsetScale(double scale)
    
public  voidsetStyle(Style style)
    
public  voidsetTransparent(boolean transparentBackground)
     Sets the value of the background transparency flag depending on the value of the TRANSPARENT request parameter.
public  voidsetWidth(int width)
    

Field Detail
DEFAULT_FORMAT
final public static String DEFAULT_FORMAT(Code)
The default image format in which to produce a legend graphic. Not really used when performing user requests, since FORMAT is a mandatory parameter, but by now serves as a default for expressing LegendURL layer attribute in GetCapabilities.



DEFAULT_HEIGHT
final public static int DEFAULT_HEIGHT(Code)
default legend graphic height, in pixels, to apply if no WIDTH parameter was passed



DEFAULT_WIDTH
final public static int DEFAULT_WIDTH(Code)
default legend graphic width, in pixels, to apply if no WIDTH parameter was passed



SLD_VERSION
final public static String SLD_VERSION(Code)
DOCUMENT ME!




Constructor Detail
GetLegendGraphicRequest
public GetLegendGraphicRequest(WMService service)(Code)
Creates a new GetLegendGraphicRequest object.
Parameters:
  service - The service that will handle the request




Method Detail
getExceptionsFormat
public String getExceptionsFormat()(Code)
DOCUMENT ME! DOCUMENT ME!



getFeatureType
public String getFeatureType()(Code)
DOCUMENT ME! DOCUMENT ME!



getFormat
public String getFormat()(Code)
DOCUMENT ME! DOCUMENT ME!



getHeight
public int getHeight()(Code)
DOCUMENT ME! DOCUMENT ME!



getLayer
public FeatureType getLayer()(Code)
DOCUMENT ME! DOCUMENT ME!



getLegendOptions
public Map getLegendOptions()(Code)



getRule
public Rule getRule()(Code)
DOCUMENT ME! DOCUMENT ME!



getScale
public double getScale()(Code)
DOCUMENT ME! DOCUMENT ME!



getStyle
public Style getStyle()(Code)
DOCUMENT ME! DOCUMENT ME!



getWidth
public int getWidth()(Code)
DOCUMENT ME! DOCUMENT ME!



isTransparent
public boolean isTransparent()(Code)
Returns the value of the optional request parameter TRANSPARENT, which might be either the literal true or false and specifies if the background of the legend graphic to return shall be transparent or not.

If the TRANSPARENT parameter is not specified, this property defaults to false.

whether the legend graphic background shall be transparent or not



setExceptionsFormat
public void setExceptionsFormat(String exceptionsFormat)(Code)
DOCUMENT ME!
Parameters:
  exceptionsFormat - DOCUMENT ME!



setFeatureType
public void setFeatureType(String featureType)(Code)
DOCUMENT ME!
Parameters:
  featureType - DOCUMENT ME!



setFormat
public void setFormat(String format)(Code)
DOCUMENT ME!
Parameters:
  format - DOCUMENT ME!



setHeight
public void setHeight(int height)(Code)
DOCUMENT ME!
Parameters:
  height - DOCUMENT ME!



setLayer
public void setLayer(FeatureType layer)(Code)
DOCUMENT ME!
Parameters:
  layer - DOCUMENT ME!



setLegendOptions
public void setLegendOptions(Map legendOptions)(Code)



setRule
public void setRule(Rule rule)(Code)
DOCUMENT ME!
Parameters:
  rule - DOCUMENT ME!



setScale
public void setScale(double scale)(Code)
DOCUMENT ME!
Parameters:
  scale - DOCUMENT ME!



setStyle
public void setStyle(Style style)(Code)
DOCUMENT ME!
Parameters:
  style - DOCUMENT ME!



setTransparent
public void setTransparent(boolean transparentBackground)(Code)
Sets the value of the background transparency flag depending on the value of the TRANSPARENT request parameter.
Parameters:
  transparentBackground - whether the legend graphic background shall be transparent ornot



setWidth
public void setWidth(int width)(Code)
DOCUMENT ME!
Parameters:
  width - DOCUMENT ME!



Fields inherited from org.vfny.geoserver.wms.requests.WMSRequest
final public static String WMS_SERVICE_TYPE(Code)(Java Doc)

Methods inherited from org.vfny.geoserver.wms.requests.WMSRequest
public GeoServer getGeoServer()(Code)(Java Doc)
public WMS getWMS()(Code)(Java Doc)
public WMService getWMService()(Code)(Java Doc)
public void setWMService(WMService wms)(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.