record-manager-ui#36 Implement export filtered records to excel #52

kostobog · 2024-07-09T16:11:55Z

@blcham
Implements partially kbss-cvut/record-manager-ui#36

- add sparql query - add export related entities - add dao layer code to retrieve exported record data - add ExcelRecordExporter service exporting records to excel

src/main/java/cz/cvut/kbss/study/rest/PatientRecordController.java

blcham · 2024-07-10T07:26:51Z

src/main/java/cz/cvut/kbss/study/rest/PatientRecordController.java

-    @GetMapping(value = "/export", produces = MediaType.APPLICATION_JSON_VALUE)
-    public List<PatientRecord> exportRecords(
+    @GetMapping(value = "/export", produces = {MediaType.APPLICATION_JSON_VALUE, Constants.MEDIA_TYPE_EXCEL})
+    public ResponseEntity<?> exportRecords(


We just need to make sure that we did not change implementation of JSON export.

@LaChope please test it when implementing UI

I exported twice, before and after this PR, output JSON file is similar

blcham · 2024-07-10T07:28:49Z

src/main/java/cz/cvut/kbss/study/rest/util/RecordFilterMapper.java

    /**
     * Maps the specified parameters to a new {@link RecordFilterParams} instance.
     *
     * @param params Request parameters to map
     * @return New {@code RecordFilterParams} instance
     */
-    public static RecordFilterParams constructRecordFilter(MultiValueMap<String, String> params) {
+    public static RecordFilterParams constructRecordFilter(final RecordFilterParams result, MultiValueMap<String, String> params) {


Not sure why we need this.

This is here as we did not want to include into query MIN_MODIFIED_DATE and MAX_MODIFIED_DATE .. this should be modified to remove.

DO NOT FIX NOW.

blcham · 2024-07-10T07:45:25Z

src/main/java/cz/cvut/kbss/study/rest/util/RecordFilterMapper.java

    /**
     * Maps the specified parameters to a new {@link RecordFilterParams} instance.
     *
     * @param params Request parameters to map
     * @return New {@code RecordFilterParams} instance
     */
-    public static RecordFilterParams constructRecordFilter(MultiValueMap<String, String> params) {
+    public static RecordFilterParams constructRecordFilter(final RecordFilterParams result, MultiValueMap<String, String> params) {


This is here as we did not want to include into query MIN_MODIFIED_DATE and MAX_MODIFIED_DATE .. this should be modified to remove.

blcham · 2024-07-10T07:45:40Z

src/main/java/cz/cvut/kbss/study/rest/util/RecordFilterMapper.java

    /**
     * Maps the specified parameters to a new {@link RecordFilterParams} instance.
     *
     * @param params Request parameters to map
     * @return New {@code RecordFilterParams} instance
     */
-    public static RecordFilterParams constructRecordFilter(MultiValueMap<String, String> params) {
+    public static RecordFilterParams constructRecordFilter(final RecordFilterParams result, MultiValueMap<String, String> params) {


DO NOT FIX NOW.

src/main/java/cz/cvut/kbss/study/rest/PatientRecordController.java

…rvletResponse

… when extracting exportType from request. exportType uri parameter takes precedence over Accept header.

…nstitution request parameter. - remove unnecessary annotations from method parameters

kostobog · 2024-07-10T09:52:27Z

@blcham
One more thing, Excel export exports all records matching the filter in the query parameters but it ignores the pagination parameters. Is this ok?

blcham · 2024-07-10T10:19:26Z

@blcham One more thing, Excel export exports all records matching the filter in the query parameters but it ignores the pagination parameters. Is this ok?

It should behave same as for export to JSON, so if it ignores it as well then it is ok. (you can even test on kbss :)

…st parameters support for excel export

…emplate.xlsx file

kostobog · 2024-07-10T13:10:40Z

@blcham
Paging support for excel export is implemented

blcham · 2024-07-10T13:37:39Z

src/main/java/cz/cvut/kbss/study/rest/PatientRecordController.java

-            UriComponentsBuilder uriBuilder, HttpServletResponse response) {
+            @RequestParam(required = false) MultiValueMap<String, String> params,
+            UriComponentsBuilder uriBuilder, HttpServletRequest request, HttpServletResponse response) {
+        MediaType exportType = Stream.of(


@LaChope here the way how to differentiate between JSON and EXCEL

Either use accept header or parameter in the query string:

public static final String EXPORT_TYPE_PARAM = "exportType"; public static final String MEDIA_TYPE_EXCEL = "application/vnd.ms-excel"

Thus you need to use alternatively following query parameters:
&exportType=application/vnd.ms-excel
&exportType=application/json

@blcham @kostobog Not sure that is works:

ok, I'm not sure why it does not work, but you can try the exportType query parameter instead of the Accept header.

@blcham @LaChope
Record paging implementation does not support sorting without the page parameter. Try to remove the sort parameter or add a page parameter.

Removing the sort parameter fixed it. I can try with the page parameter but I do not know what does it represent? The number of sheet?

@LaChope
The page parameter represents the index of the page. The page has size number of records. (request parameter, default is 25 records per page).

I am not sure what are you trying to do. There are three two things that I think makes sense to implement.

Export all records matching the filter specified by the user. I think the user specifies the filter using the table.

In this case the request should contain the same filter, e.g. min max date, institution, as the one used to filter the records in the table. page, size and sort parameters should be omitted.

Export the records on the current page.

In this case the request should contain the filter parameters as well as the and the page, size, and sort parameters.

kostobog added 4 commits July 9, 2024 17:19

[Fix partially #36] Add dependency on POI

665b025

[Fix partially #36] Add excel template for record export

90f3c3c

[Fix partially #36] Add excel export implementation

2e3dd4e

- add sparql query - add export related entities - add dao layer code to retrieve exported record data - add ExcelRecordExporter service exporting records to excel

[Fix partially #36] Extend rest api to support record export in Excel

e5a7048

kostobog requested a review from blcham July 9, 2024 16:11

blcham reviewed Jul 10, 2024

View reviewed changes

blcham approved these changes Jul 10, 2024

View reviewed changes

blcham requested changes Jul 10, 2024

View reviewed changes

src/main/java/cz/cvut/kbss/study/rest/PatientRecordController.java Show resolved Hide resolved

kostobog added 3 commits July 10, 2024 10:54

[Fix partially kbss-cvut/record-manager-ui#36] Remove injected httpSe…

397569d

…rvletResponse

[Fix partially kbss-cvut/record-manager-ui#36] Consider Accept header…

1918810

… when extracting exportType from request. exportType uri parameter takes precedence over Accept header.

[Fix partially kbss-cvut/record-manager-ui#36] Refactor handling of i…

0b985cd

…nstitution request parameter. - remove unnecessary annotations from method parameters

kostobog force-pushed the feature/record-manager-ui-36-export-filtered-records-to-excel branch from d4a230e to 0b985cd Compare July 10, 2024 09:39

kostobog added 3 commits July 10, 2024 15:05

[Fix partially kbss-cvut/record-manager-ui#36] Implement paging reque…

d05e5dc

…st parameters support for excel export

[Fix partially kbss-cvut/record-manager-ui#36] Export modified date

077c007

[Fix partially kbss-cvut/record-manager-ui#36] Update record-export-t…

483c586

…emplate.xlsx file

blcham merged commit 4ec18b7 into main Jul 10, 2024
2 checks passed

blcham deleted the feature/record-manager-ui-36-export-filtered-records-to-excel branch July 10, 2024 13:30

blcham reviewed Jul 10, 2024

View reviewed changes

blcham mentioned this pull request Jul 10, 2024

Support export to CSV/Excel kbss-cvut/record-manager-ui#36

Closed

2 tasks

LaChope mentioned this pull request Jul 10, 2024

Added support for export of records with MSExcel kbss-cvut/record-manager-ui#178

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

record-manager-ui#36 Implement export filtered records to excel #52

record-manager-ui#36 Implement export filtered records to excel #52

kostobog commented Jul 9, 2024

blcham Jul 10, 2024

blcham Jul 10, 2024

LaChope Jul 10, 2024

blcham Jul 10, 2024

blcham Jul 10, 2024

blcham Jul 10, 2024

blcham Jul 10, 2024

blcham Jul 10, 2024

kostobog commented Jul 10, 2024

blcham commented Jul 10, 2024 •

edited

Loading

kostobog commented Jul 10, 2024

blcham Jul 10, 2024

blcham Jul 10, 2024 •

edited

Loading

LaChope Jul 10, 2024

blcham Jul 10, 2024

kostobog Jul 10, 2024 •

edited

Loading

LaChope Jul 10, 2024 •

edited

Loading

kostobog Jul 10, 2024 •

edited

Loading

record-manager-ui#36 Implement export filtered records to excel #52

record-manager-ui#36 Implement export filtered records to excel #52

Conversation

kostobog commented Jul 9, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kostobog commented Jul 10, 2024

blcham commented Jul 10, 2024 • edited Loading

kostobog commented Jul 10, 2024

Choose a reason for hiding this comment

blcham Jul 10, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kostobog Jul 10, 2024 • edited Loading

Choose a reason for hiding this comment

LaChope Jul 10, 2024 • edited Loading

Choose a reason for hiding this comment

kostobog Jul 10, 2024 • edited Loading

Choose a reason for hiding this comment

blcham commented Jul 10, 2024 •

edited

Loading

blcham Jul 10, 2024 •

edited

Loading

kostobog Jul 10, 2024 •

edited

Loading

LaChope Jul 10, 2024 •

edited

Loading

kostobog Jul 10, 2024 •

edited

Loading