View Javadoc
1   /**
2    * This file Copyright (c) 2013-2015 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.dam.asset.model;
35  
36  import freemarker.template.AdapterTemplateModel;
37  import freemarker.template.ObjectWrapper;
38  import freemarker.template.SimpleCollection;
39  import freemarker.template.TemplateCollectionModel;
40  import freemarker.template.TemplateHashModelEx;
41  import freemarker.template.TemplateModel;
42  import freemarker.template.TemplateModelException;
43  
44  import info.magnolia.freemarker.models.MagnoliaModelFactory;
45  import info.magnolia.freemarker.models.MagnoliaObjectWrapper;
46  
47  /**
48   * A wrapper for Asset used in FTL to directly access properties (in particular
49   * Metadata properties).
50   * 
51   */
52  public class AssetMapModel implements TemplateHashModelEx, AdapterTemplateModel {
53  
54      /**
55       * Implements a {@link PrioritizedMagnoliaModelFactory} in order to be able to configure it via {@link info.magnolia.freemarker.FreemarkerConfig}.
56       */
57      public static final class Factory implements MagnoliaModelFactory {
58          @SuppressWarnings("rawtypes")
59          @Override
60          public Class factoryFor() {
61              return AssetMap.class;
62          }
63  
64          @Override
65          public AdapterTemplateModel create(Object object, ObjectWrapper wrapper) {
66              return new AssetMapModel((AssetMap) object, (MagnoliaObjectWrapper) wrapper);
67          }
68      };
69  
70      private AssetMap assetMap;
71      private MagnoliaObjectWrapper wrapper;
72  
73      public AssetMapModel() {
74      }
75  
76      public AssetMapModel(AssetMap assetMap, MagnoliaObjectWrapper wrapper) {
77          this.assetMap = assetMap;
78          this.wrapper = wrapper;
79      }
80  
81      @Override
82      public TemplateModel get(String key) throws TemplateModelException {
83          return wrapper.wrap(assetMap.get(key));
84      }
85  
86      @Override
87      public boolean isEmpty() throws TemplateModelException {
88          return (size() == 0);
89      }
90  
91      @Override
92      public int size() throws TemplateModelException {
93          return assetMap.size();
94      }
95  
96      @Override
97      public TemplateCollectionModel keys() throws TemplateModelException {
98          return new SimpleCollection(assetMap.keySet().iterator());
99      }
100 
101     @Override
102     public TemplateCollectionModel values() throws TemplateModelException {
103         return (TemplateCollectionModel) wrapper.wrap(assetMap.values().iterator());
104     }
105 
106     @SuppressWarnings("rawtypes")
107     @Override
108     public Object getAdaptedObject(Class hint) {
109         return this.assetMap;
110     }
111 
112 }