001/*
002 * (C) Copyright 2006-2007 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     bstefanescu
018 *
019 * $Id$
020 */
021
022package org.nuxeo.ecm.platform.rendering.template;
023
024import java.util.ArrayList;
025import java.util.Arrays;
026import java.util.List;
027import java.util.Map;
028
029import org.nuxeo.ecm.core.api.DocumentModel;
030
031import freemarker.template.AdapterTemplateModel;
032import freemarker.template.ObjectWrapper;
033import freemarker.template.TemplateCollectionModel;
034import freemarker.template.TemplateHashModelEx;
035import freemarker.template.TemplateModel;
036import freemarker.template.TemplateModelException;
037
038/**
039 * @author <a href="mailto:[email protected]">Bogdan Stefanescu</a>
040 */
041public class DocumentModelAdapter implements TemplateHashModelEx, AdapterTemplateModel {
042
043    protected final DocumentModel doc;
044
045    protected final ObjectWrapper wrapper;
046
047    private TemplateCollectionModel keys;
048
049    private int size = -1;
050
051    // id, name, path, type, schemas, facets, system, schema1, schema2, ...
052
053    public DocumentModelAdapter(DocumentModel doc, ObjectWrapper wrapper) {
054        this.doc = doc;
055        this.wrapper = wrapper;
056    }
057
058    public DocumentModelAdapter(DocumentModel doc) {
059        this(doc, ObjectWrapper.DEFAULT_WRAPPER);
060    }
061
062    @Override
063    @SuppressWarnings("rawtypes")
064    public Object getAdaptedObject(Class hint) {
065        return doc;
066    }
067
068    @Override
069    public TemplateModel get(String key) throws TemplateModelException {
070        DocumentFieldAccessor accessor = DocumentFieldAccessor.get(key);
071        if (accessor != null) {
072            return wrapper.wrap(accessor.getValue(doc));
073        }
074        // may be a schema name (doc.dublincore.title)
075        Map<String, Object> properties = doc.getProperties(key);
076        if (properties != null) {
077            return wrapper.wrap(properties);
078        }
079        return wrapper.wrap(null);
080    }
081
082    /**
083     * a doc model is never empty
084     */
085    @Override
086    public boolean isEmpty() throws TemplateModelException {
087        return false;
088    }
089
090    @Override
091    public TemplateCollectionModel keys() throws TemplateModelException {
092        if (keys == null) {
093            List<String> keysCol = new ArrayList<String>();
094            keysCol.addAll(DocumentFieldAccessor.getFieldNames());
095            String[] schemas = doc.getSchemas();
096            keysCol.addAll(Arrays.asList(schemas));
097            size = keysCol.size();
098            keys = (TemplateCollectionModel) wrapper.wrap(keysCol);
099        }
100        return keys;
101    }
102
103    @Override
104    public TemplateCollectionModel values() throws TemplateModelException {
105        List<Object> values = new ArrayList<Object>();
106        for (DocumentFieldAccessor accessor : DocumentFieldAccessor.getAcessors()) {
107            values.add(accessor.getValue(doc));
108        }
109        for (String schema : doc.getSchemas()) {
110            Map<String, Object> properties = doc.getProperties(schema);
111            if (properties != null) {
112                values.add(properties);
113            }
114        }
115        return (TemplateCollectionModel) wrapper.wrap(values);
116    }
117
118    @Override
119    public int size() throws TemplateModelException {
120        if (size == -1) {
121            size = DocumentFieldAccessor.getAcessorsCount() + doc.getSchemas().length;
122        }
123        return size;
124    }
125
126}