q = this.tryParseSearchTerm(wizardSearchTerm);
- if (q.isPresent()) {
- String query = q.get();
- OverpassDownloadDialog.getInstance().setOverpassQuery(query);
-
- return true;
- }
-
- return false;
- }
-
- private static JTextComponent buildDescriptionSection() {
- JEditorPane descriptionSection = new JEditorPane("text/html", getDescriptionContent());
- descriptionSection.setEditable(false);
- descriptionSection.addHyperlinkListener(e -> {
- if (HyperlinkEvent.EventType.ACTIVATED.equals(e.getEventType())) {
- OpenBrowser.displayUrl(e.getURL().toString());
- }
- });
-
- return descriptionSection;
- }
-
- private static String getDescriptionContent() {
- return new StringBuilder("")
- .append(DESCRIPTION_STYLE)
- .append("")
- .append(HEADLINE_START)
- .append(tr("Query Wizard"))
- .append(HEADLINE_END)
- .append("")
- .append(tr("Allows you to interact with Overpass API by writing declarative, human-readable terms."))
- .append(tr("The Query Wizard tool will transform those to a valid overpass query."))
- .append(tr("For more detailed description see "))
- .append(tr("OSM Wiki.", Main.getOSMWebsite() + "/wiki/Overpass_turbo/Wizard"))
- .append("
")
- .append(HEADLINE_START).append(tr("Hints")).append(HEADLINE_END)
- .append("").append(TR_START).append(TD_START)
- .append(Utils.joinAsHtmlUnorderedList(Arrays.asList("type:node", "type:relation", "type:way")))
- .append(TD_END).append(TD_START)
- .append("").append(tr("Download objects of a certain type.")).append("")
- .append(TD_END).append(TR_END)
- .append(TR_START).append(TD_START)
- .append(Utils.joinAsHtmlUnorderedList(
- Arrays.asList("key=value in location",
- "key=value around location",
- "key=value in bbox")))
- .append(TD_END).append(TD_START)
- .append(tr("Download object by specifying a specific location. For example,"))
- .append(Utils.joinAsHtmlUnorderedList(Arrays.asList(
- tr("{0} all objects having {1} as attribute are downloaded.", "tourism=hotel in Berlin -", "'tourism=hotel'"),
- tr("{0} all object with the corresponding key/value pair located around Berlin. Note, the default value for radius "+
- "is set to 1000m, but it can be changed in the generated query.", "tourism=hotel around Berlin -"),
- tr("{0} all objects within the current selection that have {1} as attribute.", "tourism=hotel in bbox -",
- "'tourism=hotel'"))))
- .append("")
- .append(tr("Instead of location any valid place name can be used like address, city, etc."))
- .append("")
- .append(TD_END).append(TR_END)
- .append(TR_START).append(TD_START)
- .append(Utils.joinAsHtmlUnorderedList(Arrays.asList("key=value", "key=*", "key~regex",
- "key!=value", "key!~regex", "key=\"combined value\"")))
- .append(TD_END).append(TD_START)
- .append(tr("Download objects that have some concrete key/value pair, only the key with any contents for the value, " +
- "the value matching some regular expression. 'Not equal' operators are supported as well."))
- .append(TD_END).append(TR_END)
- .append(TR_START).append(TD_START)
- .append(Utils.joinAsHtmlUnorderedList(Arrays.asList(
- tr("expression1 {0} expression2", "or"),
- tr("expression1 {0} expression2", "and"))))
- .append(TD_END).append(TD_START)
- .append("")
- .append(tr("Basic logical operators can be used to create more sophisticated queries. Instead of 'or' - '|', '||' " +
- "can be used, and instead of 'and' - '&', '&&'."))
- .append("")
- .append(TD_END).append(TR_END).append("
")
- .append("")
- .append("")
- .toString();
- }
- }
}
Index: trunk/src/org/openstreetmap/josm/gui/download/OverpassQueryWizardDialog.java
===================================================================
--- trunk/src/org/openstreetmap/josm/gui/download/OverpassQueryWizardDialog.java (revision 12576)
+++ trunk/src/org/openstreetmap/josm/gui/download/OverpassQueryWizardDialog.java (revision 12576)
@@ -0,0 +1,242 @@
+// License: GPL. For details, see LICENSE file.
+package org.openstreetmap.josm.gui.download;
+
+import static org.openstreetmap.josm.tools.I18n.tr;
+
+import java.awt.GridBagLayout;
+import java.awt.event.ActionEvent;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.Optional;
+
+import javax.swing.JEditorPane;
+import javax.swing.JLabel;
+import javax.swing.JOptionPane;
+import javax.swing.JPanel;
+import javax.swing.JScrollPane;
+import javax.swing.event.HyperlinkEvent;
+import javax.swing.text.JTextComponent;
+
+import org.openstreetmap.josm.Main;
+import org.openstreetmap.josm.actions.OverpassDownloadAction.OverpassDownloadDialog;
+import org.openstreetmap.josm.data.preferences.CollectionProperty;
+import org.openstreetmap.josm.gui.ExtendedDialog;
+import org.openstreetmap.josm.gui.util.GuiHelper;
+import org.openstreetmap.josm.gui.widgets.HistoryComboBox;
+import org.openstreetmap.josm.tools.GBC;
+import org.openstreetmap.josm.tools.OpenBrowser;
+import org.openstreetmap.josm.tools.OverpassTurboQueryWizard;
+import org.openstreetmap.josm.tools.UncheckedParseException;
+import org.openstreetmap.josm.tools.Utils;
+
+/**
+ * This dialog provides an easy and fast way to create an overpass query.
+ * @since 12576
+ */
+public final class OverpassQueryWizardDialog extends ExtendedDialog {
+
+ private static final String HEADLINE_START = "";
+ private static final String HEADLINE_END = "
";
+ private static final String TR_START = "";
+ private static final String TR_END = "
";
+ private static final String TD_START = "";
+ private static final String TD_END = " | ";
+ private final HistoryComboBox queryWizard;
+ private final OverpassTurboQueryWizard overpassQueryBuilder;
+ private static final CollectionProperty OVERPASS_WIZARD_HISTORY =
+ new CollectionProperty("download.overpass.wizard", new ArrayList());
+
+ // dialog buttons
+ private static final int BUILD_QUERY = 0;
+ private static final int BUILD_AN_EXECUTE_QUERY = 1;
+ private static final int CANCEL = 2;
+
+ private static final String DESCRIPTION_STYLE =
+ "\n";
+
+ private final OverpassDownloadDialog parentDialog;
+
+ /**
+ * Create a new {@link OverpassQueryWizardDialog}
+ * @param parentDialog The parent this dialog should be displayed for
+ */
+ public OverpassQueryWizardDialog(OverpassDownloadDialog parentDialog) {
+ super(parentDialog, tr("Overpass Turbo Query Wizard"),
+ tr("Build query"), tr("Build query and execute"), tr("Cancel"));
+ this.parentDialog = parentDialog;
+
+ this.queryWizard = new HistoryComboBox();
+ this.overpassQueryBuilder = OverpassTurboQueryWizard.getInstance();
+
+ JPanel panel = new JPanel(new GridBagLayout());
+
+ JLabel searchLabel = new JLabel(tr("Search :"));
+ JTextComponent descPane = buildDescriptionSection();
+ JScrollPane scroll = GuiHelper.embedInVerticalScrollPane(descPane);
+ scroll.getVerticalScrollBar().setUnitIncrement(10); // make scrolling smooth
+
+ panel.add(searchLabel, GBC.std().insets(0, 0, 0, 20).anchor(GBC.SOUTHEAST));
+ panel.add(queryWizard, GBC.eol().insets(0, 0, 0, 15).fill(GBC.HORIZONTAL).anchor(GBC.SOUTH));
+ panel.add(scroll, GBC.eol().fill(GBC.BOTH).anchor(GBC.CENTER));
+
+ queryWizard.setPossibleItems(OVERPASS_WIZARD_HISTORY.get());
+
+ setCancelButton(CANCEL);
+ setDefaultButton(BUILD_AN_EXECUTE_QUERY + 1); // Build and execute button
+ setContent(panel, false);
+ }
+
+ @Override
+ public void buttonAction(int buttonIndex, ActionEvent evt) {
+ switch (buttonIndex) {
+ case BUILD_QUERY:
+ if (this.buildQueryAction()) {
+ this.saveHistory();
+ super.buttonAction(BUILD_QUERY, evt);
+ }
+ break;
+ case BUILD_AN_EXECUTE_QUERY:
+ if (this.buildQueryAction()) {
+ this.saveHistory();
+ super.buttonAction(BUILD_AN_EXECUTE_QUERY, evt);
+
+ parentDialog.triggerDownload();
+ }
+ break;
+ default:
+ super.buttonAction(buttonIndex, evt);
+
+ }
+ }
+
+ /**
+ * Saves the latest, successfully parsed search term.
+ */
+ private void saveHistory() {
+ queryWizard.addCurrentItemToHistory();
+ OVERPASS_WIZARD_HISTORY.put(queryWizard.getHistory());
+ }
+
+ /**
+ * Tries to process a search term using {@link OverpassTurboQueryWizard}. If the term cannot
+ * be parsed, the the corresponding dialog is shown.
+ * @param searchTerm The search term to parse.
+ * @return {@link Optional#empty()} if an exception was thrown when parsing, meaning
+ * that the term cannot be processed, or non-empty {@link Optional} containing the result
+ * of parsing.
+ */
+ private Optional tryParseSearchTerm(String searchTerm) {
+ try {
+ String query = this.overpassQueryBuilder.constructQuery(searchTerm);
+
+ return Optional.of(query);
+ } catch (UncheckedParseException ex) {
+ Main.error(ex);
+ JOptionPane.showMessageDialog(
+ parentDialog,
+ "" +
+ tr("The Overpass wizard could not parse the following query:") +
+ Utils.joinAsHtmlUnorderedList(Collections.singleton(searchTerm)) +
+ "",
+ tr("Parse error"),
+ JOptionPane.ERROR_MESSAGE
+ );
+
+ return Optional.empty();
+ }
+ }
+
+ /**
+ * Builds an Overpass query out from {@link OverpassQueryWizardDialog#queryWizard} contents.
+ * @return {@code true} if the query successfully built, {@code false} otherwise.
+ */
+ private boolean buildQueryAction() {
+ final String wizardSearchTerm = this.queryWizard.getText();
+
+ Optional q = this.tryParseSearchTerm(wizardSearchTerm);
+ if (q.isPresent()) {
+ String query = q.get();
+ parentDialog.setOverpassQuery(query);
+
+ return true;
+ }
+
+ return false;
+ }
+
+ private static JTextComponent buildDescriptionSection() {
+ JEditorPane descriptionSection = new JEditorPane("text/html", getDescriptionContent());
+ descriptionSection.setEditable(false);
+ descriptionSection.addHyperlinkListener(e -> {
+ if (HyperlinkEvent.EventType.ACTIVATED.equals(e.getEventType())) {
+ OpenBrowser.displayUrl(e.getURL().toString());
+ }
+ });
+
+ return descriptionSection;
+ }
+
+ private static String getDescriptionContent() {
+ return new StringBuilder("")
+ .append(DESCRIPTION_STYLE)
+ .append("")
+ .append(HEADLINE_START)
+ .append(tr("Query Wizard"))
+ .append(HEADLINE_END)
+ .append("")
+ .append(tr("Allows you to interact with Overpass API by writing declarative, human-readable terms."))
+ .append(tr("The Query Wizard tool will transform those to a valid overpass query."))
+ .append(tr("For more detailed description see "))
+ .append(tr("OSM Wiki.", Main.getOSMWebsite() + "/wiki/Overpass_turbo/Wizard"))
+ .append("
")
+ .append(HEADLINE_START).append(tr("Hints")).append(HEADLINE_END)
+ .append("").append(TR_START).append(TD_START)
+ .append(Utils.joinAsHtmlUnorderedList(Arrays.asList("type:node", "type:relation", "type:way")))
+ .append(TD_END).append(TD_START)
+ .append("").append(tr("Download objects of a certain type.")).append("")
+ .append(TD_END).append(TR_END)
+ .append(TR_START).append(TD_START)
+ .append(Utils.joinAsHtmlUnorderedList(
+ Arrays.asList("key=value in location",
+ "key=value around location",
+ "key=value in bbox")))
+ .append(TD_END).append(TD_START)
+ .append(tr("Download object by specifying a specific location. For example,"))
+ .append(Utils.joinAsHtmlUnorderedList(Arrays.asList(
+ tr("{0} all objects having {1} as attribute are downloaded.", "tourism=hotel in Berlin -", "'tourism=hotel'"),
+ tr("{0} all object with the corresponding key/value pair located around Berlin. Note, the default value for radius "+
+ "is set to 1000m, but it can be changed in the generated query.", "tourism=hotel around Berlin -"),
+ tr("{0} all objects within the current selection that have {1} as attribute.", "tourism=hotel in bbox -",
+ "'tourism=hotel'"))))
+ .append("")
+ .append(tr("Instead of location any valid place name can be used like address, city, etc."))
+ .append("")
+ .append(TD_END).append(TR_END)
+ .append(TR_START).append(TD_START)
+ .append(Utils.joinAsHtmlUnorderedList(Arrays.asList("key=value", "key=*", "key~regex",
+ "key!=value", "key!~regex", "key=\"combined value\"")))
+ .append(TD_END).append(TD_START)
+ .append(tr("Download objects that have some concrete key/value pair, only the key with any contents for the value, " +
+ "the value matching some regular expression. 'Not equal' operators are supported as well."))
+ .append(TD_END).append(TR_END)
+ .append(TR_START).append(TD_START)
+ .append(Utils.joinAsHtmlUnorderedList(Arrays.asList(
+ tr("expression1 {0} expression2", "or"),
+ tr("expression1 {0} expression2", "and"))))
+ .append(TD_END).append(TD_START)
+ .append("")
+ .append(tr("Basic logical operators can be used to create more sophisticated queries. Instead of 'or' - '|', '||' " +
+ "can be used, and instead of 'and' - '&', '&&'."))
+ .append("")
+ .append(TD_END).append(TR_END).append("
")
+ .append("")
+ .append("")
+ .toString();
+ }
+}