Merge pull request #58 from qupath/advanced-search-improvements

Advanced search improvements

Author: Rylern

build.gradle.kts

@@ -7,7 +7,7 @@ plugins {
 qupathExtension {
     name = "qupath-extension-omero"
     group = "io.github.qupath"
-    version = "0.1.0-rc9"
+    version = "0.1.0-rc10"
     description = "QuPath extension to support image reading using OMERO APIs"
     automaticModule = "io.github.qupath.extension.omero"
 }

src/main/java/qupath/ext/omero/core/entities/search/SearchResult.java

@@ -1,6 +1,5 @@
 package qupath.ext.omero.core.entities.search;
 
-import org.checkerframework.checker.nullness.qual.Nullable;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import qupath.ext.omero.core.entities.repositoryentities.RepositoryEntity;
@@ -23,8 +22,16 @@
  * <p>
  * This class can create usable results from an HTML search query response
  * (usually from {@code https://omero-server/webclient/load_searching/form}).
+ *
+ * @param type the type of the object (e.g. dataset, image)
+ * @param id the id of the object
+ * @param name the name of the object
+ * @param group the group name whose object belongs to
+ * @param link a URL linking to the object
+ * @param dateAcquired the date this object was acquired. Can be null
+ * @param dateImported the date this object was imported. Can be null
  */
-public class SearchResult {
+public record SearchResult(String type, int id, String name, Date dateAcquired, Date dateImported, String group, String link) {
 
     private static final Logger logger = LoggerFactory.getLogger(SearchResult.class);
     private static final DateFormat OMERO_DATE_FORMAT = new SimpleDateFormat("EEE, dd MMM yyyy hh:mm:ss Z");
@@ -33,44 +40,6 @@ public class SearchResult {
     private static final Pattern DATE_PATTERN = Pattern.compile("<td class=\"date\" data-isodate='(.+?)'></td>");
     private static final Pattern GROUP_PATTERN = Pattern.compile("<td class=\"group\">(.+?)</td>");
     private static final Pattern LINK_PATTERN = Pattern.compile("<td><a href=\"(.+?)\"");
-    private final String type;
-    private final int id;
-    private final String name;
-    private final Date dateAcquired;
-    private final Date dateImported;
-    private final String group;
-    private final String link;
-
-    /**
-     * Creates a new search result corresponding to an OMERO object.
-     * You should rather use {@link #createFromHTMLResponse(String, URI)}
-     * to create search results.
-     *
-     * @param type the type of the object (e.g. dataset, image)
-     * @param id the id of the object
-     * @param name the name of the object
-     * @param group the group name whose object belongs to
-     * @param link a URL linking to the object
-     * @param dateAcquired the date this object was acquired
-     * @param dateImported the date this object was imported
-     */
-    public SearchResult(
-            String type,
-            int id,
-            String name,
-            String group,
-            String link,
-            @Nullable Date dateAcquired,
-            @Nullable Date dateImported
-    ) {
-        this.type = type;
-        this.id = id;
-        this.name = name;
-        this.dateAcquired = dateAcquired;
-        this.dateImported = dateImported;
-        this.group = group;
-        this.link = link;
-    }
 
     @Override
     public boolean equals(Object obj) {
@@ -119,10 +88,10 @@ public static List<SearchResult> createFromHTMLResponse(String htmlResponse, URI
                         rowMatcher.group(1),
                         Integer.parseInt(rowMatcher.group(2)),
                         findPatternInText(DESCRIPTION_PATTERN, row).orElse("-"),
-                        findPatternInText(GROUP_PATTERN, row).orElse("-"),
-                        serverURI + findPatternInText(LINK_PATTERN, row).orElse(""),
                         acquiredDate,
-                        importedDate
+                        importedDate,
+                        findPatternInText(GROUP_PATTERN, row).orElse("-"),
+                        serverURI + findPatternInText(LINK_PATTERN, row).orElse("")
                 ));
             } catch (Exception e) {
                 logger.warn("Could not parse search result.", e);
@@ -132,11 +101,6 @@ public static List<SearchResult> createFromHTMLResponse(String htmlResponse, URI
         return searchResults;
     }
 
-    @Override
-    public String toString() {
-        return String.format("Search result: %s of ID %d and name %s", type, id, name);
-    }
-
     /**
      * @return the class of the type (e.g. image, dataset) of the result, or an empty Optional if not found
      */
@@ -158,50 +122,6 @@ public Optional<Class<? extends RepositoryEntity>> getType() {
         }
     }
 
-    /**
-     * @return the ID of the result
-     */
-    public int getId() {
-        return id;
-    }
-
-    /**
-     * @return the name of the result
-     */
-    public String getName() {
-        return name;
-    }
-
-    /**
-     * @return the date the result was acquired, or an empty Optional
-     * if the date couldn't be retrieved
-     */
-    public Optional<Date> getDateAcquired() {
-        return Optional.ofNullable(dateAcquired);
-    }
-
-    /**
-     * @return the date the result was imported, or an empty Optional
-     * if the date couldn't be retrieved
-     */
-    public Optional<Date> getDateImported() {
-        return Optional.ofNullable(dateImported);
-    }
-
-    /**
-     * @return the group name of the result
-     */
-    public String getGroupName() {
-        return group;
-    }
-
-    /**
-     * @return a link to open the result in a web browser
-     */
-    public String getLink() {
-        return link;
-    }
-
     private static Optional<String> findPatternInText(Pattern pattern, String text) {
         return findPatternInText(pattern, text, 0);
     }

src/main/java/qupath/ext/omero/gui/browser/advancedsearch/AdvancedSearch.java

@@ -15,7 +15,6 @@
 import javafx.scene.control.TableColumn;
 import javafx.scene.control.TableView;
 import javafx.scene.control.TextField;
-import javafx.scene.input.KeyCode;
 import javafx.scene.input.KeyEvent;
 import javafx.scene.layout.GridPane;
 import javafx.stage.Stage;
@@ -31,6 +30,7 @@
 import qupath.ext.omero.core.entities.search.SearchResult;
 import qupath.ext.omero.gui.UiUtilities;
 import qupath.ext.omero.gui.browser.advancedsearch.cellfactories.LinkCellFactory;
+import qupath.ext.omero.gui.browser.advancedsearch.cellfactories.TextCellFactory;
 import qupath.ext.omero.gui.browser.advancedsearch.cellfactories.TypeCellFactory;
 import qupath.fx.dialogs.Dialogs;
 
@@ -74,10 +74,10 @@ public class AdvancedSearch extends Stage {
     @FXML
     private CheckBox screens;
     @FXML
-    private ComboBox<Owner> owner;
-    @FXML
     private ComboBox<Group> group;
     @FXML
+    private ComboBox<Owner> owner;
+    @FXML
     private Button search;
     @FXML
     private Button importImage;
@@ -178,65 +178,79 @@ private void onImportButtonClicked(ActionEvent ignoredEvent) {
     private void initUI(Stage ownerWindow) throws IOException {
         UiUtilities.loadFXML(this, AdvancedSearch.class.getResource("advanced_search.fxml"));
 
-        owner.getItems().setAll(server.getOwners());
-        owner.getItems().add(Owner.getAllMembersOwner());
-        owner.getSelectionModel().select(server.getConnectedOwner());
-        owner.setConverter(new StringConverter<>() {
+        group.getItems().setAll(Group.getAllGroupsGroup());
+        group.getItems().addAll(server.getGroups());
+        group.getSelectionModel().select(server.getDefaultGroup());
+        group.setConverter(new StringConverter<>() {
             @Override
-            public String toString(Owner owner) {
-                return owner == null ? "" : owner.getFullName();
+            public String toString(Group object) {
+                return object == null ? "" : object.getName();
             }
+
             @Override
-            public Owner fromString(String string) {
+            public Group fromString(String string) {
                 return null;
             }
         });
 
-        group.getItems().setAll(server.getGroups());
-        group.getItems().add(Group.getAllGroupsGroup());
-        group.getSelectionModel().select(server.getDefaultGroup());
-        group.setConverter(new StringConverter<>() {
+        owner.getItems().setAll(Owner.getAllMembersOwner());
+        owner.getItems().addAll(group.getSelectionModel().getSelectedItem().getOwners());
+        owner.getSelectionModel().select(server.getConnectedOwner());
+        owner.setConverter(new StringConverter<>() {
             @Override
-            public String toString(Group object) {
-                return object == null ? "" : object.getName();
+            public String toString(Owner owner) {
+                return owner == null ? "" : owner.getFullName();
             }
-
             @Override
-            public Group fromString(String string) {
+            public Owner fromString(String string) {
                 return null;
             }
         });
 
         results.getSelectionModel().setSelectionMode(SelectionMode.MULTIPLE);
 
         typeColumn.setCellValueFactory(n -> new ReadOnlyObjectWrapper<>(n.getValue()));
-        nameColumn.setCellValueFactory(n -> new ReadOnlyStringWrapper(n.getValue().getName()));
-        acquiredColumn.setCellValueFactory(n -> new ReadOnlyStringWrapper(n.getValue().getDateAcquired().isPresent() ?
-                DATE_FORMAT.format(n.getValue().getDateAcquired().get()) : ""
+        nameColumn.setCellValueFactory(n -> new ReadOnlyStringWrapper(n.getValue().name()));
+        acquiredColumn.setCellValueFactory(n -> new ReadOnlyStringWrapper(n.getValue().dateAcquired() == null ?
+                "" : DATE_FORMAT.format(n.getValue().dateAcquired())
         ));
-        importedColumn.setCellValueFactory(n -> new ReadOnlyStringWrapper(n.getValue().getDateImported().isPresent() ?
-                DATE_FORMAT.format(n.getValue().getDateImported().get()) : ""
+        importedColumn.setCellValueFactory(n -> new ReadOnlyStringWrapper(n.getValue().dateImported() == null ?
+                "" : DATE_FORMAT.format(n.getValue().dateImported())
         ));
-        groupColumn.setCellValueFactory(n -> new ReadOnlyStringWrapper(n.getValue().getGroupName()));
+        groupColumn.setCellValueFactory(n -> new ReadOnlyStringWrapper(n.getValue().group()));
         linkColumn.setCellValueFactory(n -> new ReadOnlyObjectWrapper<>(n.getValue()));
 
         typeColumn.setCellFactory(n -> new TypeCellFactory(apisHandler));
+        nameColumn.setCellFactory(n -> new TextCellFactory());
+        acquiredColumn.setCellFactory(n -> new TextCellFactory());
+        importedColumn.setCellFactory(n -> new TextCellFactory());
+        groupColumn.setCellFactory(n -> new TextCellFactory());
         linkColumn.setCellFactory(n -> new LinkCellFactory());
 
         initOwner(ownerWindow);
         show();
     }
 
     private void setUpListeners() {
-        addEventHandler(KeyEvent.KEY_PRESSED, e -> {
-            if (e.getCode() == KeyCode.ESCAPE) {
-                close();
+        group.getSelectionModel().selectedItemProperty().addListener((p, o, n) -> {
+            owner.getItems().setAll(Owner.getAllMembersOwner());
+
+            if (n == null) {
+                owner.getSelectionModel().select(null);
+            } else {
+                if (n.equals(Group.getAllGroupsGroup())) {
+                    owner.getItems().addAll(server.getOwners());
+                    owner.getSelectionModel().select(Owner.getAllMembersOwner());
+                } else {
+                    owner.getItems().addAll(n.getOwners());
+                    owner.getSelectionModel().selectFirst();
+                }
             }
         });
 
         importImage.textProperty().bind(Bindings.createStringBinding(
                 () -> results.getSelectionModel().getSelectedItems().size() == 1 ?
-                        resources.getString("Browser.ServerBrowser.AdvancedSearch.import") + " " + results.getSelectionModel().getSelectedItems().getFirst().getName() :
+                        resources.getString("Browser.ServerBrowser.AdvancedSearch.import") + " " + results.getSelectionModel().getSelectedItems().getFirst().name() :
                         resources.getString("Browser.ServerBrowser.AdvancedSearch.importObjects"),
                 results.getSelectionModel().getSelectedItems()
         ));
@@ -248,17 +262,31 @@ private void setUpListeners() {
             }
         });
 
-        typeColumn.prefWidthProperty().bind(results.widthProperty().multiply(0.16));
-        nameColumn.prefWidthProperty().bind(results.widthProperty().multiply(0.16));
-        acquiredColumn.prefWidthProperty().bind(results.widthProperty().multiply(0.16));
-        importedColumn.prefWidthProperty().bind(results.widthProperty().multiply(0.16));
-        groupColumn.prefWidthProperty().bind(results.widthProperty().multiply(0.16));
-        linkColumn.prefWidthProperty().bind(results.widthProperty().multiply(0.16));
+        typeColumn.prefWidthProperty().bind(results.widthProperty().multiply(0.1667));
+        nameColumn.prefWidthProperty().bind(results.widthProperty().multiply(0.1667));
+        acquiredColumn.prefWidthProperty().bind(results.widthProperty().multiply(0.1667));
+        importedColumn.prefWidthProperty().bind(results.widthProperty().multiply(0.1667));
+        groupColumn.prefWidthProperty().bind(results.widthProperty().multiply(0.1667));
+        linkColumn.prefWidthProperty().bind(results.widthProperty().multiply(0.1667));
+
+        getScene().addEventFilter(
+                KeyEvent.KEY_PRESSED,
+                keyEvent -> {
+                    switch (keyEvent.getCode()) {
+                        case ENTER:
+                            onSearchClicked(null);
+                            break;
+                        case ESCAPE:
+                            close();
+                            break;
+                    }
+                }
+        );
     }
 
     private void importSelectedImages() {
         UiUtilities.openImages(results.getSelectionModel().getSelectedItems().stream()
-                .map(SearchResult::getLink)
+                .map(SearchResult::link)
                 .toList()
         );
     }

src/main/java/qupath/ext/omero/gui/browser/advancedsearch/cellfactories/LinkCellFactory.java

@@ -1,23 +1,22 @@
 package qupath.ext.omero.gui.browser.advancedsearch.cellfactories;
 
-import javafx.scene.control.Button;
+import javafx.scene.control.Hyperlink;
+import javafx.scene.control.OverrunStyle;
 import javafx.scene.control.TableCell;
-import qupath.ext.omero.Utils;
+import javafx.scene.control.Tooltip;
 import qupath.ext.omero.core.entities.search.SearchResult;
 import qupath.lib.gui.QuPathGUI;
 
-import java.util.ResourceBundle;
-
 /**
  * Cell factory that displays a button that opens the link of a search result in a browser.
  */
 public class LinkCellFactory extends TableCell<SearchResult, SearchResult> {
 
-    private static final ResourceBundle resources = Utils.getResources();
-    private final Button button;
+    private final Hyperlink hyperlink;
 
     public LinkCellFactory() {
-        button = new Button(resources.getString("Browser.ServerBrowser.AdvancedSearch.link"));
+        hyperlink = new Hyperlink();
+        hyperlink.setTextOverrun(OverrunStyle.LEADING_WORD_ELLIPSIS);
     }
 
     @Override
@@ -27,8 +26,10 @@ protected void updateItem(SearchResult item, boolean empty) {
         setGraphic(null);
 
         if (item != null && !empty) {
-            button.setOnAction(e -> QuPathGUI.openInBrowser(item.getLink()));
-            setGraphic(button);
+            hyperlink.setText(item.link());
+            hyperlink.setTooltip(new Tooltip(item.link()));
+            hyperlink.setOnAction(e -> QuPathGUI.openInBrowser(item.link()));
+            setGraphic(hyperlink);
         }
     }
 }

src/main/java/qupath/ext/omero/gui/browser/advancedsearch/cellfactories/TextCellFactory.java

@@ -0,0 +1,24 @@
+package qupath.ext.omero.gui.browser.advancedsearch.cellfactories;
+
+import javafx.scene.control.TableCell;
+import javafx.scene.control.Tooltip;
+import qupath.ext.omero.core.entities.search.SearchResult;
+
+/**
+ * Cell factory that displays a text in the cell and in an associated tooltip.
+ */
+public class TextCellFactory extends TableCell<SearchResult, String> {
+
+    @Override
+    protected void updateItem(String item, boolean empty) {
+        super.updateItem(item, empty);
+
+        setText(null);
+        setTooltip(null);
+
+        if (item != null && !empty) {
+            setText(item);
+            setTooltip(new Tooltip(item));
+        }
+    }
+}