ParliamentDecisionFlowPageModContentFactoryImpl.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.parliament.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.PageCommandParliamentRankingConstants;
  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 ParliamentDecisionFlowPageModContentFactoryImpl extends AbstractParliamentPageModContentFactoryImpl {

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

  60.     /** The Constant YEAR_SELECTOR_LABEL. */
  61.     private static final String YEAR_SELECTOR_LABEL = "Select year";

  63.     /** The decision flow chart manager. */
  64.     @Autowired
  65.     private DecisionFlowChartManager decisionFlowChartManager;

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

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

  84.         addYearSelector(panelContent, selectedYear);
  85.         addDecisionFlowChart(panelContent, committeeMap, selectedYear);
  86.         addDecisionSummary(panelContent, committeeMap, selectedYear);

  88.         recordPageVisit(parameters, selectedYear);

  90.         return panelContent;
  91.     }

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


  111.     /**
  112.      * Setup menu and header.
  113.      *
  114.      * @param menuBar the menu bar
  115.      * @param panel the panel
  116.      * @param panelContent the panel content
  117.      */
  118.     private void setupMenuAndHeader(final MenuBar menuBar, final Panel panel, final VerticalLayout panelContent) {
  119.         getParliamentMenuItemFactory().createParliamentTopicMenu(menuBar);
  120.         CardInfoRowUtil.createPageHeader(panel, panelContent,
  121.             ParliamentPageTitleConstants.DECISION_FLOW_TITLE,
  122.             ParliamentPageTitleConstants.DECISION_FLOW_SUBTITLE,
  123.             ParliamentPageTitleConstants.DECISION_FLOW_DESC);
  124.     }

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

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

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

  170.         panelContent.addComponent(yearSelector);
  171.         panelContent.setExpandRatio(yearSelector, ContentRatio.SMALL);
  172.     }

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

  186.         panelContent.addComponent(chart);
  187.         panelContent.setExpandRatio(chart, ContentRatio.LARGE);
  188. }

  190.     /**
  191.      * Adds the decision summary.
  192.      *
  193.      * @param panelContent the panel content
  194.      * @param committeeMap the committee map
  195.      * @param selectedYear the selected year
  196.      */
  197.     private void addDecisionSummary(final VerticalLayout panelContent,
  198.             final Map<String, List<ViewRiksdagenCommittee>> committeeMap, final String selectedYear) {
  199.         final TextArea summaryArea = decisionFlowChartManager.createCommitteeeDecisionSummary(committeeMap, selectedYear);
  200.         summaryArea.setSizeFull();
  201.         summaryArea.setReadOnly(true);

  203.         panelContent.addComponent(summaryArea);
  204.         panelContent.setExpandRatio(summaryArea, ContentRatio.SMALL_GRID);
  205.     }

  207.     /**
  208.      * Record page visit.
  209.      *
  210.      * @param parameters the parameters
  211.      * @param selectedYear the selected year
  212.      */
  213.     private void recordPageVisit(final String parameters, final String selectedYear) {
  214.         getPageActionEventHelper().createPageEvent(
  215.             ViewAction.VISIT_PARLIAMENT_RANKING_VIEW,
  216.             ApplicationEventGroup.USER,
  217.             NAME,
  218.             parameters,
  219.             selectedYear
  220.         );
  221.     }

  223.     /**
  224.      * Matches.
  225.      *
  226.      * @param page the page
  227.      * @param parameters the parameters
  228.      * @return true, if successful
  229.      */
  230.     @Override
  231.     public boolean matches(final String page, final String parameters) {
  232.         return PageCommandParliamentRankingConstants.COMMAND_CHARTS_DECISION_FLOW.matches(page, parameters);
  233.     }
  234. }
Created with JaCoCo 0.8.12.202403310830