37889468619

Committed 09 Oct 2026 05:37AM UTC coverage: 51.491% (+0.08%) from 51.411%

Build # 37889468619

Build Type

Pull #771

github

Committed by

web-flow

Commit Message

Merge 62f065e74 into 108b57d49

Pull Request Pull Request #771: Group result-table rows under header rows via a "_group" column

Coverage Stats

5554 of 11589 branches covered (47.92%)

Branch coverage included in aggregate %.

9829 of 18286 relevant lines covered (53.75%)

8.72 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

src/main/java/com/knowledgepixels/nanodash/component/QueryResultTable.java

package com.knowledgepixels.nanodash.component;

import com.knowledgepixels.nanodash.*;
import com.knowledgepixels.nanodash.component.menu.EntryActionMenu;
import com.knowledgepixels.nanodash.page.ExplorePage;
import com.knowledgepixels.nanodash.page.NanodashPage;
import com.knowledgepixels.nanodash.page.PublishPage;
import org.apache.wicket.Component;
import org.apache.wicket.ajax.AjaxRequestTarget;
import org.apache.wicket.behavior.AttributeAppender;
import org.apache.wicket.extensions.ajax.markup.html.repeater.data.table.AjaxFallbackHeadersToolbar;
import org.apache.wicket.extensions.ajax.markup.html.repeater.data.table.AjaxNavigationToolbar;
import org.apache.wicket.extensions.markup.html.repeater.data.grid.ICellPopulator;
import org.apache.wicket.extensions.markup.html.repeater.data.table.AbstractColumn;
import org.apache.wicket.extensions.markup.html.repeater.data.table.DataTable;
import org.apache.wicket.extensions.markup.html.repeater.data.table.IColumn;
import org.apache.wicket.extensions.markup.html.repeater.data.table.IStyledColumn;
import org.apache.wicket.markup.html.WebMarkupContainer;
import org.apache.wicket.markup.html.basic.Label;
import org.apache.wicket.markup.html.form.TextField;
import org.apache.wicket.markup.html.link.AbstractLink;
import org.apache.wicket.markup.html.link.BookmarkablePageLink;
import org.apache.wicket.markup.html.list.ListItem;
import org.apache.wicket.markup.html.list.ListView;
import org.apache.wicket.markup.repeater.Item;
import org.apache.wicket.model.IModel;
import org.apache.wicket.model.Model;
import org.apache.wicket.model.util.ListModel;
import org.apache.wicket.request.mapper.parameter.PageParameters;
import org.apache.wicket.util.string.Strings;
import org.nanopub.extra.services.ApiResponse;
import org.nanopub.extra.services.ApiResponseEntry;
import org.nanopub.extra.services.QueryRef;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Set;

/**
 * Component for displaying query results in a table format.
 */
public class QueryResultTable extends QueryResult {

    private static final Logger logger = LoggerFactory.getLogger(QueryResultTable.class);

    private Model<String> errorMessages = Model.of("");
    private DataTable<ApiResponseEntry, String> table;
    private String groupColumnKey = null;
    private Label noRecordsLabel;
    private Label errorLabel;
    private FilteredQueryResultDataProvider filteredDataProvider;
    private Model<String> filterModel = Model.of("");
    // The source-nanopub column ("np"/"nps"), folded into the per-row actions dropdown.
    private String sourceColumnKey;

    QueryResultTable(String id, QueryRef queryRef, ApiResponse response, ViewDisplay viewDisplay, boolean plain) {
        super(id, queryRef, response, viewDisplay);

        if (plain) {
            add(new Label("label").setVisible(false));
            add(new Label("np").setVisible(false));
            showViewDisplayMenu = false;
            hideDescription();
        } else {
            String label = grlcQuery.getLabel();
            if (viewDisplay.getTitle() != null) {
                label = viewDisplay.getTitle();
            }
            add(new Label("label", label).setVisible(label != null && !label.isEmpty()));
        }

        errorLabel = new Label("error-messages", errorMessages);
        errorLabel.setVisible(false);
        add(errorLabel);

        TextField<String> filterField = new TextField<>("filter", filterModel);
        filterField.setOutputMarkupId(true);
        filterField.add(new FilterUpdatingBehavior() {
            @Override
            protected void onUpdate(AjaxRequestTarget target) {
                if (filteredDataProvider != null && table != null) {
                    filteredDataProvider.setFilterText(filterModel.getObject());
                    target.add(table);
                    if (noRecordsLabel != null) {
                        target.add(noRecordsLabel);
                    }
                }
            }
        });
        filterField.setVisible(!fitsOnFirstPage());
        add(filterField);

        populateComponent();
    }

    private void addErrorMessage(String errorMessage) {
        String s = errorMessages.getObject();
        if (s.isEmpty()) {
            s = "Error: " + errorMessage;
        } else {
            s += ", " + errorMessage;
        }
        errorMessages.setObject(s);
        errorLabel.setVisible(true);
        if (table != null) {
            table.setVisible(false);
        }
    }

    @Override
    protected void populateComponent() {
        List<IColumn<ApiResponseEntry, String>> columns = new ArrayList<>();
        QueryResultDataProvider dataProvider;
        try {
            // Columns that only feed action query mappings (conditional targets, the
            // local-key bundle) carry action data, not row content — don't render them.
            Set<String> hiddenColumns = viewDisplay.getView() != null
                    ? viewDisplay.getView().getActionMappingSourceColumns() : Collections.emptySet();
            // The source-nanopub column ("np"/"nps") is no longer rendered as its own
            // column; it becomes the "source" entry of this row's actions dropdown.
            sourceColumnKey = null;
            for (String h : response.getHeader()) {
                if (h.equals("np") || h.equals("nps")) {
                    sourceColumnKey = h;
                }
            }
            // Whether any rendered column carries a visible header label. If none do
            // (every column is "_noheader"), the entire header row is dropped — see the
            // gated addTopToolbar below.
            boolean anyHeaderShown = false;
            // A column whose name ends in "_group" is not rendered as a column: its value
            // labels a group of rows, shown as a full-width header row wherever the value
            // changes from one row to the next (in display order), see newRowItem below.
            // The groups keep the order the query returned them in; sorting the table by
            // a column reorders the rows inside each group only (see
            // FilteredQueryResultDataProvider), so there is always one header per group.
            groupColumnKey = null;
            for (String h : response.getHeader()) {
                if (h.endsWith("_group")) {
                    groupColumnKey = h;
                }
            }
            for (String h : response.getHeader()) {
                if (h.endsWith("_label") || h.endsWith("_label_multi")
                    || hiddenColumns.contains(h) || h.equals(sourceColumnKey) || h.equals(groupColumnKey)) {
                    continue;
                }
                // A trailing "_noheader" hides this column's header label while still
                // rendering the column. It is stripped first to recover the logical
                // column key, so every other rule (type suffix, _label companion,
                // action mappings) operates unchanged on the unmarked name.
                boolean noHeader = h.endsWith("_noheader");
                String key = noHeader ? h.substring(0, h.length() - "_noheader".length()) : h;
                String displayLabel = key;
                if (displayLabel.endsWith("_multi_iri")) {
                    displayLabel = displayLabel.substring(0, displayLabel.length() - "_multi_iri".length());
                } else if (displayLabel.endsWith("_multi_val")) {
                    displayLabel = displayLabel.substring(0, displayLabel.length() - "_multi_val".length());
                } else if (displayLabel.endsWith("_multi")) {
                    displayLabel = displayLabel.substring(0, displayLabel.length() - "_multi".length());
                } else if (displayLabel.endsWith("_iri")) {
                    displayLabel = displayLabel.substring(0, displayLabel.length() - "_iri".length());
                }
                String columnHeader = displayLabel.replaceAll("_", " ");
                if (noHeader) {
                    columns.add(new Column("", h, key, null));
                } else {
                    anyHeaderShown = true;
                    columns.add(new Column(columnHeader, h, key, null));
                }
            }
            // A single trailing dropdown column bundling this row's entry-level actions
            // and its "source" link, shown whenever either is present.
            boolean hasEntryActions = viewDisplay.getView() != null
                                      && !viewDisplay.getView().getViewEntryActionList().isEmpty();
            if (hasEntryActions || sourceColumnKey != null) {
                columns.add(new Column("", Column.ACTIONS, "cell-right"));
            }
            dataProvider = new QueryResultDataProvider(response.getData());
            filteredDataProvider = new FilteredQueryResultDataProvider(dataProvider, response);
            // The whole table (header included) is hidden when there is nothing to show;
            // a "(nothing found)" note is shown instead. No NoRecordsToolbar, since that
            // would leave the header row visible.
            final int renderedColumnCount = columns.size();
            table = new DataTable<>("table", columns, filteredDataProvider, viewDisplay.getPageSize() < 1 ? Integer.MAX_VALUE : viewDisplay.getPageSize()) {
                @Override
                protected void onConfigure() {
                    super.onConfigure();
                    setVisible(errorMessages.getObject().isEmpty() && filteredDataProvider.size() > 0);
                }

                // The value of the "_group" column of the row rendered before the current
                // one on this page; rows are created in display order, so comparing against
                // it tells where a new group starts. Reset on the first row of each page.
                private String previousGroup = null;

                @Override
                protected Item<ApiResponseEntry> newRowItem(String id, int index, IModel<ApiResponseEntry> model) {
                    if (groupColumnKey == null) {
                        return super.newRowItem(id, index, model);
                    }
                    if (index == 0) previousGroup = null;
                    String group = model.getObject().get(groupColumnKey);
                    if (group == null) group = "";
                    final String header = group.equals(previousGroup) || group.isEmpty() ? null : group;
                    previousGroup = group;
                    return new Item<ApiResponseEntry>(id, index, model) {
                        @Override
                        protected void onRender() {
                            if (header != null) {
                                // A full-width header row written straight before this row's
                                // own <tr>, outside Wicket's component tree (there is no
                                // component for it to attach to).
                                getResponse().write("<tr class=\"group-header\"><td colspan=\"" + renderedColumnCount + "\">"
                                        + Strings.escapeMarkup(header) + "</td></tr>");
                            }
                            super.onRender();
                        }
                    };
                }
            };
            table.setOutputMarkupPlaceholderTag(true);
            // Marker class so nanodash.js can wrap emoji in body cells with the same
            // monochrome .emoji styling used for headings (e.g. the ✅/⚠️ key-approval
            // annotations in the "keys" column).
            table.add(new AttributeAppender("class", "result-table"));
            table.addBottomToolbar(new AjaxNavigationToolbar(table));
            // Drop the header row entirely when no column has a visible header label.
            if (anyHeaderShown) {
                table.addTopToolbar(new AjaxFallbackHeadersToolbar<String>(table, dataProvider));
            }
            add(table);
            // Hidden when the empty-actions line below shows instead, which carries
            // its own "Nothing here yet:" text; this note still covers the case of
            // the filter text matching no row.
            noRecordsLabel = new Label("no-records", "(nothing found)") {
                @Override
                protected void onConfigure() {
                    super.onConfigure();
                    setVisible(errorMessages.getObject().isEmpty() && filteredDataProvider.size() == 0 && !hasEmptyStateActions());
                }
            };
            noRecordsLabel.setOutputMarkupPlaceholderTag(true);
            add(noRecordsLabel);
            // When the result is genuinely empty (not merely filtered down to zero
            // rows), the view-level actions are promoted from the dropdown menu to
            // visible buttons in the empty state, pointing e.g. a space admin to
            // "add preset..." as the next step. menuActions only ever contains
            // actions the viewer is entitled to (see QueryResultTableBuilder), so
            // everyone else just gets the plain note. The same actions stay in the
            // dropdown menu, which remains their place once the table has content.
            WebMarkupContainer emptyActions = new WebMarkupContainer("empty-actions") {
                @Override
                protected void onConfigure() {
                    super.onConfigure();
                    setVisible(errorMessages.getObject().isEmpty() && hasEmptyStateActions());
                }
            };
            // menuActions is filled by the builder after construction, so the list
            // is wrapped as a live model rather than copied here.
            emptyActions.add(new ListView<MenuAction>("actions", new ListModel<>(menuActions)) {
                @Override
                protected void populateItem(ListItem<MenuAction> item) {
                    MenuAction action = item.getModelObject();
                    AbstractLink link = new BookmarkablePageLink<NanodashPage>("link", action.pageClass(), action.params());
                    link.setBody(Model.of(action.label()));
                    item.add(link);
                }
            });
            add(emptyActions);
        } catch (Exception ex) {
            logger.error("Error creating table for query {}", grlcQuery.getQueryId(), ex);
            add(new Label("table", "").setVisible(false));
            add(new Label("no-records", "").setVisible(false));
            add(new Label("empty-actions", "").setVisible(false));
            addErrorMessage(ex.getMessage());
        }
    }

    private class Column extends AbstractColumn<ApiResponseEntry, String> implements IStyledColumn<ApiResponseEntry, String> {

        private String key;
        // The actual response-column name to read row data from. Differs from the
        // logical key only for "_noheader" columns, whose marker is kept here but
        // stripped from key so all name-matching uses the unmarked name.
        private String dataKey;
        private String cssClass;
        public static final String ACTIONS = "*actions*";

        public Column(String title, String key) {
            this(title, key, key, null);
        }

        public Column(String title, String key, String cssClass) {
            this(title, key, key, cssClass);
        }

        public Column(String title, String dataKey, String key, String cssClass) {
            // Only a column with a header label is sortable: an empty header is nothing to
            // click, and the actions column would otherwise offer to order the table by a
            // property no row has, giving a round trip that changes nothing (issue #673).
            super(new Model<String>(title), Strings.isEmpty(title) ? null : dataKey);
            this.key = key;
            this.dataKey = dataKey;
            this.cssClass = cssClass;
        }

        @Override
        public String getCssClass() {
            return cssClass;
        }

        @Override
        public void populateItem(Item<ICellPopulator<ApiResponseEntry>> cellItem, String componentId, IModel<ApiResponseEntry> rowModel) {
            try {
                View view = viewDisplay.getView();
                if (key.equals(ACTIONS)) {
                    List<AbstractLink> links = ViewActionMappings.buildEntryActionLinks(view, rowModel.getObject(),
                            queryRef, resourceWithProfile, contextId, partId, refRoot, postPublishTab);
                    // The former "^" source link joins the same dropdown, as a "source" entry.
                    if (sourceColumnKey != null) {
                        String sourceUri = rowModel.getObject().get(sourceColumnKey);
                        if (sourceUri != null && !sourceUri.isBlank()) {
                            AbstractLink sourceLink = new BookmarkablePageLink<NanodashPage>("link", ExplorePage.class,
                                    new PageParameters().set("id", sourceUri));
                            sourceLink.add(NavigationContext.pageContextFallback());
                            sourceLink.setBody(Model.of("<span class=\"actionmenu-icon\">↗︎</span>source")).setEscapeModelStrings(false);
                            links.add(sourceLink);
                        }
                    }
                    if (links.isEmpty()) {
                        cellItem.add(new Label(componentId).setVisible(false));
                    } else {
                        cellItem.add(new EntryActionMenu(componentId, links));
                    }
                } else {
                    String value = rowModel.getObject().get(dataKey);
                    if (key.endsWith("_multi_iri")) {
                        String labelKey = key.substring(0, key.length() - "_multi_iri".length()) + "_label_multi";
                        String labelValue = rowModel.getObject().get(labelKey);
                        String[] uris = (value == null || value.isBlank()) ? new String[0] : value.split("\\s+");
                        String[] labels = labelValue != null ? labelValue.split("\n", -1) : null;
                        List<Component> links = new ArrayList<>();
                        for (int i = 0; i < uris.length; i++) {
                            String uri = uris[i];
                            if (uri.isBlank()) {
                                continue;
                            }
                            String rawLabel = (labels != null && i < labels.length && !labels[i].isBlank()) ? Utils.unescapeMultiValue(labels[i]) : null;
                            // SPARQL coalesce often falls back to the URI string itself; treat that as no label
                            // so NanodashLink can derive a short name from the URI.
                            if (rawLabel != null && rawLabel.equals(uri)) {
                                rawLabel = null;
                            }
                            links.add(new NanodashLink("component", uri, null, null, rawLabel, contextId));
                        }
                        cellItem.add(new ComponentSequence(componentId, ", ", links));
                    } else if (key.endsWith("_multi_val")) {
                        String labelKey = key.substring(0, key.length() - "_multi_val".length()) + "_label_multi";
                        String labelValue = rowModel.getObject().get(labelKey);
                        String[] parts = (value == null) ? new String[0] : value.split("\n", -1);
                        String[] labels = labelValue != null ? labelValue.split("\n", -1) : null;
                        List<Component> components = new ArrayList<>();
                        for (int i = 0; i < parts.length; i++) {
                            String part = parts[i];
                            String rawLabel = (labels != null && i < labels.length && !labels[i].isBlank()) ? Utils.unescapeMultiValue(labels[i]) : null;
                            if (isPublishLink(part)) {
                                components.add(new Label("component", publishButtonHtml(part, rawLabel)).setEscapeModelStrings(false));
                            } else if (Utils.isUriValue(part)) {
                                if (rawLabel != null && rawLabel.equals(part)) {
                                    rawLabel = null;
                                }
                                components.add(new NanodashLink("component", part, null, null, rawLabel, contextId));
                            } else {
                                String label = rawLabel;
                                String unescaped = Utils.unescapeMultiValue(part);
                                if (label == null && Utils.isDate(unescaped)) {
                                    // Friendly relative time, matching single-value cells.
                                    components.add(new Label("component", Utils.friendlyDateHtml(unescaped, unescaped)).setEscapeModelStrings(false));
                                } else {
                                    String display = label != null ? label : unescaped;
                                    if (Utils.looksLikeHtml(display)) {
                                        components.add(new Label("component", cellHtml(display))
                                                .setEscapeModelStrings(false)
                                                .add(new AttributeAppender("class", "cell-data-html")));
                                    } else {
                                        components.add(new Label("component", display));
                                    }
                                }
                            }
                        }
                        cellItem.add(new ComponentSequence(componentId, ", ", components));
                    } else if (key.endsWith("_multi")) {
                        String labelKey = key.substring(0, key.length() - "_multi".length()) + "_label_multi";
                        String labelValue = rowModel.getObject().get(labelKey);
                        String[] parts = (value == null) ? new String[0] : value.split("\n", -1);
                        String[] labels = labelValue != null ? labelValue.split("\n", -1) : null;
                        List<Component> components = new ArrayList<>();
                        for (int i = 0; i < parts.length; i++) {
                            boolean hasLabel = labels != null && i < labels.length && !labels[i].isBlank();
                            String display = hasLabel ? Utils.unescapeMultiValue(labels[i]) : Utils.unescapeMultiValue(parts[i]);
                            if (!hasLabel && Utils.isDate(display)) {
                                // Friendly relative time, matching single-value cells.
                                components.add(new Label("component", Utils.friendlyDateHtml(display, display)).setEscapeModelStrings(false));
                            } else if (Utils.looksLikeHtml(display)) {
                                components.add(new Label("component", cellHtml(display))
                                        .setEscapeModelStrings(false)
                                        .add(new AttributeAppender("class", "cell-data-html")));
                            } else {
                                components.add(new Label("component", display));
                            }
                        }
                        cellItem.add(new ComponentSequence(componentId, ", ", components));
                    } else if (key.endsWith("template_iri")) {
                        String label = rowModel.getObject().get(key + "_label");
                        if (label == null || label.isBlank()) {
                            label = truncateLabel(value);
                        }
                        String templateUrl = PublishPage.MOUNT_PATH + "?template=" + Utils.urlEncode(value) + "&template-version=latest";
                        templateUrl += linkNavParams(templateUrl);
                        String html = "<a href=\"" + Strings.escapeMarkup(templateUrl) + "\">" + Strings.escapeMarkup(label) + "</a>";
                        cellItem.add(new Label(componentId, html).setEscapeModelStrings(false));
                    } else if (isPublishLink(value)) {
                        // A ready-made link to the publish form: an action the view offers,
                        // shown as a button rather than as a link to content.
                        String label = rowModel.getObject().get(key + "_label");
                        cellItem.add(new Label(componentId, publishButtonHtml(value, label)).setEscapeModelStrings(false));
                    } else if (Utils.isUriValue(value)) {
                        String label = rowModel.getObject().get(key + "_label");
                        cellItem.add(new NanodashLink(componentId, value, null, null, label, contextId));
                    } else {
                        String litLabel = rowModel.getObject().get(key + "_label");
                        if (litLabel != null && !litLabel.isBlank() && !litLabel.equals(value)) {
                            // Separate display label for a (non-IRI) literal value; the full
                            // literal is shown on hover via the standard styled tooltip.
                            String labelHtml = Utils.looksLikeHtml(litLabel) ? cellHtml(litLabel) : Strings.escapeMarkup(litLabel).toString();
                            String html = "<span class=\"tooltip\"><span class=\"tooltiptext tooltiptext-auto\">" + Strings.escapeMarkup(value) + "</span>" + labelHtml + "</span>";
                            cellItem.add(new Label(componentId, html).setEscapeModelStrings(false));
                        } else if (key.startsWith("pubkey")) {
                            cellItem.add(new Label(componentId, value).add(new AttributeAppender("style", "overflow-wrap: anywhere;")));
                        } else if (Utils.isDate(value)) {
                            // Show a friendly relative time (client-side); raw ISO value stays as no-script fallback.
                            cellItem.add(new Label(componentId, Utils.friendlyDateHtml(value, value)).setEscapeModelStrings(false));
                        } else {
                            Label cellLabel;
                            if (Utils.looksLikeHtml(value)) {
                                cellLabel = (Label) new Label(componentId, cellHtml(value))
                                        .setEscapeModelStrings(false)
                                        .add(new AttributeAppender("class", "cell-data-html"));
                            } else {
                                cellLabel = new Label(componentId, value);
                            }
                            cellItem.add(cellLabel);
                        }
                    }
                }
            } catch (Exception ex) {
                logger.error("Failed to populate table column: ", ex);
                cellItem.add(new Label(componentId).setVisible(false));
                addErrorMessage(ex.getMessage());
            }
        }

    }

    private static String truncateLabel(String label) {
        return Utils.truncateLabel(label);
    }

}

knowledgepixels / nanodash / 37889468619

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous