Merge pull request #3191 from ControlSystemStudio/CSSTUDIO-2167

CSSTUDIO-2167 Support for "decorations" in the Logbook application

Author: abrahamwolk

app/logbook/olog/ui/src/main/java/org/phoebus/logbook/olog/ui/AdvancedSearchViewController.java

@@ -24,6 +24,7 @@
 import javafx.beans.value.ObservableValue;
 import javafx.fxml.FXML;
 import javafx.geometry.Pos;
+import javafx.scene.Node;
 import javafx.scene.control.Button;
 import javafx.scene.control.ComboBox;
 import javafx.scene.control.Label;
@@ -113,10 +114,11 @@ public class AdvancedSearchViewController {
     private final SimpleBooleanProperty requireAttachments = new SimpleBooleanProperty(false);
 
     private Runnable searchCallback = () -> {
-        throw new IllegalStateException("Search callback is not set on AdvancedSearchViewConroller!");
+        throw new IllegalStateException("Search callback is not set on AdvancedSearchViewController!");
     };
 
-    public AdvancedSearchViewController(LogClient logClient, SearchParameters searchParameters) {
+    public AdvancedSearchViewController(LogClient logClient,
+                                        SearchParameters searchParameters) {
         this.logClient = logClient;
         this.searchParameters = searchParameters;
     }

app/logbook/olog/ui/src/main/java/org/phoebus/logbook/olog/ui/LogEntryCellController.java

@@ -6,6 +6,7 @@
 import javafx.scene.control.Label;
 import javafx.scene.image.Image;
 import javafx.scene.image.ImageView;
+import javafx.scene.layout.HBox;
 import javafx.scene.layout.Pane;
 import javafx.scene.layout.VBox;
 import org.commonmark.Extension;
@@ -16,9 +17,11 @@
 import org.phoebus.logbook.Logbook;
 import org.phoebus.logbook.Tag;
 import org.phoebus.logbook.olog.ui.LogEntryTableViewController.TableViewListItem;
+import org.phoebus.logbook.olog.ui.spi.Decoration;
 import org.phoebus.ui.javafx.ImageCache;
 
 import java.util.Arrays;
+import java.util.LinkedList;
 import java.util.List;
 import java.util.stream.Collectors;
 
@@ -40,11 +43,16 @@ public class LogEntryCellController {
     @FXML
     VBox root;
 
+    @FXML
+    VBox logEntryCell;
+
     @FXML
     Label time;
     @FXML
     Label owner;
     @FXML
+    HBox decorationNodes;
+    @FXML
     Label title;
     @FXML
     Label logbooks;
@@ -74,7 +82,6 @@ public class LogEntryCellController {
 
     private SimpleBooleanProperty expanded = new SimpleBooleanProperty(true);
 
-
     public LogEntryCellController() {
 
         List<Extension> extensions = Arrays.asList(TablesExtension.create(), ImageAttributesExtension.create());
@@ -92,8 +99,20 @@ public void initialize() {
         conversationIcon.setImage(conversation);
     }
 
-    @FXML
+    private List<Decoration> decorations = new LinkedList<>();
+
+    public void setDecorations(List<Decoration> decorations) {
+        this.decorations = decorations;
+    }
+
     public void refresh() {
+
+        decorationNodes.getChildren().clear();
+        for (Decoration decoration : decorations) {
+            Node decorationNode = decoration.createDecorationForLogEntryCell(logEntry.getLogEntry());
+            decorationNodes.getChildren().add(decorationNode);
+        }
+
         if (logEntry != null) {
 
             time.setText(SECONDS_FORMAT.format(logEntry.getLogEntry().getCreatedDate()));
@@ -126,8 +145,8 @@ public void refresh() {
 
             logEntryId.setText(logEntry.getLogEntry().getId() != null ? logEntry.getLogEntry().getId().toString() : "");
             level.setText(logEntry.getLogEntry().getLevel());
-
         }
+
     }
 
     public void setLogEntry(TableViewListItem logEntry) {

app/logbook/olog/ui/src/main/java/org/phoebus/logbook/olog/ui/LogEntryTable.java

@@ -11,15 +11,19 @@
 import org.phoebus.logbook.LogClient;
 import org.phoebus.logbook.LogEntry;
 import org.phoebus.logbook.olog.ui.query.OlogQueryManager;
+import org.phoebus.logbook.olog.ui.spi.Decoration;
 import org.phoebus.logbook.olog.ui.write.AttachmentsEditorController;
 import org.phoebus.ui.dialog.ExceptionDetailsErrorDialog;
 import org.phoebus.ui.docking.DockItem;
 import org.phoebus.ui.docking.DockPane;
 
 import java.io.IOException;
 import java.net.URI;
+import java.util.LinkedList;
+import java.util.List;
 import java.util.Optional;
 import java.util.ResourceBundle;
+import java.util.ServiceLoader;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
@@ -32,10 +36,18 @@ public class LogEntryTable implements AppInstance {
     private LogEntryTableViewController controller;
 
     public GoBackAndGoForwardActions goBackAndGoForwardActions;
-
     public LogEntryTable(final LogEntryTableApp app) {
         this.app = app;
         goBackAndGoForwardActions = new GoBackAndGoForwardActions();
+
+        List<Decoration> decorations = new LinkedList<>();
+        {
+            ServiceLoader<Decoration> decorationClasses = ServiceLoader.load(Decoration.class);
+            for (Decoration decoration : decorationClasses) {
+                decorations.add(decoration);
+            }
+        }
+
         try {
             OlogQueryManager ologQueryManager = OlogQueryManager.getInstance();
             SearchParameters searchParameters = new SearchParameters();
@@ -51,10 +63,10 @@ public LogEntryTable(final LogEntryTableApp app) {
                         if (clazz.isAssignableFrom(LogEntryTableViewController.class)) {
                             LogEntryTableViewController logEntryTableViewController = (LogEntryTableViewController) clazz.getConstructor(LogClient.class, OlogQueryManager.class, SearchParameters.class).newInstance(app.getClient(), ologQueryManager, searchParameters);
                             logEntryTableViewController.setGoBackAndGoForwardActions(goBackAndGoForwardActions);
+                            logEntryTableViewController.setDecorations(decorations);
                             return logEntryTableViewController;
                         } else if (clazz.isAssignableFrom(AdvancedSearchViewController.class)) {
-                            return clazz.getConstructor(LogClient.class, SearchParameters.class)
-                                    .newInstance(app.getClient(), searchParameters);
+                            return clazz.getConstructor(LogClient.class, SearchParameters.class).newInstance(app.getClient(), searchParameters);
                         } else if (clazz.isAssignableFrom(SingleLogEntryDisplayController.class)) {
                             SingleLogEntryDisplayController singleLogEntryDisplayController = (SingleLogEntryDisplayController) clazz.getConstructor(LogClient.class).newInstance(app.getClient());
                             singleLogEntryDisplayController.setSelectLogEntryInUI(id -> goBackAndGoForwardActions.loadLogEntryWithID(id));

app/logbook/olog/ui/src/main/java/org/phoebus/logbook/olog/ui/LogEntryTableViewController.java

@@ -48,6 +48,7 @@
 import org.phoebus.logbook.SearchResult;
 import org.phoebus.logbook.olog.ui.query.OlogQuery;
 import org.phoebus.logbook.olog.ui.query.OlogQueryManager;
+import org.phoebus.logbook.olog.ui.spi.Decoration;
 import org.phoebus.logbook.olog.ui.write.LogEntryEditorStage;
 import org.phoebus.logbook.olog.ui.write.LogEntryUpdateStage;
 import org.phoebus.olog.es.api.model.LogGroupProperty;
@@ -232,6 +233,10 @@ public void initialize() {
         descriptionCol.setMaxWidth(1f * Integer.MAX_VALUE * 100);
         descriptionCol.setCellValueFactory(col -> new SimpleObjectProperty<>(col.getValue()));
         descriptionCol.setCellFactory(col -> new TableCell<>() {
+            {
+                setStyle("-fx-padding: -1px");
+            }
+
             private final Node graphic;
             private final PseudoClass childlessTopLevel =
                     PseudoClass.getPseudoClass("grouped");
@@ -242,6 +247,7 @@ public void initialize() {
                     FXMLLoader loader = new FXMLLoader(getClass().getResource("LogEntryCell.fxml"));
                     graphic = loader.load();
                     controller = loader.getController();
+                    controller.setDecorations(decorations);
                 } catch (IOException exc) {
                     throw new RuntimeException(exc);
                 }
@@ -399,8 +405,20 @@ public void setLogs(List<LogEntry> logs) {
         throw new RuntimeException(new UnsupportedOperationException());
     }
 
+    private List<Decoration> decorations;
+    protected void setDecorations(List<Decoration> decorations) {
+        this.decorations = decorations;
+        for (Decoration decoration : decorations) {
+            decoration.setRefreshLogEntryTableView(() -> refresh());
+        }
+    }
+
     private void setSearchResult(SearchResult searchResult) {
         this.searchResult = searchResult;
+
+        List<LogEntry> logEntries = searchResult.getLogs();
+        decorations.forEach(decoration -> decoration.setLogEntries(logEntries));
+
         Platform.runLater(() -> {
             hitCountProperty.set(searchResult.getHitCount());
             pageCountProperty.set(1 + (hitCountProperty.get() / pageSizeProperty.get()));
@@ -417,12 +435,19 @@ public String getQuery() {
         return query.getValue().getQuery();
     }
 
-    private void refresh() {
+    private synchronized void refresh() {
         if (this.searchResult != null) {
             List<TableViewListItem> selectedLogEntries = new ArrayList<>(tableView.getSelectionModel().getSelectedItems());
-            ObservableList<TableViewListItem> logsList = FXCollections.observableArrayList();
-            logsList.addAll(searchResult.getLogs().stream().map(le -> new TableViewListItem(le, showDetails.get())).toList());
+
+            List<LogEntry> logEntries = searchResult.getLogs();
+            logEntries.sort((o1, o2) -> -(o1.getCreatedDate().compareTo(o2.getCreatedDate())));
+
+            boolean showDetailsBoolean = showDetails.get();
+            var logs = logEntries.stream().map(le -> new TableViewListItem(le, showDetailsBoolean)).toList();
+
+            ObservableList<TableViewListItem> logsList = FXCollections.observableArrayList(logs);
             tableView.setItems(logsList);
+
             // This will ensure that selected entries stay selected after the list has been
             // updated from the search result.
             for (TableViewListItem selectedItem : selectedLogEntries) {

app/logbook/olog/ui/src/main/java/org/phoebus/logbook/olog/ui/spi/Decoration.java

@@ -0,0 +1,14 @@
+package org.phoebus.logbook.olog.ui.spi;
+
+import javafx.scene.Node;
+import org.phoebus.logbook.LogEntry;
+
+import java.util.List;
+
+public interface Decoration {
+    void setLogEntries(List<LogEntry> logEntries);
+
+    void setRefreshLogEntryTableView(Runnable refreshLogEntryTableView);
+
+    Node createDecorationForLogEntryCell(LogEntry logEntry);
+}

app/logbook/olog/ui/src/main/resources/org/phoebus/logbook/olog/ui/AdvancedSearchView.fxml

@@ -121,7 +121,6 @@
                         </GridPane.margin>
                     </Label>
                     <TextField fx:id="attachmentTypes" GridPane.columnSpan="2" GridPane.rowIndex="18" />
-
                 </children>
             </GridPane>
         </children>