View Javadoc

1   /**
2    * This file Copyright (c) 2008-2011 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.rssaggregator.templates.components;
35  
36  import info.magnolia.context.MgnlContext;
37  import info.magnolia.module.rssaggregator.functions.RssAgregatorTemplatingFunctions;
38  import info.magnolia.rendering.model.RenderingModel;
39  import info.magnolia.rendering.model.RenderingModelImpl;
40  import info.magnolia.rendering.template.RenderableDefinition;
41  
42  import java.util.Date;
43  
44  import javax.inject.Inject;
45  import javax.jcr.Node;
46  
47  import org.apache.commons.lang.StringUtils;
48  
49  
50  /**
51   * Base class for rendering models.
52   *
53   * @author had
54   * @version $Id:$
55   * @param <RD>
56   */
57  public abstract class AbstractFeedModel <RD extends RenderableDefinition> extends RenderingModelImpl<RD> implements RenderingModel<RD> {
58      public static final String ORDER_BY_PUBLICATION_DATE = "@pubDate";
59      public static final String ORDER_BY_TITLE_NAME = "@title";
60      public static final String SORT_ASCENDING = "ascending";
61      public static final String SORT_DESCENDING = "descending";
62  
63      protected final RssAgregatorTemplatingFunctions rssAgregatorTemplatingFunctions;
64  
65      @Inject
66      public AbstractFeedModel(Node content, RD definition, RenderingModel<?> parent, RssAgregatorTemplatingFunctions rssAgregatorTemplatingFunctions) {
67          super(content, definition, parent);
68          this.rssAgregatorTemplatingFunctions = rssAgregatorTemplatingFunctions;
69      }
70  
71      /**
72       * This can get sometimes confusing. Freemarker will not create date from the java long time stamp format so we need to convert it to date first.
73       * Depending on circumstances (whether coming from node or from node wrapper) the time stamp will be passed in as a String or as a Long object
74       * @param timestamp
75       * @return
76       */
77      public Date convertPubDate(Object timestamp) {
78          if (timestamp == null) {
79              return null;
80          }
81          if (timestamp instanceof String) {
82              if (StringUtils.isEmpty((String) timestamp)) {
83                  return null;
84              }
85              return new Date(Long.parseLong((String) timestamp));
86          }
87  
88          return new Date((Long) timestamp);
89      }
90  
91      public String getContextPath() {
92          return MgnlContext.getContextPath();
93      }
94  
95  }