/* * Copyright (C) 2011-2012 Dr. John Lindsay <jlindsay@uoguelph.ca> * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see <http://www.gnu.org/licenses/>. */ package plugins; import whitebox.geospatialfiles.ShapeFile; import whitebox.geospatialfiles.shapefile.*; import whitebox.geospatialfiles.shapefile.attributes.DBFField; import whitebox.interfaces.WhiteboxPlugin; import whitebox.interfaces.WhiteboxPluginHost; /** * This tool converts vector lines or polygons into points. * * @author Dr. John Lindsay email: jlindsay@uoguelph.ca */ public class ExtractNodes implements WhiteboxPlugin { private WhiteboxPluginHost myHost = null; private String[] args; /** * Used to retrieve the plugin tool's name. This is a short, unique name * containing no spaces. * * @return String containing plugin name. */ @Override public String getName() { return "ExtractNodes"; } /** * Used to retrieve the plugin tool's descriptive name. This can be a longer * name (containing spaces) and is used in the interface to list the tool. * * @return String containing the plugin descriptive name. */ @Override public String getDescriptiveName() { return "Extract Nodes"; } /** * Used to retrieve a short description of what the plugin tool does. * * @return String containing the plugin's description. */ @Override public String getToolDescription() { return "Converts vector polygons/lines to point nodes"; } /** * Used to identify which toolboxes this plugin tool should be listed in. * * @return Array of Strings. */ @Override public String[] getToolbox() { String[] ret = { "ConversionTools" }; return ret; } /** * Sets the WhiteboxPluginHost to which the plugin tool is tied. This is the * class that the plugin will send all feedback messages, progress updates, * and return objects. * * @param host The WhiteboxPluginHost that called the plugin tool. */ @Override public void setPluginHost(WhiteboxPluginHost host) { myHost = host; } /** * Used to communicate feedback pop-up messages between a plugin tool and * the main Whitebox user-interface. * * @param feedback String containing the text to display. */ private void showFeedback(String message) { if (myHost != null) { myHost.showFeedback(message); } else { System.out.println(message); } } /** * Used to communicate a return object from a plugin tool to the main * Whitebox user-interface. * * @return Object, such as an output WhiteboxRaster. */ private void returnData(Object ret) { if (myHost != null) { myHost.returnData(ret); } } private int previousProgress = 0; private String previousProgressLabel = ""; /** * Used to communicate a progress update between a plugin tool and the main * Whitebox user interface. * * @param progressLabel A String to use for the progress label. * @param progress Float containing the progress value (between 0 and 100). */ private void updateProgress(String progressLabel, int progress) { if (myHost != null && ((progress != previousProgress) || (!progressLabel.equals(previousProgressLabel)))) { myHost.updateProgress(progressLabel, progress); } previousProgress = progress; previousProgressLabel = progressLabel; } /** * Used to communicate a progress update between a plugin tool and the main * Whitebox user interface. * * @param progress Float containing the progress value (between 0 and 100). */ private void updateProgress(int progress) { if (myHost != null && progress != previousProgress) { myHost.updateProgress(progress); } previousProgress = progress; } /** * Sets the arguments (parameters) used by the plugin. * * @param args An array of string arguments. */ @Override public void setArgs(String[] args) { this.args = args.clone(); } private boolean cancelOp = false; /** * Used to communicate a cancel operation from the Whitebox GUI. * * @param cancel Set to true if the plugin should be canceled. */ @Override public void setCancelOp(boolean cancel) { cancelOp = cancel; } private void cancelOperation() { showFeedback("Operation cancelled."); updateProgress("Progress: ", 0); } private boolean amIActive = false; /** * Used by the Whitebox GUI to tell if this plugin is still running. * * @return a boolean describing whether or not the plugin is actively being * used. */ @Override public boolean isActive() { return amIActive; } /** * Used to execute this plugin tool. */ @Override public void run() { /* This tool places the nodes (vertices) from a shapefile of polygons * or lines into a shapefile of Point ShapeType. */ amIActive = true; String inputFile; String outputFile; double x, y; int progress; int i, n; double[][] vertices = null; //int pointNum = 0; int numFeatures; int oneHundredthTotal; ShapeType shapeType, outputShapeType; if (args.length <= 0) { showFeedback("Plugin parameters have not been set."); return; } inputFile = args[0]; outputFile = args[1]; // check to see that the inputHeader and outputHeader are not null. if ((inputFile == null) || (outputFile == null)) { showFeedback("One or more of the input parameters have not been set properly."); return; } try { // set up the input shapefile. ShapeFile input = new ShapeFile(inputFile); shapeType = input.getShapeType(); // make sure that the shapetype is either a flavour of polyline or polygon. if (shapeType.getBaseType() != ShapeType.POLYGON && shapeType.getBaseType() != ShapeType.POLYLINE) { showFeedback("This tool only works with shapefiles of a polygon or line base shape type."); return; } // set up the output files of the shapefile and the dbf outputShapeType = ShapeType.POINT; int numOutputFields = input.getAttributeTable().getFieldCount() + 1; int numInputFields = input.getAttributeTable().getFieldCount(); DBFField[] inputFields = input.getAttributeTable().getAllFields(); DBFField fields[] = new DBFField[numOutputFields]; fields[0] = new DBFField(); fields[0].setName("PARENT_ID"); fields[0].setDataType(DBFField.DBFDataType.NUMERIC); fields[0].setFieldLength(10); fields[0].setDecimalCount(0); System.arraycopy(inputFields, 0, fields, 1, numInputFields); ShapeFile output = new ShapeFile(outputFile, outputShapeType, fields); output.setProjectionStringFromOtherShapefile(input); numFeatures = input.getNumberOfRecords(); oneHundredthTotal = numFeatures / 100; //featureNum = 0; n = 0; progress = 0; int recordNum; for (ShapeFileRecord record : input.records) { recordNum = record.getRecordNumber(); Object[] attData = input.getAttributeTable().getRecord(recordNum - 1); vertices = new double[0][0]; switch (shapeType) { case POLYGON: whitebox.geospatialfiles.shapefile.Polygon recPolygon = (whitebox.geospatialfiles.shapefile.Polygon) (record.getGeometry()); vertices = recPolygon.getPoints(); break; case POLYGONZ: PolygonZ recPolygonZ = (PolygonZ)(record.getGeometry()); vertices = recPolygonZ.getPoints(); break; case POLYGONM: PolygonM recPolygonM = (PolygonM)(record.getGeometry()); vertices = recPolygonM.getPoints(); break; case POLYLINE: PolyLine recPolyline = (PolyLine)(record.getGeometry()); vertices = recPolyline.getPoints(); break; case POLYLINEZ: PolyLineZ recPolylineZ = (PolyLineZ)(record.getGeometry()); vertices = recPolylineZ.getPoints(); break; case POLYLINEM: PolyLineM recPolylineM = (PolyLineM)(record.getGeometry()); vertices = recPolylineM.getPoints(); break; } for (i = 0; i < vertices.length; i++) { x = vertices[i][0]; y = vertices[i][1]; Object[] rowData = new Object[numOutputFields]; rowData[0] = (double) recordNum - 1; System.arraycopy(attData, 0, rowData, 1, numInputFields); output.addRecord(new whitebox.geospatialfiles.shapefile.Point(x, y), rowData); } n++; if (n >= oneHundredthTotal) { n = 0; if (cancelOp) { cancelOperation(); return; } progress++; updateProgress(progress); } } output.write(); // returning a header file string displays the image. updateProgress("Displaying vector: ", 0); returnData(outputFile); } catch (OutOfMemoryError oe) { myHost.showFeedback("An out-of-memory error has occurred during operation."); } catch (Exception e) { myHost.showFeedback("An error has occurred during operation. See log file for details."); myHost.logException("Error in " + getDescriptiveName(), e); } finally { updateProgress("Progress: ", 0); // tells the main application that this process is completed. amIActive = false; myHost.pluginComplete(); } } // /** // * This method is only used during testing. // */ // //This method is only used during testing. // public static void main(String[] args) { // args = new String[2]; // args[0] = "/Users/johnlindsay/Documents/Research/Contracts/NRCan 2012/Data/tmp1.shp"; // args[1] = "/Users/johnlindsay/Documents/Research/Contracts/NRCan 2012/Data/tmp3.shp"; // // ExtractNodes en = new ExtractNodes(); // en.setArgs(args); // en.run(); // } }