Browse filter results on page #473

litvinovg · 2024-09-16T12:32:39Z

What does this pull request do?

Adds an option to select search filter to display filtered results on custom page.

What's new?

Refactored PagedSearchController.
Added search filter option to ManagePageGenerator
Refactored ProcessN3GetterDataMap
Created new data getter class display:SearchFilterValuesDataGetter , java implementation in SearchFilterValuesDataGetter.java
Created boolean data property search:reverseFacetOrder to reverse sort order of facets.
Created filters to filter result in alphabetical indexes
:filter_label_regex - default regex filter that uses i18n field :field_label_display with name locale + _label_display
:filter_raw_label_regex - fallback regex filter that uses nameRaw search field for VIVO instances without i18n support
search:limitDisplayTo object property was created to limit user access to display of search groups, filters, values.
Resolved bug on search page which appears if user select too many filters. In that case search results are empty and selected filter values are not shown on the page, so the user can't unselect them.
Added options to sort results, number of results on page and "Download results" options on custom pages

How should this be tested?

A description of what steps someone could take to:

Create a new page in PageManagement menu. use type filter as an example
Browse page, try selecting facets, alphabetical index, pagination
Test the same in non i18n VIVO

Additional Notes:

This change require documentation to be updated.

Interested parties

@hauschke @VIVO-project/vivo-committers

Reviewers' expertise

Candidates for reviewing this PR should have some of the following expertises:

Java
JavaScript
FreeMarker
SPARQL
Ontologies
Natural language knowledge
1. English
2. German
3. Spanish
4. French
5. Portuguese
6. Russian
7. Serbian

Reviewers' report template

Please update the following template which should be used by reviewers.

General comment

A reviewer should provide here comments and suggestions for requested changes if any.

Testing

A reviewer should briefly describe here how it was tested

Code reviewing

A reviewer should briefly describe here which part was code reviewed

chenejac

@litvinovg I don't have any big complain on your code, the implementation is aligned with other Vitro DataGetters implementations. Please find a couple of my tiny comments.

The PR feature has been tested and it works as it is described with the exception of person's publications.

api/src/main/java/edu/cornell/mannlib/vitro/webapp/search/controller/PagedSearchController.java

.../vitro/webapp/edit/n3editing/configuration/preprocessors/utils/ProcessDataGetterN3Utils.java

...ain/java/edu/cornell/mannlib/vitro/webapp/utils/dataGetter/SearchFilterValuesDataGetter.java

home/src/main/resources/rdf/i18n/de_DE/interface-i18n/firsttime/vitro_UiLabel.ttl

chenejac · 2024-10-11T08:27:37Z

home/src/main/resources/rdf/i18n/pt_BR/interface-i18n/firsttime/vitro_UiLabel.ttl

+uil-data:browse_results_alphabetical_index.Vitro
+        rdf:type         owl:NamedIndividual ;
+        rdf:type         uil:UILabel ;
+        rdfs:label       "a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v,w,x,y,z"@pt-BR ;


Should check this with a Portuguese native speaker

…r in SearchFilterValuesDataGetter

…s with results before values without results. Added :limitDisplayTo object property.

…stom pages.

chenejac

@litvinovg please check my comments. Moreover, the search filter by publication year requests rebuilding search index in the case some record publication date has been changed? I was expected it might be automatically done in the background.

chenejac · 2025-01-03T08:18:15Z

api/src/main/java/edu/cornell/mannlib/vitro/webapp/search/controller/FilterValue.java

@@ -14,18 +14,14 @@ public class FilterValue {

    private boolean isDefaultValue;

-    private boolean publiclyAvailable = true;
+    private boolean display = false;


displayed? isDisplayed()? setDisplayed(boolean value)?

chenejac · 2025-01-03T08:21:51Z

.../edit/n3editing/configuration/preprocessors/utils/ProcessSearchFilterValuesDataGetterN3.java

+
+    public List<FieldVTwo> retrieveFields(int counter) {
+        List<FieldVTwo> fields = new ArrayList<FieldVTwo>();
+        fields.add(new FieldVTwo().setName(getVarName("filterUri", counter)));


ProcessSearchFilterValuesDataGetterN3.searchFilterVarBase instead of "filterUri".

chenejac · 2025-01-06T09:42:29Z

api/src/main/java/edu/cornell/mannlib/vitro/webapp/search/controller/SearchFilter.java

    private String type = FILTER;
    private String rangeText = "";
    private String rangeInput = "";
-    private boolean hidden = false;
+    private boolean display = false;


chenejac · 2025-01-06T09:45:37Z

api/src/main/java/edu/cornell/mannlib/vitro/webapp/search/controller/SearchFilterGroup.java

@@ -6,8 +6,7 @@ public class SearchFilterGroup {

    private String id;
    private String label;
-    private boolean isPublic = false;
-    private boolean hidden = true;
+    private boolean display = false;


chenejac · 2025-01-06T10:29:45Z

api/src/main/java/edu/cornell/mannlib/vitro/webapp/search/controller/SearchFiltering.java

+                SearchFiltering.addRangeFilter(query, searchFilter);
+            }
+            for (FilterValue fv : searchFilter.getValues().values()) {
+                if (fv.isDefault() || fv.getSelected()) {


Should we renamed the method taking into account change in the implementation? If I understood well it includes now also selected, not just default filters.

chenejac · 2025-01-06T10:50:20Z

webapp/src/main/webapp/templates/freemarker/body/menupage/browseSearchFilterValues.ftl

+                    <div id="browsing-options">
+                        <@showSortOptions />
+                        <@sl.showHits "filter-form" />
+                        <img id="downloadIcon" alt="${i18n().download_results}" title="${i18n().download_results}" />


Do we need here src attribute? There is no image for download.

Browse filter results

3150cc0

litvinovg mentioned this pull request Sep 16, 2024

Browse filter results on page vivo-project/VIVO#4005

Open

litvinovg linked an issue Sep 16, 2024 that may be closed by this pull request

Browse filter results on custom page vivo-project/VIVO#4006

Open

chenejac self-requested a review September 26, 2024 12:54

improved regular expression for alphabetical index

11f6643

chenejac requested changes Oct 11, 2024

View reviewed changes

litvinovg added 15 commits October 11, 2024 12:26

fixed access modifiers

5e1fb02

fixed identations

2eea1d0

added else block

33538f8

Limit default search results by all the possible values for the filte…

b566bca

…r in SearchFilterValuesDataGetter

limit results to all possible values by default

5a4af67

converted getInput function to macro

4c281bb

converted getLabel function into macro. Turned off autocomplete

312f3da

extracted javascript for search results

8233aff

Simplified check for any selected value

461946f

refactored paged results

9a6569c

Support additional filters on page

d6b6cb2

removed boostrap 3 dependency from search results page

6559e3d

get real filter value counts

7c7bf91

prevent hidden filter values from being displayed

c6cbc04

disable additional filters by default

af7a82e

litvinovg force-pushed the browse-filter-results-page-option branch from 0e97588 to af7a82e Compare October 23, 2024 11:26

litvinovg added 8 commits October 24, 2024 12:55

fixes for date range filters

cec25fe

sort options

b852b9c

show range options in case it is already selected

6e8dd2e

Improvements for page template

8fbfcac

style fixes

b44b68b

Fix to return button to clean querytext value

8709c47

fixed checkstyle violation

8aaf319

search: refactored filter, group, value display. Display filter value…

52e4766

…s with results before values without results. Added :limitDisplayTo object property.

litvinovg added 2 commits November 26, 2024 10:51

checkstyle fixes

5c856dc

updated ontology

a180e13

litvinovg force-pushed the browse-filter-results-page-option branch from 3fc2ad1 to a180e13 Compare November 26, 2024 10:16

litvinovg added 7 commits November 26, 2024 11:39

removed not needed statement from ontology

92379ae

Do not show inactive values without results. Hide empty filters on cu…

0a023ac

…stom pages.

download results from custom search page

afee954

simplified freemarker macro

cd98648

fixed adding labels to filter values and querytext filter

9539ff9

Removed redundant query for SearchFilterValuesDataGetter

d0a21e2

checkstyle fix

2db1ce9

litvinovg force-pushed the browse-filter-results-page-option branch from e69258f to 2db1ce9 Compare November 28, 2024 06:40

litvinovg requested a review from chenejac November 28, 2024 07:32

litvinovg added 3 commits November 28, 2024 12:46

set font size for download search results text

588776c

Added sorting object type to sort filter values

064d82d

reduced produced html

473b8fe

chenejac requested a review from brianjlowe December 23, 2024 09:53

chenejac requested changes Jan 6, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Browse filter results on page #473

Browse filter results on page #473

litvinovg commented Sep 16, 2024 •

edited

Loading

chenejac left a comment

chenejac Oct 11, 2024

chenejac left a comment

chenejac Jan 3, 2025

chenejac Jan 3, 2025

chenejac Jan 6, 2025

chenejac Jan 6, 2025

chenejac Jan 6, 2025

chenejac Jan 6, 2025

Browse filter results on page #473

Are you sure you want to change the base?

Browse filter results on page #473

Conversation

litvinovg commented Sep 16, 2024 • edited Loading

What does this pull request do?

What's new?

How should this be tested?

Additional Notes:

Interested parties

Reviewers' expertise

Reviewers' report template

General comment

Testing

Code reviewing

chenejac left a comment

Choose a reason for hiding this comment

chenejac Oct 11, 2024

Choose a reason for hiding this comment

chenejac left a comment

Choose a reason for hiding this comment

chenejac Jan 3, 2025

Choose a reason for hiding this comment

chenejac Jan 3, 2025

Choose a reason for hiding this comment

chenejac Jan 6, 2025

Choose a reason for hiding this comment

chenejac Jan 6, 2025

Choose a reason for hiding this comment

chenejac Jan 6, 2025

Choose a reason for hiding this comment

chenejac Jan 6, 2025

Choose a reason for hiding this comment

litvinovg commented Sep 16, 2024 •

edited

Loading