View Javadoc
1   /**
2    * This file Copyright (c) 2010-2018 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.pages.app.column;
35  
36  import info.magnolia.config.registry.DefinitionProvider;
37  import info.magnolia.config.registry.Registry.InvalidDefinitionException;
38  import info.magnolia.config.registry.Registry.NoSuchDefinitionException;
39  import info.magnolia.i18nsystem.I18nizer;
40  import info.magnolia.i18nsystem.SimpleTranslator;
41  import info.magnolia.rendering.template.TemplateDefinition;
42  import info.magnolia.rendering.template.assignment.TemplateDefinitionAssignment;
43  import info.magnolia.rendering.template.registry.TemplateDefinitionRegistry;
44  import info.magnolia.ui.contentapp.configuration.column.ConfiguredColumnDefinition;
45  
46  import java.util.Optional;
47  
48  import javax.inject.Inject;
49  import javax.jcr.Node;
50  import javax.jcr.RepositoryException;
51  
52  import com.vaadin.data.ValueProvider;
53  
54  /**
55   * ColumnDefinition for getting the template name assigned to a page.
56   */
57  public class TemplateNameColumnDefinition extends ConfiguredColumnDefinition<Node> {
58      public TemplateNameColumnDefinition() {
59          setValueProvider(TemplateNameValueProvider.class);
60      }
61  
62      /**
63       * Provides the name of the template assigned to a page in a column based view.
64       */
65      public static class TemplateNameValueProvider implements ValueProvider<Node, String> {
66          private final I18nizer i18n;
67          private final SimpleTranslator translator;
68          private final TemplateDefinitionRegistry registry;
69          private final TemplateDefinitionAssignment templateDefinitionAssignment;
70  
71          @Inject
72          public TemplateNameValueProvider(I18nizer i18n, SimpleTranslator translator,
73                                           TemplateDefinitionRegistry registry,
74                                           TemplateDefinitionAssignment templateDefinitionAssignment) {
75              this.i18n = i18n;
76              this.translator = translator;
77              this.registry = registry;
78              this.templateDefinitionAssignment = templateDefinitionAssignment;
79          }
80  
81          @Override
82          public String apply(Node node) {
83              try {
84                  // Fetch Template id of the pages node
85                  return Optional.ofNullable(templateDefinitionAssignment.getAssignedTemplate(node))
86                          .map(registry::getProvider) // Fetch template definition for the corresponding template id
87                          .map(DefinitionProvider::get)
88                          .map(i18n::decorate) // Localize the template definition and present the template title
89                          .map(TemplateDefinition::getTitle)
90                          .orElse(null);
91              } catch (InvalidDefinitionException | NoSuchDefinitionException | RepositoryException e) {
92                  return translator.translate("pages-app.browser.views.template.unknownTemplate");
93              }
94          }
95      }
96  }