source.dussan.org Git - sonarqube.git/blob

   1 /*
   2  * Sonar, open source software quality management tool.
   3  * Copyright (C) 2008-2012 SonarSource
   4  * mailto:contact AT sonarsource DOT com
   5  *
   6  * Sonar is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 3 of the License, or (at your option) any later version.
  10  *
  11  * Sonar is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with Sonar; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
  19  */
  20 package org.sonar.plugins.core.dashboards;
  21
  22 import org.sonar.api.web.Dashboard;
  23 import org.sonar.api.web.DashboardLayout;
  24 import org.sonar.api.web.DashboardTemplate;
  25 import org.sonar.plugins.core.widgets.FilterWidget;
  26
  27 /**
  28  * Base class for global dashboard containing a single
  29  * filter widget.
  30  *
  31  * @since 3.1
  32  */
  33 abstract class AbstractFilterDashboard extends DashboardTemplate {
  34   @Override
  35   public final Dashboard createDashboard() {
  36     Dashboard dashboard = Dashboard.create()
  37         .setGlobal(true)
  38         .setLayout(DashboardLayout.ONE_COLUMN);
  39
  40     dashboard
  41         .addWidget("filter", 1)
  42         .setProperty(FilterWidget.FILTER, getFilterKey());
  43
  44     doCompleteDashboard(dashboard);
  45     return dashboard;
  46   }
  47
  48   /**
  49    * The key of the filter to display.
  50    */
  51   protected abstract String getFilterKey();
  52
  53   /**
  54    * Override this method to complete dashboard.
  55    */
  56   protected void doCompleteDashboard(Dashboard dashboard) {
  57   }
  58 }