Java Doc for GetMapProducerFactorySpi.java in  » GIS » GeoServer » org » vfny » geoserver » wms » 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 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.vfny.geoserver.wms.GetMapProducerFactorySpi

All known Subclasses:   org.vfny.geoserver.wms.responses.map.geotiff.GeoTiffMapProducerFactory,  org.vfny.geoserver.wms.responses.map.openlayers.OpenLayersMapProducerFactory,  org.vfny.geoserver.wms.responses.map.kml.KMZMapProducerFactory,  org.vfny.geoserver.wms.responses.map.gif.GifMapProducerFactory,  org.vfny.geoserver.wms.responses.map.tiff.TiffMapProducerFactory,  org.vfny.geoserver.wms.responses.map.pdf.PDFMapProducerFactory,  org.vfny.geoserver.wms.responses.map.svg.SvgMapProducerFactory,  org.vfny.geoserver.wms.responses.map.kml.KMLMapProducerFactory,  org.vfny.geoserver.wms.responses.TestMapProducerFactory,  org.vfny.geoserver.wms.responses.map.jpeg.JPEGMapProducerFactory,  org.vfny.geoserver.wms.responses.map.georss.GeoRSSMapProducerFactory,  org.vfny.geoserver.wms.responses.map.png.PNGMapProducerFactory,
GetMapProducerFactorySpi
public interface GetMapProducerFactorySpi extends Factory(Code)
Constructs a live GetMapProducer.

An instance of this interface should exist for all map producers which want to take advantage of the dynamic plugin system. In addition to implementing this interface GetMap producers should have a services file:

org.vfny.geoserver.responses.wms.GetMapProducerFactorySpi

The file should contain a single line which gives the full name of the implementing class.

example:
e.g. org.vfny.geoserver.wms.GIFLegendGraphicProducerSpi

The factories are never called directly by client code, instead the GeoTools' FactoryFinder class is used.

The following example shows how a user might obtain GetMapProducer capable of generating a map image in GIF format and send the generated legend to a file:


 WMSConfig config = getServletContext().getAttribute(WMSConfig.CONFIG_KEY);
 GetMapProducerSpi gmpf = null;
 Iterator it = FactoryFinder.factories(GeMapProducerFactorySpi.class);
 while (it.hasNext()) {
 GeMapProducerFactorySpi tmpGmpf = (GeMapProducerFactorySpi) it.next();
 if (tmpGmpf.canProduce("image/gif")) {
 gmpf = tmpGmpf;
 break;
 }
 }
 ...
 GetMapProducer producer = gmpf.createMapProducer("image/gif");
 WMSMapContext ctx = ...
 producer.produceMap(ctx);
 OutputStream out = new FileOutputStream("/map.gif");
 producer.writeTo(out);
 


author:
   Gabriel Roldan, Axios Engineering
version:
   $Id: GetMapProducerFactorySpi.java 6326 2007-03-15 18:36:40Z jdeolive $




Method Summary
 booleancanProduce(String mapFormat)
     Returns wether the legend producers created by this factory can create map images in the specified output format.
Parameters:
  mapFormat - a MIME type string to check if this producer is able tohandle.
 GetMapProducercreateMapProducer(String mapFormat, WMS wms)
     Creates and instance of a GetMapProducer suitable to create map images in the specified image format.
 StringgetName()
     Returns a descriptive name for the factory instance.
 SetgetSupportedFormats()
     Returns a java.util.Set<String> of the MIME types the map producers this factory can create are able to handle.
 booleanisAvailable()
     Checks if the GetMapProducer instances this factory serves will be able of working properly (e.g., external dependencies are in place).



Method Detail
canProduce
boolean canProduce(String mapFormat)(Code)
Returns wether the legend producers created by this factory can create map images in the specified output format.
Parameters:
  mapFormat - a MIME type string to check if this producer is able tohandle. true if mimeType is an image formatsupported by the producers this factory serves.



createMapProducer
GetMapProducer createMapProducer(String mapFormat, WMS wms) throws IllegalArgumentException(Code)
Creates and instance of a GetMapProducer suitable to create map images in the specified image format.
Parameters:
  mapFormat - the MIME type of the desired image
Parameters:
  wms - the WMS module a GetMapProducer capable of creating maps in formatimage format.
throws:
  IllegalArgumentException - if format is not one ofthe MIME types this producer can create images in.



getName
String getName()(Code)
Returns a descriptive name for the factory instance. a descriptive name for the factory instance



getSupportedFormats
Set getSupportedFormats()(Code)
Returns a java.util.Set<String> of the MIME types the map producers this factory can create are able to handle. the Set of supported output image mime types.



isAvailable
boolean isAvailable()(Code)
Checks if the GetMapProducer instances this factory serves will be able of working properly (e.g., external dependencies are in place). This method should be used to avoid asking for producer instances if they are likely to fail. wether this factory is able to produce producer instances.



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