AbstractPageModContentFactoryImpl.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.common.pagemode;

  21. import org.springframework.beans.factory.annotation.Autowired;

  23. import com.hack23.cia.service.api.ApplicationManager;
  24. import com.hack23.cia.web.impl.ui.application.action.PageActionEventHelper;
  25. import com.hack23.cia.web.impl.ui.application.views.common.chartfactory.api.AdminChartDataManager;
  26. import com.hack23.cia.web.impl.ui.application.views.common.formfactory.api.FormFactory;
  27. import com.hack23.cia.web.impl.ui.application.views.common.gridfactory.api.GridFactory;
  28. import com.hack23.cia.web.impl.ui.application.views.common.menufactory.api.ApplicationMenuItemFactory;
  29. import com.hack23.cia.web.impl.ui.application.views.common.pagelinks.api.PageLinkFactory;
  30. import com.hack23.cia.web.impl.ui.application.views.common.pagelinks.api.PageModeMenuCommand;
  31. import com.hack23.cia.web.impl.ui.application.views.common.sizing.ContentRatio;
  32. import com.vaadin.server.Sizeable.Unit;
  33. import com.vaadin.ui.HorizontalLayout;
  34. import com.vaadin.ui.TabSheet;
  35. import com.vaadin.ui.TabSheet.Tab;
  36. import com.vaadin.ui.VerticalLayout;

  38. /**
  39.  * The Class AbstractPageModContentFactoryImpl.
  40.  */
  41. public abstract class AbstractPageModContentFactoryImpl implements PageModeContentFactory {

  43.     /** The Constant CURRENT_PAGE_VISIT_HISTORY. */
  44.     public static final String CURRENT_PAGE_VISIT_HISTORY = "Current Page Visit History";

  46.     /** The Constant DEFAULT_RESULTS_PER_PAGE. */
  47.     public static final int DEFAULT_RESULTS_PER_PAGE = 250;

  49.     /** The Constant GENERAL_PAGE_MODE_PAGE_VISIT. */
  50.     public static final String GENERAL_PAGE_MODE_PAGE_VISIT = "General Page Mode Page Visit";

  52.     /** The admin chart data manager. */
  53.     @Autowired
  54.     private AdminChartDataManager adminChartDataManager;

  56.     /** The application manager. */
  57.     @Autowired
  58.     private ApplicationManager applicationManager;

  60.     /** The form factory. */
  61.     @Autowired
  62.     private FormFactory formFactory;

  64.     /** The grid factory. */
  65.     @Autowired
  66.     private GridFactory gridFactory;

  68.     /** The menu item factory. */
  69.     @Autowired
  70.     private ApplicationMenuItemFactory menuItemFactory;

  72.     /** The page action event helper. */
  73.     @Autowired
  74.     private PageActionEventHelper pageActionEventHelper;

  76.     /** The page link factory. */
  77.     @Autowired
  78.     private PageLinkFactory pageLinkFactory;

  80.     /**
  81.      * Instantiates a new abstract page mod content factory impl.
  82.      */
  83.     protected AbstractPageModContentFactoryImpl() {
  84.         super();
  85.     }

  87.     /**
  88.      * Creates the page visit history.
  89.      *
  90.      * @param pageName
  91.      *            the page name
  92.      * @param pageId
  93.      *            the page id
  94.      * @param panelContent
  95.      *            the panel content
  96.      */
  97.     protected final void createPageVisitHistory(final String pageName, final String pageId,
  98.             final VerticalLayout panelContent) {

  100.         final TabSheet tabsheet = createTabSheet(panelContent);

  102.         final HorizontalLayout tabContentPageItemRankHistory = createTabContent(tabsheet, CURRENT_PAGE_VISIT_HISTORY);
  103.         adminChartDataManager.createApplicationActionEventPageElementDailySummaryChart(tabContentPageItemRankHistory,
  104.                 pageName, pageId);

  106.         final HorizontalLayout tabContentPageModeSummary = createTabContent(tabsheet, GENERAL_PAGE_MODE_PAGE_VISIT);
  107.         adminChartDataManager.createApplicationActionEventPageModeDailySummaryChart(tabContentPageModeSummary,
  108.                 pageName);

  110.     }

  112.     /**
  113.      * Creates the panel content.
  114.      *
  115.      * @return the vertical layout
  116.      */
  117.     protected static final VerticalLayout createPanelContent() {
  118.         final VerticalLayout panelContent = new VerticalLayout();
  119.         panelContent.setMargin(true);
  120.         panelContent.setWidth(100, Unit.PERCENTAGE);
  121.         panelContent.setHeight(100, Unit.PERCENTAGE);
  122.         panelContent.setStyleName("v-layout-content-overview-panel-level1");
  123.         return panelContent;
  124.     }

  126.     /**
  127.      * Gets the admin chart data manager.
  128.      *
  129.      * @return the admin chart data manager
  130.      */
  131.     protected final AdminChartDataManager getAdminChartDataManager() {
  132.         return adminChartDataManager;
  133.     }

  135.     /**
  136.      * Gets the application manager.
  137.      *
  138.      * @return the application manager
  139.      */
  140.     protected final ApplicationManager getApplicationManager() {
  141.         return applicationManager;
  142.     }

  144.     /**
  145.      * Gets the form factory.
  146.      *
  147.      * @return the form factory
  148.      */
  149.     protected final FormFactory getFormFactory() {
  150.         return formFactory;
  151.     }

  153.     /**
  154.      * Gets the grid factory.
  155.      *
  156.      * @return the grid factory
  157.      */
  158.     protected final GridFactory getGridFactory() {
  159.         return gridFactory;
  160.     }

  162.     /**
  163.      * Gets the menu item factory.
  164.      *
  165.      * @return the menu item factory
  166.      */
  167.     protected final ApplicationMenuItemFactory getMenuItemFactory() {
  168.         return menuItemFactory;
  169.     }

  171.     /**
  172.      * Gets the page action event helper.
  173.      *
  174.      * @return the page action event helper
  175.      */
  176.     protected final PageActionEventHelper getPageActionEventHelper() {
  177.         return pageActionEventHelper;
  178.     }

  180.     /**
  181.      * Gets the page id.
  182.      *
  183.      * @param parameters
  184.      *            the parameters
  185.      * @return the page id
  186.      */
  187.     protected static final String getPageId(final String parameters) {
  188.         return PageModeMenuCommand.getPageId(parameters);
  189.     }

  191.     /**
  192.      * Gets the page link factory.
  193.      *
  194.      * @return the page link factory
  195.      */
  196.     protected final PageLinkFactory getPageLinkFactory() {
  197.         return pageLinkFactory;
  198.     }

  200.     /**
  201.      * Gets the page nr.
  202.      *
  203.      * @param parameters the parameters
  204.      * @return the page nr
  205.      */
  206.     protected static final int getPageNr(final String parameters) {
  207.         final String cleanedString = parameters;
  208.         String pageNrValue;
  209.         if (cleanedString != null && cleanedString.contains("[") && cleanedString.contains("]")) {
  210.             pageNrValue = cleanedString.substring(cleanedString.indexOf('[') + 1, cleanedString.lastIndexOf(']'));
  211.         } else {
  212.             pageNrValue = "";
  213.         }

  215.         int pageNr = 1;

  217.         if (pageNrValue.length() > 0 && !pageNrValue.contains("/")) {
  218.             pageNr = Integer.parseInt(pageNrValue);
  219.         }
  220.         return pageNr;
  221.     }

  223.     /**
  224.      * Creates a TabSheet and adds it to the given panel content.
  225.      *
  226.      * @param panelContent the panel content
  227.      * @return the created TabSheet
  228.      */
  229.     private TabSheet createTabSheet(final VerticalLayout panelContent) {
  230.         final TabSheet tabsheet = new TabSheet();
  231.         tabsheet.setWidth(100, Unit.PERCENTAGE);
  232.         tabsheet.setHeight(100, Unit.PERCENTAGE);

  234.         panelContent.addComponent(tabsheet);
  235.         panelContent.setExpandRatio(tabsheet, ContentRatio.LARGE);

  237.         return tabsheet;
  238.     }

  240.     /**
  241.      * Creates a HorizontalLayout for a tab and adds it to the given TabSheet.
  242.      *
  243.      * @param tabsheet the TabSheet
  244.      * @param caption  the caption for the tab
  245.      * @return the created HorizontalLayout
  246.      */
  247.     private HorizontalLayout createTabContent(final TabSheet tabsheet, final String caption) {
  248.         final HorizontalLayout tabContent = new HorizontalLayout();
  249.         tabContent.setWidth(100, Unit.PERCENTAGE);
  250.         tabContent.setHeight(100, Unit.PERCENTAGE);
  251.         final Tab tab = tabsheet.addTab(tabContent);
  252.         tab.setCaption(caption);
  253.         return tabContent;
  254.     }
  255. }
Created with JaCoCo 0.8.12.202403310830