27811003513

Committed 19 Jun 2026 07:06AM UTC coverage: 26.612% (-0.4%) from 26.963%

Build # 27811003513

Build Type

Pull #484

github

Committed by

web-flow

Commit Message

Merge 2b4ad3339 into 0f6281554

Pull Request Pull Request #484: Space-ref disambiguation: conflict notice, claimants overview, ref-pinned pages

Coverage Stats

1552 of 6853 branches covered (22.65%)

Branch coverage included in aggregate %.

3420 of 11830 relevant lines covered (28.91%)

4.26 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/QueryResultTableBuilder.java

package com.knowledgepixels.nanodash.component;

import com.knowledgepixels.nanodash.ApiCache;
import com.knowledgepixels.nanodash.SpaceMemberRole;
import com.knowledgepixels.nanodash.View;
import com.knowledgepixels.nanodash.ViewDisplay;
import com.knowledgepixels.nanodash.domain.AbstractResourceWithProfile;
import com.knowledgepixels.nanodash.domain.MaintainedResource;
import com.knowledgepixels.nanodash.domain.Space;
import com.knowledgepixels.nanodash.page.PublishPage;
import com.knowledgepixels.nanodash.repository.MaintainedResourceRepository;
import com.knowledgepixels.nanodash.template.Template;
import org.apache.wicket.Component;
import org.apache.wicket.behavior.AttributeAppender;
import org.apache.wicket.request.mapper.parameter.PageParameters;
import org.eclipse.rdf4j.model.IRI;
import org.nanopub.extra.services.ApiResponse;
import org.nanopub.extra.services.QueryRef;

import java.io.Serializable;

/**
 * Builder class for creating QueryResultTable components with various configurations.
 */
public class QueryResultTableBuilder implements Serializable {

    private String markupId;
    private boolean plain = false;
    private ViewDisplay viewDisplay;
    private String contextId = null;
    private QueryRef queryRef;
    private AbstractResourceWithProfile resourceWithProfile = null;
    private String id = null;
    private String postPublishTab = null;
    private String refRoot = null;

    private QueryResultTableBuilder(String markupId, QueryRef queryRef, ViewDisplay viewDisplay) {
        this.markupId = markupId;
        // Bind session-derived "magic" query parameters here on the request thread
        // (ApiCache fetches on background threads where the session is absent).
        this.queryRef = com.knowledgepixels.nanodash.MagicQueryParams.augment(queryRef);
        this.viewDisplay = viewDisplay;
    }

    /**
     * Creates a new QueryResultTableBuilder instance.
     *
     * @param markupId    the markup ID for the component
     * @param queryRef    the query reference
     * @param viewDisplay the view display object
     * @return a new QueryResultTableBuilder instance
     */
    public static QueryResultTableBuilder create(String markupId, QueryRef queryRef, ViewDisplay viewDisplay) {
        return new QueryResultTableBuilder(markupId, queryRef, viewDisplay);
    }

    /**
     * Sets the resource with profile for the QueryResultTable.
     *
     * @param resourceWithProfile the ResourceWithProfile object
     * @return the current QueryResultTableBuilder instance
     */
    public QueryResultTableBuilder resourceWithProfile(AbstractResourceWithProfile resourceWithProfile) {
        this.resourceWithProfile = resourceWithProfile;
        return this;
    }

    /**
     * Sets the ID for the QueryResultTable.
     *
     * @param id the ID string
     * @return the current QueryResultTableBuilder instance
     */
    public QueryResultTableBuilder id(String id) {
        this.id = id;
        return this;
    }

    /**
     * Sets whether the table should be plain.
     *
     * @param plain true for plain table, false otherwise
     * @return the current QueryResultTableBuilder instance
     */
    public QueryResultTableBuilder plain(boolean plain) {
        this.plain = plain;
        return this;
    }

    /**
     * Sets the context ID for the QueryResultTable.
     *
     * @param contextId the context ID string
     * @return the current QueryResultTableBuilder instance
     */
    public QueryResultTableBuilder contextId(String contextId) {
        this.contextId = contextId;
        return this;
    }

    /**
     * Sets the tab to return to after publishing via one of the table's action
     * buttons (so the user stays on, e.g., the About tab).
     *
     * @param postPublishTab the tab name, or null for the default
     * @return the current QueryResultTableBuilder instance
     */
    public QueryResultTableBuilder postPublishTab(String postPublishTab) {
        this.postPublishTab = postPublishTab;
        return this;
    }

    /**
     * Pins this table to a specific ref (root definition), so action visibility is gated
     * against that claimant's authority rather than the resource's representative ref. Used
     * on {@code ?root=}-pinned pages. Null leaves it on the representative ref.
     *
     * @param refRoot the ref's root nanopub, or null
     * @return the current QueryResultTableBuilder instance
     */
    public QueryResultTableBuilder refRoot(String refRoot) {
        this.refRoot = refRoot;
        return this;
    }

    /**
     * Builds the QueryResultTable component based on the configured parameters.
     *
     * @return the constructed Component
     */
    public Component build() {
        ApiResponse response = ApiCache.retrieveResponseAsync(queryRef);
        String colClass = " col-" + viewDisplay.getDisplayWidth();
        if (resourceWithProfile != null) {
            if (response != null) {
                QueryResultTable table = new QueryResultTable(markupId, queryRef, response, viewDisplay, false);
                table.setContextId(contextId);
                table.setPostPublishTab(postPublishTab);
                table.setRefRoot(refRoot);
                if (id != null && contextId != null && !id.equals(contextId)) {
                    table.setPartId(id);
                }
                table.setResourceWithProfile(resourceWithProfile);
                table.setPageResource(resourceWithProfile);
                addViewActions(table, viewDisplay, queryRef, id, contextId, resourceWithProfile, refRoot);
                table.add(new AttributeAppender("class", colClass));
                return table;
            } else {
                ApiResultComponent comp = new ApiResultComponent(markupId, queryRef) {
                    @Override
                    public Component getApiResultComponent(String markupId, ApiResponse response) {
                        QueryResultTable table = new QueryResultTable(markupId, queryRef, response, viewDisplay, false);
                        table.setContextId(contextId);
                        table.setPostPublishTab(postPublishTab);
                        table.setRefRoot(refRoot);
                        if (id != null && contextId != null && !id.equals(contextId)) {
                            table.setPartId(id);
                        }
                        table.setResourceWithProfile(resourceWithProfile);
                        table.setPageResource(resourceWithProfile);
                        addViewActions(table, viewDisplay, queryRef, id, contextId, resourceWithProfile, refRoot);
                        return table;
                    }
                };
                comp.add(new AttributeAppender("class", colClass));
                return comp;
            }
        } else {
            if (response != null) {
                QueryResultTable table = new QueryResultTable(markupId, queryRef, response, viewDisplay, plain);
                table.setContextId(contextId);
                table.setPostPublishTab(postPublishTab);
                table.setRefRoot(refRoot);
                addViewActions(table, viewDisplay, queryRef, id, contextId, resourceWithProfile, refRoot);
                table.add(new AttributeAppender("class", colClass));
                return table;
            } else {
                ApiResultComponent comp = new ApiResultComponent(markupId, queryRef) {
                    @Override
                    public Component getApiResultComponent(String markupId, ApiResponse response) {
                        QueryResultTable table = new QueryResultTable(markupId, queryRef, response, viewDisplay, plain);
                        table.setContextId(contextId);
                        table.setPostPublishTab(postPublishTab);
                        table.setRefRoot(refRoot);
                        addViewActions(table, viewDisplay, queryRef, id, contextId, resourceWithProfile, refRoot);
                        return table;
                    }
                };
                comp.add(new AttributeAppender("class", colClass));
                return comp;
            }
        }
    }

    /**
     * Adds a button to the table for each result action declared by the view, linking to the
     * action's template on the publish page. Resource-context parameters (the target field, the
     * context, the part, and the part field) are only set when the corresponding id/contextId is
     * available, so this also works on resource-less listings such as the general Spaces page.
     *
     * @param table       the table to add the action buttons to
     * @param viewDisplay the view display whose view declares the actions
     * @param queryRef    the query reference backing the table (used for refresh and query mapping)
     * @param id          the resource id, or null if there is no specific resource in context
     * @param contextId   the context id, or null if there is no context
     */
    private static void addViewActions(QueryResultTable table, ViewDisplay viewDisplay, QueryRef queryRef, String id, String contextId, AbstractResourceWithProfile resourceWithProfile, String refRoot) {
        View view = viewDisplay.getView();
        if (view == null) return;
        for (IRI actionIri : view.getViewResultActionList()) {
            // Per-action role gating (docs/role-specific-views.md): skip an action
            // whose gen:isVisibleTo the current viewer does not satisfy. Additive —
            // actions without gen:isVisibleTo are unaffected. Gated against the pinned
            // ref's authority on a ?root=-pinned page. See docs/space-ref-identity.md.
            if (!SpaceMemberRole.isViewerEntitled(view.getActionVisibleTo(actionIri), resourceWithProfile, refRoot)) continue;
            Template t = view.getTemplateForAction(actionIri);
            if (t == null) continue;
            String targetField = view.getTemplateTargetFieldForAction(actionIri);
            if (targetField == null) targetField = "resource";
            String label = view.getLabelForAction(actionIri);
            if (label == null) label = "action...";
            if (!label.endsWith("...")) label += "...";
            PageParameters params = new PageParameters().set("template", t.getId())
                    .set("template-version", "latest");
            if (id != null) params.set("param_" + targetField, id);
            if (contextId != null) params.set("context", contextId);
            if (id != null && contextId != null && !id.equals(contextId)) {
                params.set("part", id);
            }
            String partField = view.getTemplatePartFieldForAction(actionIri);
            if (partField != null && contextId != null) {
                // The part field pre-fills a namespaced child IRI (the user fills the suffix).
                // TODO Find a better way to pass the MaintainedResource object to this method:
                MaintainedResource r = MaintainedResourceRepository.get().findById(contextId);
                String namespace = null;
                if (r != null) {
                    namespace = r.getNamespace();
                } else if (resourceWithProfile instanceof Space) {
                    // The Space-creation templates' `space` placeholder has a fixed
                    // `https://w3id.org/spaces/` prefix, so the pre-fill is relative to it.
                    // Nesting the new space's IRI under this space's path makes it a
                    // sub-space via the prefix match.
                    namespace = contextId.replaceFirst("https://w3id.org/spaces/", "") + "/";
                }
                if (namespace != null) {
                    params.set("param_" + partField, namespace + "<SET-SUFFIX>");
                }
            }
            String queryMapping = view.getTemplateQueryMapping(actionIri);
            if (queryMapping != null && queryMapping.contains(":")) {
                params.set("values-from-query", queryRef.getAsUrlString());
                params.set("values-from-query-mapping", queryMapping);
            }
            params.set("refresh-upon-publish", queryRef.getAsUrlString());
            if (table.getPostPublishTab() != null) params.set("postpub-tab", table.getPostPublishTab());
            table.addButton(label, PublishPage.class, params);
        }
    }

}

1	package com.knowledgepixels.nanodash.component;
2
3	import com.knowledgepixels.nanodash.ApiCache;
4	import com.knowledgepixels.nanodash.SpaceMemberRole;
5	import com.knowledgepixels.nanodash.View;
6	import com.knowledgepixels.nanodash.ViewDisplay;
7	import com.knowledgepixels.nanodash.domain.AbstractResourceWithProfile;
8	import com.knowledgepixels.nanodash.domain.MaintainedResource;
9	import com.knowledgepixels.nanodash.domain.Space;
10	import com.knowledgepixels.nanodash.page.PublishPage;
11	import com.knowledgepixels.nanodash.repository.MaintainedResourceRepository;
12	import com.knowledgepixels.nanodash.template.Template;
13	import org.apache.wicket.Component;
14	import org.apache.wicket.behavior.AttributeAppender;
15	import org.apache.wicket.request.mapper.parameter.PageParameters;
16	import org.eclipse.rdf4j.model.IRI;
17	import org.nanopub.extra.services.ApiResponse;
18	import org.nanopub.extra.services.QueryRef;
19
20	import java.io.Serializable;
21
22	/**
23	* Builder class for creating QueryResultTable components with various configurations.
24	*/
25	public class QueryResultTableBuilder implements Serializable {
26
27	private String markupId;
28	private boolean plain = false;	×
29	private ViewDisplay viewDisplay;
30	private String contextId = null;	×
31	private QueryRef queryRef;
32	private AbstractResourceWithProfile resourceWithProfile = null;	×
33	private String id = null;	×
34	private String postPublishTab = null;	×
35	private String refRoot = null;	×
36
37	private QueryResultTableBuilder(String markupId, QueryRef queryRef, ViewDisplay viewDisplay) {	×
38	this.markupId = markupId;	×
39	// Bind session-derived "magic" query parameters here on the request thread
40	// (ApiCache fetches on background threads where the session is absent).
41	this.queryRef = com.knowledgepixels.nanodash.MagicQueryParams.augment(queryRef);	×
42	this.viewDisplay = viewDisplay;	×
43	}	×
44
45	/**
46	* Creates a new QueryResultTableBuilder instance.
47	*
48	* @param markupId the markup ID for the component
49	* @param queryRef the query reference
50	* @param viewDisplay the view display object
51	* @return a new QueryResultTableBuilder instance
52	*/
53	public static QueryResultTableBuilder create(String markupId, QueryRef queryRef, ViewDisplay viewDisplay) {
54	return new QueryResultTableBuilder(markupId, queryRef, viewDisplay);	×
55	}
56
57	/**
58	* Sets the resource with profile for the QueryResultTable.
59	*
60	* @param resourceWithProfile the ResourceWithProfile object
61	* @return the current QueryResultTableBuilder instance
62	*/
63	public QueryResultTableBuilder resourceWithProfile(AbstractResourceWithProfile resourceWithProfile) {
64	this.resourceWithProfile = resourceWithProfile;	×
65	return this;	×
66	}
67
68	/**
69	* Sets the ID for the QueryResultTable.
70	*
71	* @param id the ID string
72	* @return the current QueryResultTableBuilder instance
73	*/
74	public QueryResultTableBuilder id(String id) {
75	this.id = id;	×
76	return this;	×
77	}
78
79	/**
80	* Sets whether the table should be plain.
81	*
82	* @param plain true for plain table, false otherwise
83	* @return the current QueryResultTableBuilder instance
84	*/
85	public QueryResultTableBuilder plain(boolean plain) {
86	this.plain = plain;	×
87	return this;	×
88	}
89
90	/**
91	* Sets the context ID for the QueryResultTable.
92	*
93	* @param contextId the context ID string
94	* @return the current QueryResultTableBuilder instance
95	*/
96	public QueryResultTableBuilder contextId(String contextId) {
97	this.contextId = contextId;	×
98	return this;	×
99	}
100
101	/**
102	* Sets the tab to return to after publishing via one of the table's action
103	* buttons (so the user stays on, e.g., the About tab).
104	*
105	* @param postPublishTab the tab name, or null for the default
106	* @return the current QueryResultTableBuilder instance
107	*/
108	public QueryResultTableBuilder postPublishTab(String postPublishTab) {
109	this.postPublishTab = postPublishTab;	×
110	return this;	×
111	}
112
113	/**
114	* Pins this table to a specific ref (root definition), so action visibility is gated
115	* against that claimant's authority rather than the resource's representative ref. Used
116	* on {@code ?root=}-pinned pages. Null leaves it on the representative ref.
117	*
118	* @param refRoot the ref's root nanopub, or null
119	* @return the current QueryResultTableBuilder instance
120	*/
121	public QueryResultTableBuilder refRoot(String refRoot) {
122	this.refRoot = refRoot;	×
123	return this;	×
124	}
125
126	/**
127	* Builds the QueryResultTable component based on the configured parameters.
128	*
129	* @return the constructed Component
130	*/
131	public Component build() {
132	ApiResponse response = ApiCache.retrieveResponseAsync(queryRef);	×
133	String colClass = " col-" + viewDisplay.getDisplayWidth();	×
134	if (resourceWithProfile != null) {	×
135	if (response != null) {	×
136	QueryResultTable table = new QueryResultTable(markupId, queryRef, response, viewDisplay, false);	×
137	table.setContextId(contextId);	×
138	table.setPostPublishTab(postPublishTab);	×
139	table.setRefRoot(refRoot);	×
140	if (id != null && contextId != null && !id.equals(contextId)) {	×
141	table.setPartId(id);	×
142	}
143	table.setResourceWithProfile(resourceWithProfile);	×
144	table.setPageResource(resourceWithProfile);	×
145	addViewActions(table, viewDisplay, queryRef, id, contextId, resourceWithProfile, refRoot);	×
146	table.add(new AttributeAppender("class", colClass));	×
147	return table;	×
148	} else {
149	ApiResultComponent comp = new ApiResultComponent(markupId, queryRef) {	×
150	@Override
151	public Component getApiResultComponent(String markupId, ApiResponse response) {
152	QueryResultTable table = new QueryResultTable(markupId, queryRef, response, viewDisplay, false);	×
153	table.setContextId(contextId);	×
154	table.setPostPublishTab(postPublishTab);	×
155	table.setRefRoot(refRoot);	×
156	if (id != null && contextId != null && !id.equals(contextId)) {	×
157	table.setPartId(id);	×
158	}
159	table.setResourceWithProfile(resourceWithProfile);	×
160	table.setPageResource(resourceWithProfile);	×
161	addViewActions(table, viewDisplay, queryRef, id, contextId, resourceWithProfile, refRoot);	×
162	return table;	×
163	}
164	};
165	comp.add(new AttributeAppender("class", colClass));	×
166	return comp;	×
167	}
168	} else {
169	if (response != null) {	×
170	QueryResultTable table = new QueryResultTable(markupId, queryRef, response, viewDisplay, plain);	×
171	table.setContextId(contextId);	×
172	table.setPostPublishTab(postPublishTab);	×
173	table.setRefRoot(refRoot);	×
174	addViewActions(table, viewDisplay, queryRef, id, contextId, resourceWithProfile, refRoot);	×
175	table.add(new AttributeAppender("class", colClass));	×
176	return table;	×
177	} else {
178	ApiResultComponent comp = new ApiResultComponent(markupId, queryRef) {	×
179	@Override
180	public Component getApiResultComponent(String markupId, ApiResponse response) {
181	QueryResultTable table = new QueryResultTable(markupId, queryRef, response, viewDisplay, plain);	×
182	table.setContextId(contextId);	×
183	table.setPostPublishTab(postPublishTab);	×
184	table.setRefRoot(refRoot);	×
185	addViewActions(table, viewDisplay, queryRef, id, contextId, resourceWithProfile, refRoot);	×
186	return table;	×
187	}
188	};
189	comp.add(new AttributeAppender("class", colClass));	×
190	return comp;	×
191	}
192	}
193	}
194
195	/**
196	* Adds a button to the table for each result action declared by the view, linking to the
197	* action's template on the publish page. Resource-context parameters (the target field, the
198	* context, the part, and the part field) are only set when the corresponding id/contextId is
199	* available, so this also works on resource-less listings such as the general Spaces page.
200	*
201	* @param table the table to add the action buttons to
202	* @param viewDisplay the view display whose view declares the actions
203	* @param queryRef the query reference backing the table (used for refresh and query mapping)
204	* @param id the resource id, or null if there is no specific resource in context
205	* @param contextId the context id, or null if there is no context
206	*/
207	private static void addViewActions(QueryResultTable table, ViewDisplay viewDisplay, QueryRef queryRef, String id, String contextId, AbstractResourceWithProfile resourceWithProfile, String refRoot) {
208	View view = viewDisplay.getView();	×
209	if (view == null) return;	×
210	for (IRI actionIri : view.getViewResultActionList()) {	×
211	// Per-action role gating (docs/role-specific-views.md): skip an action
212	// whose gen:isVisibleTo the current viewer does not satisfy. Additive —
213	// actions without gen:isVisibleTo are unaffected. Gated against the pinned
214	// ref's authority on a ?root=-pinned page. See docs/space-ref-identity.md.
215	if (!SpaceMemberRole.isViewerEntitled(view.getActionVisibleTo(actionIri), resourceWithProfile, refRoot)) continue;	×
216	Template t = view.getTemplateForAction(actionIri);	×
217	if (t == null) continue;	×
218	String targetField = view.getTemplateTargetFieldForAction(actionIri);	×
219	if (targetField == null) targetField = "resource";	×
220	String label = view.getLabelForAction(actionIri);	×
221	if (label == null) label = "action...";	×
222	if (!label.endsWith("...")) label += "...";	×
223	PageParameters params = new PageParameters().set("template", t.getId())	×
224	.set("template-version", "latest");	×
225	if (id != null) params.set("param_" + targetField, id);	×
226	if (contextId != null) params.set("context", contextId);	×
227	if (id != null && contextId != null && !id.equals(contextId)) {	×
228	params.set("part", id);	×
229	}
230	String partField = view.getTemplatePartFieldForAction(actionIri);	×
231	if (partField != null && contextId != null) {	×
232	// The part field pre-fills a namespaced child IRI (the user fills the suffix).
233	// TODO Find a better way to pass the MaintainedResource object to this method:
234	MaintainedResource r = MaintainedResourceRepository.get().findById(contextId);	×
235	String namespace = null;	×
236	if (r != null) {	×
237	namespace = r.getNamespace();	×
238	} else if (resourceWithProfile instanceof Space) {	×
239	// The Space-creation templates' `space` placeholder has a fixed
240	// `https://w3id.org/spaces/` prefix, so the pre-fill is relative to it.
241	// Nesting the new space's IRI under this space's path makes it a
242	// sub-space via the prefix match.
243	namespace = contextId.replaceFirst("https://w3id.org/spaces/", "") + "/";	×
244	}
245	if (namespace != null) {	×
246	params.set("param_" + partField, namespace + "<SET-SUFFIX>");	×
247	}
248	}
249	String queryMapping = view.getTemplateQueryMapping(actionIri);	×
250	if (queryMapping != null && queryMapping.contains(":")) {	×
251	params.set("values-from-query", queryRef.getAsUrlString());	×
252	params.set("values-from-query-mapping", queryMapping);	×
253	}
254	params.set("refresh-upon-publish", queryRef.getAsUrlString());	×
255	if (table.getPostPublishTab() != null) params.set("postpub-tab", table.getPostPublishTab());	×
256	table.addButton(label, PublishPage.class, params);	×
257	}	×
258	}	×
259
260	}

knowledgepixels / nanodash / 27811003513

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