1 /**
2 * This file Copyright (c) 2013-2014 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.module.googlesitemap.app.field.transformer;
35
36 import info.magnolia.module.googlesitemap.GoogleSiteMapConfiguration;
37 import info.magnolia.module.googlesitemap.SiteMapNodeTypes;
38 import info.magnolia.ui.form.field.definition.ConfiguredFieldDefinition;
39 import info.magnolia.ui.form.field.transformer.basic.BasicTransformer;
40 import info.magnolia.ui.vaadin.integration.jcr.DefaultPropertyUtil;
41
42 import java.util.HashMap;
43
44 import org.slf4j.Logger;
45 import org.slf4j.LoggerFactory;
46
47 import com.vaadin.data.Item;
48 import com.vaadin.data.Property;
49
50 /**
51 * SiteMap specific implementation of {@link BasicTransformer}.<br>
52 * Always display the field default value (defined in {@link SiteMapService}) if the related field property has an empty value.<br>
53 * Used to define default value for:<br>
54 * - googleSitemapChangefreq
55 * - googleSitemapPriority
56 *
57 * @param <T>
58 * @deprecated Since 2.1 version, as the detail dialog only uses {@link info.magnolia.module.googlesitemap.bean.SiteMapEntry} this transformer is no more needed.
59 */
60 @Deprecated
61 public class SiteMapTransformer<T> extends BasicTransformer<T> {
62
63 private static final Logger log = LoggerFactory.getLogger(SiteMapTransformer.class);
64 private static HashMap<String, String> propertyToHandle;
65 static {
66 propertyToHandle = new HashMap<String, String>();
67 propertyToHandle.put(SiteMapNodeTypes.GoogleSiteMap.SITEMAP_CHANGEFREQ, GoogleSiteMapConfiguration.DEFAULT_CHANGE_FREQUENCY);
68 propertyToHandle.put(SiteMapNodeTypes.GoogleSiteMap.SITEMAP_PRIORITY, Double.toString(GoogleSiteMapConfiguration.DEFAULT_PRIORITY));
69 }
70
71 public SiteMapTransformer(Item relatedFormItem, ConfiguredFieldDefinition definition, Class<T> type) {
72 super(relatedFormItem, definition, type);
73 }
74
75 @Override
76 protected <T> Property<T> getOrCreateProperty(Class<T> type) {
77 Property<T> property = super.getOrCreateProperty(type);
78 if (property.getValue() == null && propertyToHandle.containsKey(definition.getName())) {
79 try {
80 property.setValue((T) DefaultPropertyUtil.createTypedValue(property.getType(), propertyToHandle.get(definition.getName())));
81 } catch (Exception e) {
82 log.warn("Could not create a default value of type '{}' based on '{}'. Null stay as default value");
83 }
84 }
85 return property;
86 }
87 }