CommitteeDecisionFlowPageModContentFactoryImpl.java

  1. /*
  2.  * Copyright 2010-2025 James Pether Sörling
  3.  *
  4.  * Licensed under the Apache License, Version 2.0 (the "License");
  5.  * you may not use this file except in compliance with the License.
  6.  * You may obtain a copy of the License at
  7.  *
  8.  *   http://www.apache.org/licenses/LICENSE-2.0
  9.  *
  10.  * Unless required by applicable law or agreed to in writing, software
  11.  * distributed under the License is distributed on an "AS IS" BASIS,
  12.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13.  * See the License for the specific language governing permissions and
  14.  * limitations under the License.
  15.  *
  16.  *  $Id$
  17.  *  $HeadURL$
  18. */
  19. package com.hack23.cia.web.impl.ui.application.views.user.committee.pagemode;

  21. import java.time.LocalDate;
  22. import java.time.ZoneOffset;
  23. import java.util.Collections;
  24. import java.util.Comparator;
  25. import java.util.List;
  26. import java.util.Locale;
  27. import java.util.Map;
  28. import java.util.stream.Collectors;
  29. import java.util.stream.IntStream;

  31. import org.springframework.beans.factory.annotation.Autowired;
  32. import org.springframework.security.access.annotation.Secured;
  33. import org.springframework.stereotype.Component;

  35. import com.hack23.cia.model.internal.application.data.committee.impl.ViewRiksdagenCommittee;
  36. import com.hack23.cia.model.internal.application.system.impl.ApplicationEventGroup;
  37. import com.hack23.cia.web.impl.ui.application.action.ViewAction;
  38. import com.hack23.cia.web.impl.ui.application.views.common.chartfactory.api.DecisionFlowChartManager;
  39. import com.hack23.cia.web.impl.ui.application.views.common.menufactory.api.pagecommands.PageCommandCommitteeConstants;
  40. import com.hack23.cia.web.impl.ui.application.views.common.pagemode.CardInfoRowUtil;
  41. import com.hack23.cia.web.impl.ui.application.views.common.sizing.ContentRatio;
  42. import com.hack23.cia.web.impl.ui.application.views.pageclicklistener.DecisionFlowValueChangeListener;
  43. import com.hack23.cia.web.widgets.charts.SankeyChart;
  44. import com.vaadin.ui.ComboBox;
  45. import com.vaadin.ui.Layout;
  46. import com.vaadin.ui.MenuBar;
  47. import com.vaadin.ui.Panel;
  48. import com.vaadin.ui.TextArea;
  49. import com.vaadin.ui.VerticalLayout;

  51. /**
  52.  * The Class ParliamentDecisionFlowPageModContentFactoryImpl.
  53.  */
  54. @Component
  55. public final class CommitteeDecisionFlowPageModContentFactoryImpl extends AbstractCommitteePageModContentFactoryImpl {

  57.     /** The Constant DEFAULT_YEAR. */
  58.     private static final String DEFAULT_YEAR = "2023/24";

  60.     /** The decision flow chart manager. */
  61.     @Autowired
  62.     private DecisionFlowChartManager decisionFlowChartManager;

  64.     /**
  65.      * Creates the content.
  66.      *
  67.      * @param parameters the parameters
  68.      * @param menuBar the menu bar
  69.      * @param panel the panel
  70.      * @return the layout
  71.      */
  72.     @Secured({ "ROLE_ANONYMOUS", "ROLE_USER", "ROLE_ADMIN" })
  73.     @Override
  74.     public Layout createContent(final String parameters, final MenuBar menuBar, final Panel panel) {
  75.         final VerticalLayout panelContent = createPanelContent();
  76.         final String pageId = getPageId(parameters);
  77.         final ViewRiksdagenCommittee committee = getItem(parameters);

  79.         setupMenuAndHeader(menuBar, panel, panelContent, pageId, committee);
  80.         final String selectedYear = extractSelectedYear(parameters);
  81.         final Map<String, List<ViewRiksdagenCommittee>> committeeMap = loadCommitteeMap();

  83.         addYearSelector(panelContent, selectedYear, pageId);
  84.         addDecisionFlowChart(panelContent, committee, committeeMap, selectedYear);
  85.         addDecisionSummary(panelContent, committee, selectedYear);

  87.         recordPageVisit(parameters, pageId);

  89.         return panelContent;
  90.     }

  92.     /**
  93.      * Creates list of available years for selection.
  94.      * Goes from 2010/11 up to (currentYear+1)/(currentYear+2).
  95.      *
  96.      * @return Unmodifiable list of year strings in format "YYYY/YY"
  97.      */
  98.     private static List<String> createAvailableYears() {
  99.         final int currentYear = LocalDate.now((ZoneOffset.UTC)).getYear();
  100.         return IntStream.rangeClosed(2010, currentYear + 1)
  101.             .mapToObj(year -> String.format(Locale.ENGLISH,"%d/%02d", year, (year + 1) % 100))
  102.             .sorted(Comparator.reverseOrder()) // Most recent years first
  103.             .collect(Collectors.collectingAndThen(
  104.                 Collectors.toList(),
  105.                 Collections::unmodifiableList
  106.             ));
  107.     }

  109.     /**
  110.      * Setup menu and header.
  111.      *
  112.      * @param menuBar the menu bar
  113.      * @param panel the panel
  114.      * @param panelContent the panel content
  115.      * @param pageId the page id
  116.      * @param committee the committee
  117.      */
  118.     private void setupMenuAndHeader(final MenuBar menuBar, final Panel panel, final VerticalLayout panelContent,
  119.             final String pageId, final ViewRiksdagenCommittee committee) {
  120.         getCommitteeMenuItemFactory().createCommitteeeMenuBar(menuBar, pageId);
  121.         CardInfoRowUtil.createPageHeader(panel, panelContent,
  122.             CommitteeViewConstants.DF_TITLE_HEADER + committee.getEmbeddedId().getDetail(),
  123.             CommitteeViewConstants.DF_TITLE,
  124.             CommitteeViewConstants.DF_DESCRIPTION
  125.         );
  126.     }

  128.     /**
  129.      * Extract selected year.
  130.      *
  131.      * @param parameters the parameters
  132.      * @return the string
  133.      */
  134.     private String extractSelectedYear(final String parameters) {
  135.         if (parameters != null && parameters.contains("[") && parameters.contains("]")) {
  136.             return parameters.substring(
  137.                 parameters.indexOf('[') + 1,
  138.                 parameters.lastIndexOf(']')
  139.             );
  140.         }
  141.         return DEFAULT_YEAR;
  142.     }

  144.     /**
  145.      * Load committee map.
  146.      *
  147.      * @return the map
  148.      */
  149.     private Map<String, List<ViewRiksdagenCommittee>> loadCommitteeMap() {
  150.         return getApplicationManager()
  151.             .getDataContainer(ViewRiksdagenCommittee.class)
  152.             .getAll()
  153.             .stream()
  154.             .collect(Collectors.groupingBy(
  155.                 committee -> committee.getEmbeddedId().getOrgCode().toUpperCase(Locale.ENGLISH)
  156.             ));
  157.     }

  159.     /**
  160.      * Adds the year selector.
  161.      *
  162.      * @param panelContent the panel content
  163.      * @param selectedYear the selected year
  164.      * @param pageId the page id
  165.      */
  166.     private void addYearSelector(final VerticalLayout panelContent, final String selectedYear, final String pageId) {
  167.         final ComboBox<String> yearSelector = new ComboBox<>(CommitteeViewConstants.DF_YEAR_SELECTOR, createAvailableYears());
  168.         yearSelector.setWidth("200px");
  169.         yearSelector.setEmptySelectionAllowed(false);
  170.         yearSelector.setSelectedItem(selectedYear);
  171.         yearSelector.addValueChangeListener(new DecisionFlowValueChangeListener(NAME, pageId));

  173.         panelContent.addComponent(yearSelector);
  174.         panelContent.setExpandRatio(yearSelector, ContentRatio.SMALL2);
  175.     }

  177.     /**
  178.      * Adds the decision flow chart.
  179.      *
  180.      * @param panelContent the panel content
  181.      * @param committee the committee
  182.      * @param committeeMap the committee map
  183.      * @param selectedYear the selected year
  184.      */
  185.     private void addDecisionFlowChart(final VerticalLayout panelContent, final ViewRiksdagenCommittee committee,
  186.             final Map<String, List<ViewRiksdagenCommittee>> committeeMap, final String selectedYear) {
  187.         final SankeyChart chart = decisionFlowChartManager.createCommitteeDecisionFlow(
  188.             committee, committeeMap, selectedYear
  189.         );
  190.         chart.setWidth("100%");

  192.         panelContent.addComponent(chart);
  193.         panelContent.setExpandRatio(chart, ContentRatio.LARGE);
  194.     }

  196.     /**
  197.      * Adds the decision summary.
  198.      *
  199.      * @param panelContent the panel content
  200.      * @param committee the committee
  201.      * @param selectedYear the selected year
  202.      */
  203.     private void addDecisionSummary(final VerticalLayout panelContent,
  204.             final ViewRiksdagenCommittee committee, final String selectedYear) {
  205.         final TextArea summaryArea = decisionFlowChartManager.createCommitteeeDecisionSummary(
  206.             committee, selectedYear
  207.         );
  208.         summaryArea.setSizeFull();
  209.         summaryArea.setReadOnly(true);

  211.         panelContent.addComponent(summaryArea);
  212.         panelContent.setExpandRatio(summaryArea, ContentRatio.SMALL_GRID);
  213.     }

  215.     /**
  216.      * Record page visit.
  217.      *
  218.      * @param parameters the parameters
  219.      * @param pageId the page id
  220.      */
  221.     private void recordPageVisit(final String parameters, final String pageId) {
  222.         getPageActionEventHelper().createPageEvent(
  223.             ViewAction.VISIT_COMMITTEE_VIEW,
  224.             ApplicationEventGroup.USER,
  225.             NAME,
  226.             parameters,
  227.             pageId
  228.         );
  229.     }

  231.     /**
  232.      * Matches.
  233.      *
  234.      * @param page the page
  235.      * @param parameters the parameters
  236.      * @return true, if successful
  237.      */
  238.     @Override
  239.     public boolean matches(final String page, final String parameters) {
  240.         return PageCommandCommitteeConstants.COMMAND_CHARTS_DECISION_FLOW.matches(page, parameters);
  241.     }
  242. }
Created with JaCoCo 0.8.12.202403310830