001: /*
002: * Copyright (c) 2003 The Visigoth Software Society. All rights
003: * reserved.
004: *
005: * Redistribution and use in source and binary forms, with or without
006: * modification, are permitted provided that the following conditions
007: * are met:
008: *
009: * 1. Redistributions of source code must retain the above copyright
010: * notice, this list of conditions and the following disclaimer.
011: *
012: * 2. Redistributions in binary form must reproduce the above copyright
013: * notice, this list of conditions and the following disclaimer in
014: * the documentation and/or other materials provided with the
015: * distribution.
016: *
017: * 3. The end-user documentation included with the redistribution, if
018: * any, must include the following acknowledgement:
019: * "This product includes software developed by the
020: * Visigoth Software Society (http://www.visigoths.org/)."
021: * Alternately, this acknowledgement may appear in the software itself,
022: * if and wherever such third-party acknowledgements normally appear.
023: *
024: * 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the
025: * project contributors may be used to endorse or promote products derived
026: * from this software without prior written permission. For written
027: * permission, please contact visigoths@visigoths.org.
028: *
029: * 5. Products derived from this software may not be called "FreeMarker" or "Visigoth"
030: * nor may "FreeMarker" or "Visigoth" appear in their names
031: * without prior written permission of the Visigoth Software Society.
032: *
033: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
034: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
035: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
036: * DISCLAIMED. IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR
037: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
038: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
039: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
040: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
041: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
042: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
043: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
044: * SUCH DAMAGE.
045: * ====================================================================
046: *
047: * This software consists of voluntary contributions made by many
048: * individuals on behalf of the Visigoth Software Society. For more
049: * information on the Visigoth Software Society, please see
050: * http://www.visigoths.org/
051: */
052:
053: package freemarker.ext.beans;
054:
055: import java.util.Collection;
056: import java.util.List;
057:
058: import freemarker.ext.util.ModelFactory;
059: import freemarker.template.ObjectWrapper;
060: import freemarker.template.TemplateCollectionModel;
061: import freemarker.template.TemplateModel;
062: import freemarker.template.TemplateModelException;
063: import freemarker.template.TemplateModelIterator;
064: import freemarker.template.TemplateSequenceModel;
065:
066: /**
067: * <p>A special case of {@link BeanModel} that can wrap Java collections
068: * and that implements the {@link TemplateCollectionModel} in order to be usable
069: * in a <tt><foreach></tt> block.</p>
070: * @author Attila Szegedi
071: * @version $Id: CollectionModel.java,v 1.22 2003/06/03 13:21:32 szegedia Exp $
072: */
073: public class CollectionModel extends StringModel implements
074: TemplateCollectionModel, TemplateSequenceModel {
075: static final ModelFactory FACTORY = new ModelFactory() {
076: public TemplateModel create(Object object, ObjectWrapper wrapper) {
077: return new CollectionModel((Collection) object,
078: (BeansWrapper) wrapper);
079: }
080: };
081:
082: /**
083: * Creates a new model that wraps the specified collection object.
084: * @param collection the collection object to wrap into a model.
085: * @param wrapper the {@link BeansWrapper} associated with this model.
086: * Every model has to have an associated {@link BeansWrapper} instance. The
087: * model gains many attributes from its wrapper, including the caching
088: * behavior, method exposure level, method-over-item shadowing policy etc.
089: */
090: public CollectionModel(Collection collection, BeansWrapper wrapper) {
091: super (collection, wrapper);
092: }
093:
094: /**
095: * Retrieves the i-th object from the collection, wrapped as a TemplateModel.
096: * @throws TemplateModelException if the index is out of bounds, or the
097: * underlying collection is not a List.
098: */
099: public TemplateModel get(int index) throws TemplateModelException {
100: if (object instanceof List) {
101: try {
102: return wrap(((List) object).get(index));
103: } catch (IndexOutOfBoundsException e) {
104: throw new TemplateModelException(
105: "Index out of bounds: " + index);
106: }
107: } else {
108: throw new TemplateModelException(
109: "Underlying collection is not a list, it's "
110: + object.getClass().getName());
111: }
112: }
113:
114: public TemplateModelIterator iterator() {
115: return new IteratorModel(((Collection) object).iterator(),
116: wrapper);
117: }
118:
119: public int size() {
120: return ((Collection) object).size();
121: }
122: }
|