X-Git-Url: http://gitweb.fperrin.net/?a=blobdiff_plain;f=tim%2Fprune%2Fsave%2FGpxExporter.java;fp=tim%2Fprune%2Fsave%2FGpxExporter.java;h=019cc438bdbf96003595e7c7ebe7d84654839d11;hb=1ee49ae3c8ef3aa2e63eadd458531e5f8bd4f92c;hp=0bd93d2f0926ad09b6cdc73b637b464f006a6011;hpb=112bb0c9b46894adca9a33ed8c99ea712b253185;p=GpsPrune.git diff --git a/tim/prune/save/GpxExporter.java b/tim/prune/save/GpxExporter.java index 0bd93d2..019cc43 100644 --- a/tim/prune/save/GpxExporter.java +++ b/tim/prune/save/GpxExporter.java @@ -13,27 +13,30 @@ import java.io.OutputStreamWriter; import java.io.Writer; import javax.swing.BorderFactory; +import javax.swing.Box; import javax.swing.BoxLayout; import javax.swing.JButton; import javax.swing.JCheckBox; import javax.swing.JDialog; import javax.swing.JFileChooser; +import javax.swing.JFrame; import javax.swing.JLabel; import javax.swing.JOptionPane; import javax.swing.JPanel; import javax.swing.JTextField; import tim.prune.App; -import tim.prune.Config; import tim.prune.GenericFunction; import tim.prune.GpsPruner; import tim.prune.I18nManager; import tim.prune.UpdateMessageBroker; +import tim.prune.config.Config; import tim.prune.data.Altitude; import tim.prune.data.Coordinate; import tim.prune.data.DataPoint; +import tim.prune.data.Field; import tim.prune.data.Timestamp; -import tim.prune.data.Track; +import tim.prune.data.TrackInfo; import tim.prune.load.GenericFileFilter; /** @@ -42,17 +45,15 @@ import tim.prune.load.GenericFileFilter; */ public class GpxExporter extends GenericFunction implements Runnable { - private Track _track = null; + private TrackInfo _trackInfo = null; private JDialog _dialog = null; private JTextField _nameField = null; private JTextField _descriptionField = null; private PointTypeSelector _pointTypeSelector = null; private JCheckBox _timestampsCheckbox = null; - private JFileChooser _fileChooser = null; + private JCheckBox _copySourceCheckbox = null; private File _exportFile = null; - /** version number of Gpx */ - private static final String GPX_VERSION_NUMBER = "1.0"; /** this program name */ private static final String GPX_CREATOR = "Prune v" + GpsPruner.VERSION_NUMBER + " activityworkshop.net"; @@ -64,7 +65,7 @@ public class GpxExporter extends GenericFunction implements Runnable public GpxExporter(App inApp) { super(inApp); - _track = inApp.getTrackInfo().getTrack(); + _trackInfo = inApp.getTrackInfo(); } /** Get name key */ @@ -111,13 +112,19 @@ public class GpxExporter extends GenericFunction implements Runnable _descriptionField = new JTextField(10); descPanel.add(_descriptionField); mainPanel.add(descPanel); + mainPanel.add(Box.createVerticalStrut(5)); // point type selection (track points, waypoints, photo points) _pointTypeSelector = new PointTypeSelector(); mainPanel.add(_pointTypeSelector); - // checkbox for timestamps + // checkboxes for timestamps and copying + JPanel checkPanel = new JPanel(); _timestampsCheckbox = new JCheckBox(I18nManager.getText("dialog.exportgpx.includetimestamps")); _timestampsCheckbox.setSelected(true); - mainPanel.add(_timestampsCheckbox); + checkPanel.add(_timestampsCheckbox); + _copySourceCheckbox = new JCheckBox(I18nManager.getText("dialog.exportgpx.copysource")); + _copySourceCheckbox.setSelected(true); + checkPanel.add(_copySourceCheckbox); + mainPanel.add(checkPanel); dialogPanel.add(mainPanel, BorderLayout.CENTER); // button panel at bottom @@ -154,28 +161,45 @@ public class GpxExporter extends GenericFunction implements Runnable { // OK pressed, so check selections if (!_pointTypeSelector.getAnythingSelected()) { + JOptionPane.showMessageDialog(_parentFrame, I18nManager.getText("dialog.save.notypesselected"), + I18nManager.getText("dialog.saveoptions.title"), JOptionPane.WARNING_MESSAGE); return; } // Choose output file - if (_fileChooser == null) + File saveFile = chooseGpxFile(_parentFrame); + if (saveFile != null) { - _fileChooser = new JFileChooser(); - _fileChooser.setDialogType(JFileChooser.SAVE_DIALOG); - _fileChooser.setFileFilter(new GenericFileFilter("filetype.gpx", new String[] {"gpx"})); - _fileChooser.setAcceptAllFileFilterUsed(false); - // start from directory in config which should be set - String configDir = Config.getConfigString(Config.KEY_TRACK_DIR); - if (configDir != null) {_fileChooser.setCurrentDirectory(new File(configDir));} + // New file or overwrite confirmed, so initiate export in separate thread + _exportFile = saveFile; + new Thread(this).start(); } + } + + /** + * Select a GPX file to save to + * @param inParentFrame parent frame for file chooser dialog + * @return selected File, or null if selection cancelled + */ + public static File chooseGpxFile(JFrame inParentFrame) + { + File saveFile = null; + JFileChooser fileChooser = new JFileChooser(); + fileChooser.setDialogType(JFileChooser.SAVE_DIALOG); + fileChooser.setFileFilter(new GenericFileFilter("filetype.gpx", new String[] {"gpx"})); + fileChooser.setAcceptAllFileFilterUsed(false); + // start from directory in config which should be set + String configDir = Config.getConfigString(Config.KEY_TRACK_DIR); + if (configDir != null) {fileChooser.setCurrentDirectory(new File(configDir));} + // Allow choose again if an existing file is selected boolean chooseAgain = false; do { chooseAgain = false; - if (_fileChooser.showSaveDialog(_parentFrame) == JFileChooser.APPROVE_OPTION) + if (fileChooser.showSaveDialog(inParentFrame) == JFileChooser.APPROVE_OPTION) { // OK pressed and file chosen - File file = _fileChooser.getSelectedFile(); + File file = fileChooser.getSelectedFile(); // Check file extension if (!file.getName().toLowerCase().endsWith(".gpx")) { @@ -183,25 +207,25 @@ public class GpxExporter extends GenericFunction implements Runnable } // Check if file exists and if necessary prompt for overwrite Object[] buttonTexts = {I18nManager.getText("button.overwrite"), I18nManager.getText("button.cancel")}; - if (!file.exists() || JOptionPane.showOptionDialog(_parentFrame, + if (!file.exists() || JOptionPane.showOptionDialog(inParentFrame, I18nManager.getText("dialog.save.overwrite.text"), I18nManager.getText("dialog.save.overwrite.title"), JOptionPane.YES_NO_OPTION, JOptionPane.WARNING_MESSAGE, null, buttonTexts, buttonTexts[1]) == JOptionPane.YES_OPTION) { - // New file or overwrite confirmed, so initiate export in separate thread - _exportFile = file; - new Thread(this).start(); + // new file or overwrite confirmed + saveFile = file; } else { + // file exists and overwrite cancelled - select again chooseAgain = true; } } } while (chooseAgain); + return saveFile; } - /** * Run method for controlling separate thread for exporting */ @@ -213,10 +237,11 @@ public class GpxExporter extends GenericFunction implements Runnable // normal writing to file writer = new OutputStreamWriter(new FileOutputStream(_exportFile)); boolean[] saveFlags = {_pointTypeSelector.getTrackpointsSelected(), _pointTypeSelector.getWaypointsSelected(), - _pointTypeSelector.getPhotopointsSelected(), _timestampsCheckbox.isSelected()}; + _pointTypeSelector.getPhotopointsSelected(), _pointTypeSelector.getJustSelection(), + _timestampsCheckbox.isSelected()}; // write file - final int numPoints = exportData(writer, _track, _nameField.getText(), - _descriptionField.getText(), saveFlags); + final int numPoints = exportData(writer, _trackInfo, _nameField.getText(), + _descriptionField.getText(), saveFlags, _copySourceCheckbox.isSelected()); // close file writer.close(); @@ -249,23 +274,22 @@ public class GpxExporter extends GenericFunction implements Runnable /** * Export the information to the given writer * @param inWriter writer object - * @param inTrack track object containing data + * @param inInfo track info object * @param inName name of track (optional) * @param inDesc description of track (optional) * @param inSaveFlags array of booleans to export tracks, waypoints, photos, timestamps + * @param inUseCopy true to copy source if available * @return number of points written * @throws IOException if io errors occur on write */ - public static int exportData(OutputStreamWriter inWriter, Track inTrack, String inName, - String inDesc, boolean[] inSaveFlags) throws IOException + public static int exportData(OutputStreamWriter inWriter, TrackInfo inInfo, String inName, + String inDesc, boolean[] inSaveFlags, boolean inUseCopy) throws IOException { - inWriter.write("\n\n"); + // Instantiate source file cachers in case we want to copy output + GpxCacherList gpxCachers = null; + if (inUseCopy) gpxCachers = new GpxCacherList(inInfo.getFileInfo()); + // Write or copy header + inWriter.write(getHeaderString(gpxCachers)); // Name field String trackName = "PruneTrack"; if (inName != null && !inName.equals("")) @@ -280,8 +304,7 @@ public class GpxExporter extends GenericFunction implements Runnable if (inDesc != null && !inDesc.equals("")) { inWriter.write(inDesc); } - else - { + else { inWriter.write("Export from Prune"); } inWriter.write("\n"); @@ -292,56 +315,141 @@ public class GpxExporter extends GenericFunction implements Runnable final boolean exportTrackpoints = inSaveFlags[0]; final boolean exportWaypoints = inSaveFlags[1]; final boolean exportPhotos = inSaveFlags[2]; - final boolean exportTimestamps = inSaveFlags[3]; + final boolean exportSelection = inSaveFlags[3]; + final boolean exportTimestamps = inSaveFlags[4]; + // Examine selection + int selStart = -1, selEnd = -1; + if (exportSelection) { + selStart = inInfo.getSelection().getStart(); + selEnd = inInfo.getSelection().getEnd(); + } // Loop over waypoints - final int numPoints = inTrack.getNumPoints(); + final int numPoints = inInfo.getTrack().getNumPoints(); int numSaved = 0; for (i=0; i=selStart && i<=selEnd)) { + // Make a wpt element for each waypoint + if (point.isWaypoint()) { + if (exportWaypoints) + { + String pointSource = (inUseCopy?gpxCachers.getSourceString(point):null); + if (pointSource != null) { + inWriter.write(pointSource); + inWriter.write('\n'); + } + else { + exportWaypoint(point, inWriter, exportTimestamps); + } + numSaved++; + } + } + else { + hasTrackpoints = true; } } - else - { - hasTrackpoints = true; - } } - // Output the track, if there is one - if (hasTrackpoints) + // Export both route points and then track points + if (hasTrackpoints && (exportTrackpoints || exportPhotos)) + { + // Output all route points (if any) + numSaved += writeTrackPoints(inWriter, inInfo, exportSelection, exportTrackpoints, exportPhotos, + exportTimestamps, true, gpxCachers, "1\n", null, "\t\n"); + // Output all track points, if any + String trackStart = "\t" + trackName + "1\n"; + numSaved += writeTrackPoints(inWriter, inInfo, exportSelection, exportTrackpoints, exportPhotos, + exportTimestamps, false, gpxCachers, "\n\t\n", + "\t\n"); + } + + inWriter.write("\n"); + return numSaved; + } + + /** + * Loop through the track outputting the relevant track points + * @param inWriter writer object for output + * @param inInfo track info object containing track + * @param inExportSelection true to just output current selection + * @param inExportTrackpoints true to output track points + * @param inExportPhotos true to output photo points + * @param exportTimestamps true to include timestamps in export + * @param inOnlyCopies true to only export if source can be copied + * @param inCachers list of GpxCachers + * @param inPointTag tag to match for each point + * @param inStartTag start tag to output + * @param inSegmentTag tag to output between segments (or null) + * @param inEndTag end tag to output + */ + private static int writeTrackPoints(OutputStreamWriter inWriter, + TrackInfo inInfo, boolean inExportSelection, boolean inExportTrackpoints, + boolean inExportPhotos, boolean exportTimestamps, boolean inOnlyCopies, + GpxCacherList inCachers, String inPointTag, String inStartTag, + String inSegmentTag, String inEndTag) + throws IOException + { + // Note: far too many input parameters to this method but avoids duplication + // of output functionality for writing track points and route points + int numPoints = inInfo.getTrack().getNumPoints(); + int selStart = inInfo.getSelection().getStart(); + int selEnd = inInfo.getSelection().getEnd(); + int numSaved = 0; + // Loop over track points + for (int i=0; i" + trackName + "1\n"); - // Loop over track points - for (i=0; i=selStart && i<=selEnd)) && !point.isWaypoint()) { - point = inTrack.getPoint(i); - // restart track segment if necessary - if (point.getSegmentStart() && !firstPoint) { - inWriter.write("\t\n\t\n"); - } - if (!point.isWaypoint()) + if ((point.getPhoto()==null && inExportTrackpoints) || (point.getPhoto()!=null && inExportPhotos)) { - if ((point.getPhoto()==null && exportTrackpoints) || (point.getPhoto()!=null && exportPhotos)) + // get the source from the point (if any) + String pointSource = (inCachers!=null?inCachers.getSourceString(point):null); + boolean writePoint = (pointSource != null && pointSource.toLowerCase().startsWith(inPointTag)) + || (pointSource == null && !inOnlyCopies); + if (writePoint) { - // export the point - exportTrackpoint(point, inWriter, exportTimestamps); + // restart track segment if necessary + if ((numSaved > 0) && point.getSegmentStart() && (inSegmentTag != null)) { + inWriter.write(inSegmentTag); + } + if (numSaved == 0) {inWriter.write(inStartTag);} + if (pointSource != null) { + inWriter.write(pointSource); + inWriter.write('\n'); + } + else { + if (!inOnlyCopies) {exportTrackpoint(point, inWriter, exportTimestamps);} + } numSaved++; - firstPoint = false; } } } - inWriter.write("\t\n"); } - inWriter.write("\n"); + if (numSaved > 0) {inWriter.write(inEndTag);} return numSaved; } + /** + * Get the header string for the gpx + * @param inCachers cacher list to ask for headers, if available + * @return header string from cachers or as default + */ + private static String getHeaderString(GpxCacherList inCachers) + { + String gpxHeader = null; + if (inCachers != null) {gpxHeader = inCachers.getFirstHeader();} + if (gpxHeader == null || gpxHeader.length() < 5) + { + // Create default (1.0) header + gpxHeader = "\n"; + } + return "\n" + gpxHeader + "\n"; + } + /** * Export the specified waypoint into the file * @param inPoint waypoint to export @@ -364,10 +472,6 @@ public class GpxExporter extends GenericFunction implements Runnable inWriter.write("" + inPoint.getAltitude().getStringValue(Altitude.Format.METRES)); inWriter.write("\n"); } - // write waypoint name after elevation - inWriter.write("\t\t"); - inWriter.write(inPoint.getWaypointName().trim()); - inWriter.write("\n"); // timestamp if available (point might have timestamp and then be turned into a waypoint) if (inPoint.hasTimestamp() && inTimestamps) { @@ -375,7 +479,22 @@ public class GpxExporter extends GenericFunction implements Runnable inWriter.write(inPoint.getTimestamp().getText(Timestamp.FORMAT_ISO_8601)); inWriter.write("\n"); } - // TODO: Include waypt type in Gpx + // write waypoint name after elevation and time + inWriter.write("\t\t"); + inWriter.write(inPoint.getWaypointName().trim()); + inWriter.write("\n"); + // write waypoint type if any + String type = inPoint.getFieldValue(Field.WAYPT_TYPE); + if (type != null) + { + type = type.trim(); + if (!type.equals("")) + { + inWriter.write("\t\t"); + inWriter.write(type); + inWriter.write("\n"); + } + } inWriter.write("\t\n"); }