/*
* Copyright (C) 2013 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 java.io.*;
import whitebox.geospatialfiles.ShapeFile;
import whitebox.geospatialfiles.shapefile.*;
import whitebox.interfaces.WhiteboxPlugin;
import whitebox.interfaces.WhiteboxPluginHost;
import com.vividsolutions.jts.geom.Geometry;
import com.vividsolutions.jts.io.gml2.*;
import whitebox.interfaces.InteropPlugin;
/**
* This tool can be used to export a vector shapefile file to an Geography Markup Language (GML) file.
*
* @author Dr. John Lindsay email: jlindsay@uoguelph.ca
*/
public class ExportGML implements WhiteboxPlugin, InteropPlugin {
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 "ExportGML";
}
/**
* 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 "Export Geography Markup Language (GML)";
}
/**
* Used to retrieve a short description of what the plugin tool does.
*
* @return String containing the plugin's description.
*/
@Override
public String getToolDescription() {
return "Exports a vector to a geography markup language (GML) format.";
}
/**
* Used to identify which toolboxes this plugin tool should be listed in.
*
* @return Array of Strings.
*/
@Override
public String[] getToolbox() {
String[] ret = {"IOTools"};
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() {
amIActive = true;
String ouptutFile = null;
String shapefileName = null;
int i = 0;
int row, col, rows, cols;
InputStream inStream = null;
OutputStream outStream = null;
int progress = 0;
Geometry[] JTSGeometries;
GMLWriter gmlWriter = new GMLWriter();
String str1 = null;
FileWriter fw = null;
BufferedWriter bw = null;
PrintWriter out = null;
if (args.length <= 0) {
showFeedback("Plugin parameters have not been set.");
return;
}
String inputFilesString = args[0];
// check to see that the inputHeader and outputHeader are not null.
if (inputFilesString.isEmpty()) {
showFeedback("One or more of the input parameters have not been set properly.");
return;
}
String[] imageFiles = inputFilesString.split(";");
int numFiles = imageFiles.length;
try {
for (i = 0; i < numFiles; i++) {
if (numFiles > 1) {
progress = (int) (100f * i / (numFiles - 1));
updateProgress("Loop " + (i + 1) + " of " + numFiles + ":", progress);
}
shapefileName = imageFiles[i];
if (!((new File(shapefileName)).exists())) {
showFeedback("Vector file does not exist.");
break;
}
ShapeFile shapefile = new ShapeFile(shapefileName);
// arc file name.
ouptutFile = shapefileName.replace(".shp", ".gml");
// see if it exists, and if so, delete it.
(new File(ouptutFile)).delete();
fw = new FileWriter(ouptutFile, false);
bw = new BufferedWriter(fw);
out = new PrintWriter(bw, true);
progress = 0;
int n = 0;
int onePercentOfRecs = shapefile.getNumberOfRecords() / 100;
for (ShapeFileRecord record : shapefile.records) {
if (record.getShapeType() != ShapeType.NULLSHAPE) {
JTSGeometries = record.getGeometry().getJTSGeometries();
for (int a = 0; a < JTSGeometries.length; a++) {
str1 = gmlWriter.write(JTSGeometries[a]);
out.println(str1);
}
}
if (cancelOp) {
cancelOperation();
return;
}
n++;
if (n == onePercentOfRecs) {
n = 0;
progress++;
updateProgress("Exporting shapefile data:", progress);
}
}
}
showFeedback("Operation complete!");
} 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 {
if (out != null || bw != null) {
out.flush();
out.close();
}
updateProgress("Progress: ", 0);
// tells the main application that this process is completed.
amIActive = false;
myHost.pluginComplete();
}
}
/**
* Used to retrieve the necessary extensions.
* @return String containing the extensions.
*/
@Override
public String[] getExtensions() {
return new String[]{ "txt" };
}
/**
* Used to retrieve the file type name.
* @return String containing the file type name.
*/
@Override
public String getFileTypeName() {
return "ArcGIS ASCII Grid";
}
/**
* Used to check if the file is raster format.
* @return Boolean true if file is raster format.
*/
@Override
public boolean isRasterFormat() {
return true;
}
/**
* Used to retrieve the interoperable plugin type.
* @return
*/
@Override
public InteropPlugin.InteropPluginType getInteropPluginType() {
return InteropPlugin.InteropPluginType.exportPlugin;
}
}