#4861 Allow embedded queries to have a set page size

stroomdev66 · stroomdev66 · commit 40667f81fa9f · 2025-04-11T13:49:34.000+01:00
diff --git a/stroom-core-client/src/main/java/stroom/dashboard/client/embeddedquery/BasicEmbeddedQuerySettingsPresenter.java b/stroom-core-client/src/main/java/stroom/dashboard/client/embeddedquery/BasicEmbeddedQuerySettingsPresenter.java
@@ -25,7 +25,9 @@
 import stroom.docref.DocRef;
 import stroom.explorer.client.presenter.DocSelectionBoxPresenter;
 import stroom.query.shared.QueryDoc;
+import stroom.query.shared.QueryTablePreferences;
 import stroom.security.shared.DocumentPermission;
+import stroom.util.shared.GwtNullSafe;
 import stroom.util.shared.ModelStringUtil;
 
 import com.google.gwt.user.client.ui.Focus;
@@ -83,6 +85,11 @@ public void read(final ComponentConfig componentConfig) {
         getView().setQueryOnOpen(automate.isOpen());
         getView().setAutoRefresh(automate.isRefresh());
         getView().setRefreshInterval(automate.getRefreshInterval());
+        getView().setPageSize(GwtNullSafe.getOrElse(
+                settings,
+                EmbeddedQueryComponentSettings::getQueryTablePreferences,
+                QueryTablePreferences::getPageSize,
+                100));
     }
 
     @Override
@@ -94,6 +101,10 @@ public ComponentConfig write(final ComponentConfig componentConfig) {
     }
 
     private EmbeddedQueryComponentSettings writeSettings(final EmbeddedQueryComponentSettings settings) {
+        QueryTablePreferences queryTablePreferences = settings.getQueryTablePreferences();
+        QueryTablePreferences.Builder builder = QueryTablePreferences.copy(queryTablePreferences);
+        builder.pageSize(getView().getPageSize());
+
         return settings
                 .copy()
                 .queryRef(getQuery())
@@ -102,6 +113,7 @@ private EmbeddedQueryComponentSettings writeSettings(final EmbeddedQueryComponen
                         .refresh(getView().isAutoRefresh())
                         .refreshInterval(getView().getRefreshInterval())
                         .build())
+                .queryTablePreferences(builder.build())
                 .build();
     }
 
@@ -136,7 +148,9 @@ public boolean isDirty(final ComponentConfig componentConfig) {
         final EmbeddedQueryComponentSettings newSettings = writeSettings(oldSettings);
 
         final boolean equal = Objects.equals(oldSettings.getQueryRef(), newSettings.getQueryRef()) &&
-                Objects.equals(oldSettings.getAutomate(), newSettings.getAutomate());
+                              Objects.equals(oldSettings.getAutomate(), newSettings.getAutomate()) &&
+                              Objects.equals(oldSettings.getQueryTablePreferences(),
+                                      newSettings.getQueryTablePreferences());
 
         return !equal;
     }
@@ -157,5 +171,9 @@ public interface BasicEmbeddedQuerySettingsView
         String getRefreshInterval();
 
         void setRefreshInterval(String refreshInterval);
+
+        int getPageSize();
+
+        void setPageSize(int pageSize);
     }
 }
diff --git a/stroom-core-client/src/main/java/stroom/dashboard/client/embeddedquery/BasicEmbeddedQuerySettingsViewImpl.java b/stroom-core-client/src/main/java/stroom/dashboard/client/embeddedquery/BasicEmbeddedQuerySettingsViewImpl.java
@@ -18,6 +18,7 @@
 
 import stroom.dashboard.client.embeddedquery.BasicEmbeddedQuerySettingsPresenter.BasicEmbeddedQuerySettingsView;
 import stroom.widget.tickbox.client.view.CustomCheckBox;
+import stroom.widget.valuespinner.client.ValueSpinner;
 
 import com.google.gwt.dom.client.Style.Unit;
 import com.google.gwt.uibinder.client.UiBinder;
@@ -48,10 +49,15 @@ public class BasicEmbeddedQuerySettingsViewImpl
     CustomCheckBox autoRefresh;
     @UiField
     TextBox refreshInterval;
+    @UiField
+    ValueSpinner pageSize;
 
     @Inject
     public BasicEmbeddedQuerySettingsViewImpl(final Binder binder) {
         widget = binder.createAndBindUi(this);
+        pageSize.setValue(100);
+        pageSize.setMin(1);
+        pageSize.setMax(10000);
     }
 
     @Override
@@ -117,6 +123,16 @@ public void setRefreshInterval(final String refreshInterval) {
         this.refreshInterval.setText(refreshInterval);
     }
 
+    @Override
+    public int getPageSize() {
+        return pageSize.getIntValue();
+    }
+
+    @Override
+    public void setPageSize(final int pageSize) {
+        this.pageSize.setValue(pageSize);
+    }
+
     public void onResize() {
         ((RequiresResize) widget).onResize();
     }
diff --git a/stroom-core-client/src/main/java/stroom/dashboard/client/embeddedquery/EmbeddedQueryPresenter.java b/stroom-core-client/src/main/java/stroom/dashboard/client/embeddedquery/EmbeddedQueryPresenter.java
@@ -745,6 +745,7 @@ public void run() {
     protected void changeSettings() {
         super.changeSettings();
         if (currentTablePresenter != null) {
+            currentTablePresenter.changeSettings();
             currentTablePresenter.refresh();
         }
         loadEmbeddedQuery();
diff --git a/stroom-core-client/src/main/java/stroom/dashboard/client/table/TablePresenter.java b/stroom-core-client/src/main/java/stroom/dashboard/client/table/TablePresenter.java
@@ -1020,9 +1020,7 @@ private void updatePageSize() {
         final int start = dataGrid.getVisibleRange().getStart();
         dataGrid.setVisibleRange(new Range(
                 start,
-                tableComponentSettings.getPageSize() == null
-                        ? 100
-                        : tableComponentSettings.getPageSize()));
+                GwtNullSafe.getOrElse(tableComponentSettings, TableComponentSettings::getPageSize, 100)));
     }
 
     @Override
diff --git a/stroom-core-client/src/main/java/stroom/query/client/presenter/QueryResultTablePresenter.java b/stroom-core-client/src/main/java/stroom/query/client/presenter/QueryResultTablePresenter.java
@@ -69,6 +69,7 @@
 import com.google.gwt.dom.client.Style.Unit;
 import com.google.gwt.safecss.shared.SafeStylesBuilder;
 import com.google.gwt.safehtml.shared.SafeHtml;
+import com.google.gwt.view.client.Range;
 import com.google.inject.Inject;
 import com.google.inject.Provider;
 import com.google.web.bindery.event.shared.EventBus;
@@ -286,6 +287,21 @@ private void setApplyValueFilters(final boolean applyValueFilters) {
         }
     }
 
+    public void changeSettings() {
+        final QueryTablePreferences queryTablePreferences = getQueryTablePreferences();
+        updatePageSize(queryTablePreferences);
+
+        // Update styles and re-render
+        tableRowStyles.setConditionalFormattingRules(queryTablePreferences.getConditionalFormattingRules());
+    }
+
+    private void updatePageSize(final QueryTablePreferences queryTablePreferences) {
+        final int start = dataGrid.getVisibleRange().getStart();
+        dataGrid.setVisibleRange(new Range(
+                start,
+                GwtNullSafe.getOrElse(queryTablePreferences, QueryTablePreferences::getPageSize, 100)));
+    }
+
     private void setPause(final boolean pause,
                           final boolean refresh) {
         // If currently paused then refresh if we are allowed.
@@ -781,7 +797,9 @@ public void setQueryTablePreferencesConsumer(final Consumer<QueryTablePreference
 
     public void updateQueryTablePreferences() {
         // Change value filter state.
-        setApplyValueFilters(queryTablePreferencesSupplier.get().applyValueFilters());
+        final QueryTablePreferences queryTablePreferences = queryTablePreferencesSupplier.get();
+        setApplyValueFilters(queryTablePreferences.applyValueFilters());
+        updatePageSize(queryTablePreferences);
         refresh();
     }
 
diff --git a/stroom-core-client/src/main/resources/stroom/dashboard/client/embeddedquery/BasicEmbeddedQuerySettingsViewImpl.ui.xml b/stroom-core-client/src/main/resources/stroom/dashboard/client/embeddedquery/BasicEmbeddedQuerySettingsViewImpl.ui.xml
@@ -1,7 +1,8 @@
 <!DOCTYPE ui:UiBinder SYSTEM "http://dl.google.com/gwt/DTD/xhtml.ent">
 <ui:UiBinder xmlns:ui="urn:ui:com.google.gwt.uibinder"
              xmlns:g="urn:import:com.google.gwt.user.client.ui"
-             xmlns:v="urn:import:stroom.widget.tickbox.client.view"
+             xmlns:tickbox="urn:import:stroom.widget.tickbox.client.view"
+             xmlns:valuespinner="urn:import:stroom.widget.valuespinner.client"
              xmlns:form="urn:import:stroom.widget.form.client">
     <g:FlowPanel styleName="max form">
         <form:FormGroup identity="basicQuerySettingsId" label="Id">
@@ -14,13 +15,16 @@
             <g:SimplePanel ui:field="queryRef" addStyleNames="w-100"/>
         </form:FormGroup>
         <form:FormGroup>
-            <v:CustomCheckBox ui:field="queryOnOpen" identity="basicQuerySettingsQueryOnOpen" label="Query On Open"/>
+            <tickbox:CustomCheckBox ui:field="queryOnOpen" identity="basicQuerySettingsQueryOnOpen" label="Query On Open"/>
         </form:FormGroup>
         <form:FormGroup>
-            <v:CustomCheckBox ui:field="autoRefresh" identity="basicQuerySettingsAutoRefresh" label="Auto Refresh"/>
+            <tickbox:CustomCheckBox ui:field="autoRefresh" identity="basicQuerySettingsAutoRefresh" label="Auto Refresh"/>
         </form:FormGroup>
         <form:FormGroup identity="basicQuerySettingsRefreshInterval" label="Refresh Interval">
             <g:TextBox ui:field="refreshInterval" addStyleNames="w-100"/>
         </form:FormGroup>
+        <form:FormGroup identity="basicTableSettingsPageSize" label="Table Page Size">
+            <valuespinner:ValueSpinner ui:field="pageSize" width="200px"/>
+        </form:FormGroup>
     </g:FlowPanel>
 </ui:UiBinder> 
diff --git a/stroom-core-client/src/main/resources/stroom/dashboard/client/table/BasicTableSettingsViewImpl.ui.xml b/stroom-core-client/src/main/resources/stroom/dashboard/client/table/BasicTableSettingsViewImpl.ui.xml
@@ -2,7 +2,7 @@
 <ui:UiBinder xmlns:ui="urn:ui:com.google.gwt.uibinder"
              xmlns:g="urn:import:com.google.gwt.user.client.ui" xmlns:i="urn:import:stroom.item.client"
              xmlns:tickbox="urn:import:stroom.widget.tickbox.client.view"
-             xmlns:v="urn:import:stroom.widget.valuespinner.client"
+             xmlns:valuespinner="urn:import:stroom.widget.valuespinner.client"
              xmlns:form="urn:import:stroom.widget.form.client">
     <g:FlowPanel styleName="max form">
         <form:FormGroup identity="basicTableSettingsId" label="Id">
@@ -27,7 +27,7 @@
             <g:TextBox ui:field="maxResults" addStyleNames="w-100"/>
         </form:FormGroup>
         <form:FormGroup identity="basicTableSettingsPageSize" label="Table Page Size">
-            <v:ValueSpinner ui:field="pageSize" width="200px"/>
+            <valuespinner:ValueSpinner ui:field="pageSize" width="200px"/>
         </form:FormGroup>
         <form:FormGroup>
             <tickbox:CustomCheckBox ui:field="showDetail" identity="basicTableSettingsShowGroupDetail" label="Show Group Detail"/>
diff --git a/unreleased_changes/20250411_124920_475__4861.md b/unreleased_changes/20250411_124920_475__4861.md
@@ -0,0 +1,24 @@
+* Issue **#4861** : Allow embedded queries to have a set page size.
+
+
+```sh
+# ********************************************************************************
+# Issue title: Embedded Query, I cant' set the Table Page Size
+# Issue link:  https://github.com/gchq/stroom/issues/4861
+# ********************************************************************************
+
+# ONLY the top line will be included as a change entry in the CHANGELOG.
+# The entry should be in GitHub flavour markdown and should be written on a SINGLE
+# line with no hard breaks. You can have multiple change files for a single GitHub issue.
+# The  entry should be written in the imperative mood, i.e. 'Fix nasty bug' rather than
+# 'Fixed nasty bug'.
+#
+# Examples of acceptable entries are:
+#
+#
+# * Issue **123** : Fix bug with an associated GitHub issue in this repository
+#
+# * Issue **namespace/other-repo#456** : Fix bug with an associated GitHub issue in another repository
+#
+# * Fix bug with no associated GitHub issue.
+```

Original file line number	Diff line number	Diff line change
`@@ -745,6 +745,7 @@ public void run() {`
`745`	`745`	`protected void changeSettings() {`
`746`	`746`	`super.changeSettings();`
`747`	`747`	`if (currentTablePresenter != null) {`
	`748`	`+ currentTablePresenter.changeSettings();`
`748`	`749`	`currentTablePresenter.refresh();`
`749`	`750`	`}`
`750`	`751`	`loadEmbeddedQuery();`