Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

JOSM #22322 - Add tag list popup menu actions to create filters for selected tags #102

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+342 −22
Open

JOSM #22322 - Add tag list popup menu actions to create filters for selected tags #102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
155 changes: 133 additions & 22 deletions src/org/openstreetmap/josm/gui/dialogs/properties/PropertiesDialog.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
package org.openstreetmap.josm.gui.dialogs.properties;

import static org.openstreetmap.josm.tools.I18n.tr;
import static org.openstreetmap.josm.tools.I18n.trn;

import java.awt.Component;
import java.awt.Container;
Expand All @@ -22,11 +23,13 @@
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.OptionalInt;
import java.util.Set;
import java.util.TreeMap;
import java.util.TreeSet;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.stream.Collectors;
import java.util.stream.IntStream;

import javax.swing.AbstractAction;
import javax.swing.JComponent;
Expand All @@ -41,6 +44,7 @@
import javax.swing.event.ListSelectionEvent;
import javax.swing.event.ListSelectionListener;
import javax.swing.event.PopupMenuEvent;
import javax.swing.event.PopupMenuListener;
import javax.swing.event.RowSorterEvent;
import javax.swing.event.RowSorterListener;
import javax.swing.table.DefaultTableCellRenderer;
Expand All @@ -63,6 +67,7 @@
import org.openstreetmap.josm.data.osm.DataSelectionListener;
import org.openstreetmap.josm.data.osm.DataSet;
import org.openstreetmap.josm.data.osm.DefaultNameFormatter;
import org.openstreetmap.josm.data.osm.Filter;
import org.openstreetmap.josm.data.osm.IPrimitive;
import org.openstreetmap.josm.data.osm.IRelation;
import org.openstreetmap.josm.data.osm.IRelationMember;
Expand Down Expand Up @@ -90,6 +95,7 @@
import org.openstreetmap.josm.gui.PopupMenuHandler;
import org.openstreetmap.josm.gui.SideButton;
import org.openstreetmap.josm.gui.datatransfer.ClipboardUtils;
import org.openstreetmap.josm.gui.dialogs.FilterTableModel;
import org.openstreetmap.josm.gui.dialogs.ToggleDialog;
import org.openstreetmap.josm.gui.dialogs.relation.RelationEditor;
import org.openstreetmap.josm.gui.dialogs.relation.RelationPopupMenus;
Expand Down Expand Up @@ -211,6 +217,8 @@ public class PropertiesDialog extends ToggleDialog
tagTable, editHelper::getDataKey, OsmDataManager.getInstance()::getInProgressISelection).registerShortcut(); /* NO-SHORTCUT */
private final SearchAction searchActionSame = new SearchAction(true);
private final SearchAction searchActionAny = new SearchAction(false);
private final FilterAction filterActionHide = new FilterAction(true);
private final FilterAction filterActionShowOnly = new FilterAction(false);
private final AddAction addAction = new AddAction();
private final EditAction editAction = new EditAction();
private final DeleteAction deleteAction = new DeleteAction();
Expand Down Expand Up @@ -465,6 +473,10 @@ private void setupTagsMenu() {
tagMenu.addSeparator();
tagMenu.add(searchActionAny);
tagMenu.add(searchActionSame);
tagMenu.add(filterActionHide);
tagMenu.addPopupMenuListener(filterActionHide);
tagMenu.add(filterActionShowOnly);
tagMenu.addPopupMenuListener(filterActionShowOnly);
tagMenu.addSeparator();
tagMenu.add(helpTagAction);
tagMenu.add(tagHistoryAction);
Expand Down Expand Up @@ -1347,38 +1359,137 @@ public void actionPerformed(ActionEvent e) {
}
}

static SearchSetting createSearchSetting(String key, Collection<? extends IPrimitive> sel, boolean sameType) {
String sep = "";
StringBuilder s = new StringBuilder();
Set<String> consideredTokens = new TreeSet<>();
for (IPrimitive p : sel) {
String val = p.get(key);
if (val == null || (!sameType && consideredTokens.contains(val))) {
continue;
class FilterAction extends AbstractAction implements PopupMenuListener {
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stupid question: is there any particular reason why you aren't using JosmAction?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly for similarity with all the other actions in the context menu which are also simply using AbstractAction. We don't really need any features that JosmAction provides (no shortcuts, listeners, etc...) so we wouldn't gain a lot from using it. Setting the icon etc... would be a tiny bit simplified.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair enough.


private final boolean hideMatching;

FilterAction(boolean hideMatching) {
setName(hideMatching, 0);
putValue(SHORT_DESCRIPTION, hideMatching ? tr("Add a filter that hides objects with the selected tags") :
tr("Add a filter that shows only objects with the selected tags"));
new ImageProvider("dialogs/filter").getResource().attachImageIcon(this, true);
this.hideMatching = hideMatching;
}

private void setName(boolean hideMatching, long n) {
if (hideMatching) {
putValue(NAME, trn("Hide objects with selected tag", "Hide objects with selected tags", n));
} else {
putValue(NAME, trn("Show only objects with selected tag", "Show only objects with selected tags", n));
}
String t = "";
if (!sameType) {
t = "";
} else if (p instanceof Node) {
t = "type:node ";
} else if (p instanceof Way) {
t = "type:way ";
} else if (p instanceof Relation) {
t = "type:relation ";
}

@Override
public void actionPerformed(ActionEvent e) {
Filter newFilter = createFilterForSelectedTags();
if (newFilter == null)
return;

FilterTableModel filterModel = MainApplication.getMap().filterDialog.getFilterModel();

OptionalInt existingFilterIndex = IntStream.range(0, filterModel.getRowCount())
.filter(i -> {
Filter f = filterModel.getValue(i);
return f.equals(newFilter) && f.inverted == !hideMatching;
}).findFirst();

if (existingFilterIndex.isPresent()) {
Logging.debug("Enabling existing equivalent filter: {0}", existingFilterIndex);
filterModel.setValueAt(true, existingFilterIndex.getAsInt(), FilterTableModel.COL_ENABLED);
} else {
newFilter.inverted = !hideMatching;
Logging.debug("Adding new filter {0}", newFilter);
filterModel.addFilter(newFilter);
}
}

private Filter createFilterForSelectedTags() {
List<String> keys = editHelper.getDataKeys(tagTable.getSelectedRows());
Collection<? extends IPrimitive> sel = OsmDataManager.getInstance().getInProgressISelection();

return createFilterForKeys(keys, sel);
}

@Override
public void popupMenuWillBecomeVisible(PopupMenuEvent e) {
setName(hideMatching, tagTable.getSelectedRows().length);
}

@Override
public void popupMenuCanceled(PopupMenuEvent e) {
// Do nothing
}

@Override
public void popupMenuWillBecomeInvisible(PopupMenuEvent e) {
// Do nothing
}
}

static SearchSetting createSearchSetting(String key, Collection<? extends IPrimitive> sel, boolean sameType) {
return createSearchSetting(Collections.singletonList(key), sel, sameType);
}

static SearchSetting createSearchSetting(Collection<String> keys, Collection<? extends IPrimitive> sel, boolean sameType) {
StringBuilder complete = new StringBuilder();
String keySep = "";
for (String key : keys) {
StringBuilder keyString = new StringBuilder();
Set<String> consideredTokens = new TreeSet<>();
String valueSep = "";
int valueCount = 0;

for (IPrimitive p : sel) {
String val = p.get(key);
if (val == null || (!sameType && consideredTokens.contains(val))) {
continue;
}
String t = "";
if (!sameType) {
t = "";
} else if (p instanceof Node) {
t = "type:node ";
} else if (p instanceof Way) {
t = "type:way ";
} else if (p instanceof Relation) {
t = "type:relation ";
}
String token = new StringBuilder(t).append(val).toString();
if (consideredTokens.add(token)) {
keyString.append(valueSep).append('(').append(t).append(SearchCompiler.buildSearchStringForTag(key, val)).append(')');
valueSep = " OR ";
valueCount++;
}
}
String token = new StringBuilder(t).append(val).toString();
if (consideredTokens.add(token)) {
s.append(sep).append('(').append(t).append(SearchCompiler.buildSearchStringForTag(key, val)).append(')');
sep = " OR ";

if (keys.size() > 1) {
complete.append(keySep);
keySep = " AND ";

if (valueCount > 1) {
complete.append('(').append(keyString).append(')');
} else {
complete.append(keyString);
}
} else {
complete.append(keyString);
}
}

final SearchSetting ss = new SearchSetting();
ss.text = s.toString();
ss.text = complete.toString();
ss.caseSensitive = true;
return ss;
}

static Filter createFilterForKeys(List<String> keys, Collection<? extends IPrimitive> prims) {
if (prims == null || prims.isEmpty())
return null;

final SearchSetting ss = createSearchSetting(keys, prims, false);
return new Filter(ss);
}

/**
* Clears the row selection when it is filtered away by the row sorter.
*/
Expand Down
12 changes: 12 additions & 0 deletions src/org/openstreetmap/josm/gui/dialogs/properties/TagEditHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,18 @@ public final String getDataKey(int viewRow) {
return tagData.getValueAt(tagTable.convertRowIndexToModel(viewRow), 0).toString();
}

/**
* Finds the keys for given rows of tag editor.
* @param viewRows index of rows
* @return keys of tags
* @since xxx
*/
public final List<String> getDataKeys(int[] viewRows) {
return Arrays.stream(viewRows).boxed()
.map(r -> tagData.getValueAt(tagTable.convertRowIndexToModel(r), 0).toString())
.collect(Collectors.toList());
Comment on lines +253 to +255
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think you need to do boxing here.

Suggested change
return Arrays.stream(viewRows).boxed()
.map(r -> tagData.getValueAt(tagTable.convertRowIndexToModel(r), 0).toString())
.collect(Collectors.toList());
return Arrays.stream(viewRows).map(tagTable::convertRowIndexToModel)
.mapToObj(r -> tagData.getValueAt(r, 0).toString()).collect(Collectors.toList());

}

/**
* Determines if the given tag key is already used (by all selected primitives, not just some of them)
* @param key the key to check
Expand Down
Loading