Export SLD Operation Plugin Tutorial

Goals

After completing this tutorial, you will have gained the skills to:

• Create a new Plugin
• Define a new Extension
• Implement a new Operation Extension

Create a New Plugin

1. Open the Plug-in Development perspective (click on )
2. From the File menu, select New > Project…. Select Plug-in Project from the dialog, and then click the Next button.
   
   Figure 1 - New Plug-in Project
3. Create a name for the plug-in by entering net.refractions.udig.sld.export in the Project Name text field and click the Next button.
   
   Figure 2 - Naming the New Plug-in
4. Accept the default values used to generate the plug-in and click the Finish button.
   
   Figure 3 - New Plug-in Details
   At this point the feature editor plug-in is created. Configuring the plug-in is the focus of the next section.

Configuring Your New Plug-in

In this section you will configure the feature editor plug-in. Specifically, you will specify dependencies on other plug-ins in order to create a new feature editor.

1. Open the Plug-in Development perspective.
2. In the Package Explorer navigate to the plug-in created in the previous section. Open the plug-in manifest by navigating to the META-INF/MANIFEST.MF file under the root of the feature editor plug-in. Double click on the file to open the plug-in manifest editor.
   
   Figure 4 - Plug-in Manifest Editor
3. Open the plug-in dependencies by clicking on the Dependencies tab located at the bottom of the editor area.
4. Click the Add… button in the Required plugins column and add the following plugin:
   

• net.refractions.udig.project
• net.refractions.udig.project.ui
• net.refractions.udig.style.sld
• net.refractions.udig.udig.ui
  
  Figure 5 - Add New Plugin Dependencies

1. At this point it is critical that you Save your work as the dependencies need to propagate into the project.
   
   Figure 6 - Plug-in Dependencies

Import Resources Into Project

In this section we are going to set up an icon directory and import the pictures we will use for our export SLD operation.

1. Download [^] and [^] to your desktop (Right click and Save Link As...)
2. Select your plug-in project, net.refractions.udig.tutorials.distancetool, in the Package Explorer.
3. Select File â†' New â†' Folder from the Menubar.
4. Enter icons/etool16 as the folder name.
5. Click the Finish button.
6. Select icons directory.
7. Select File â†' New â†' Folder from the Menubar.
8. Enter pointers as the folder name.
9. Click the Finish button.
   
10. Right click on etool16 and select Import.
11. Select File System.
    
12. Click on browse and choose Desktop from the list (this will populate the directory field).
13. Select the measure_mode.gif file and press Finish.
    
14. Import the measure_source.gif file into the pointers directory following the same steps.

Define a New Extension

1. Open the extensions page by clicking on the Extensions tab

1. Click the Add… button
2. Select the net.refractions.udig.ui.operation extension point from the list.
   
3. Click the Finish button.
4. Enter the following Extention Details:
   • ID: net.refractions.udig.sld.export
   • Name: SLD Export to File
     

Create a New Operation

1. Right click on newly added extension, net.refractions.udig.ui.operation, and select New > Operation
2. Replace the default data in the id field with net.refractions.udig.style.sld.export.ExportSLD.
3. Enter net.refractions.udig.sld.export.ExportSLD into the class field.
4. Enter icons/etool16/ into the icon field.
   (Or press the Browse button and locate the icon)
5. Enter Export SLD into the name field.
6. Enter net.refractions.udig.project.ui.exportOps into the categoryId field.
   

Implementing a export operation

1. Select net.refractions.udig.style.sld.export.ExportSLD (operation) in the Extensions editor.
2. It is a child of the net.refractions.udig.style.sld.export.
3. Click the class hotlink.

1. A dialog is brought up describing the class to be created, Check Generate comments and Inherited abstract methods.
   
2. Press Finish, if not available ensure that all the information is in agreement with the picture above.

Add the following code to your created class

public class ExportSLD implements IOp {

    public class QueryAndSave implements Runnable {

        private String out;
        private Layer layer;
        private IProgressMonitor monitor;
        private Display display;

        public QueryAndSave( Layer layer, String out, Display display, IProgressMonitor monitor ) {
            this.layer=layer;
            this.out=out;
            this.display=display;
            this.monitor=monitor;
        }
        File file;
        public void run() {
            do{
                if (!getFile())
                    return;
                boolean write=true;
                if( file.exists() ){
                write=MessageDialog.openConfirm(display.getActiveShell(), Messages.getString("ExportSLD.saveAs"),  //$NON-NLS-1$
                            file.getAbsolutePath()+Messages.getString("ExportSLD.exists") + //$NON-NLS-1$
                                    Messages.getString("ExportSLD.replace")); //$NON-NLS-1$
                }
                
                if( write ){
                try {
                    FileWriter writer=new FileWriter(file, false);
                    writer.write(out);
                    writer.close();
                } catch (Exception e) {
                    file=null;
                    MessageDialog.openError(display.getActiveShell(), Messages.getString("ExportSLD.saveAs"),//$NON-NLS-1$
                            Messages.getString("ExportSLD.modifyError")); //$NON-NLS-1$
                }
                }else{
                    file=null;
                }
            }while( file==null );
        }

        private boolean getFile() {
            FileDialog fileDialog=new FileDialog(display.getActiveShell(),SWT.SAVE);
            fileDialog.setFilterExtensions(new String[]{"*.sld"}); //$NON-NLS-1$
            fileDialog.setFilterNames(new String[]{Messages.getString("ExportSLD.SLD")}); //$NON-NLS-1$
            String name=layer.getName();
            if( name==null ){
                try {
                    name=layer.getGeoResource().getInfo(monitor).getTitle();
                } catch (IOException e) {
                    ExportPlugin.log("error getting name from layer's georesource", e); //$NON-NLS-1$
                }
                if( name==null ){
                    try {
                        name=layer.getGeoResource().getInfo(monitor).getName();
                    } catch (IOException e) {
                        ExportPlugin.log("error getting name from layer's georesource", e); //$NON-NLS-1$
                    }
                }
            }
             if( name!=null)
                 fileDialog.setFileName(name+".sld"); //$NON-NLS-1$
            String path=fileDialog.open();
            if( path==null)
                return false;
            file=new File(path);
            return true;
        }
    }
    public void op( Display display, Object target, IProgressMonitor monitor ) throws Exception {
        Layer layer=(Layer) target;
        Style style=(Style) layer.getStyleBlackboard().get(SLDContent.ID);

        // serialize out the style objects
        SLDTransformer sldWriter = new SLDTransformer();
        String out = ""; //$NON-NLS-1$
        try {
            out = sldWriter.transform(style);
        } catch (TransformerException e) {
            ExportPlugin.log(null, e);
            e.printStackTrace();
        } catch (Exception e) {
            ExportPlugin.log(null, e);
        }
        display.asyncExec(new QueryAndSave(layer, out, display, monitor));
    }
}

1. Click the OK button.

1. 1. And then save the file. This should refresh the project and clear up any error markers left behind.

Optional You may check your work against the completed plugin code available here: Download: net.refractions.udig.sld.export_1.0.0.jar Save in your udig plugins directory. Right clicking on any layer will now let you export a SLD file net.refractions.udig.sld.export_1.0.0.jar archive file. This file is suitable for use with GeoServer. Source code Avaiable here: http://svn.geotools.org/udig/trunk/community/jesse/net.refractions.udig.sld.export/ svn co http://svn.geotools.org/udig/trunk/community/jesse/net.refractions.udig.sld.export/

Testing The Plug-in

1. From the Project menu select Run and choose the configuration you set-up in the previous tutorial (see 1 SDK Quickstart).