Home » freemarker-2.3.13 » freemarker.ext.beans » [javadoc | source]

    1   /*
    2    * Copyright (c) 2003 The Visigoth Software Society. All rights
    3    * reserved.
    4    *
    5    * Redistribution and use in source and binary forms, with or without
    6    * modification, are permitted provided that the following conditions
    7    * are met:
    8    *
    9    * 1. Redistributions of source code must retain the above copyright
   10    *    notice, this list of conditions and the following disclaimer.
   11    *
   12    * 2. Redistributions in binary form must reproduce the above copyright
   13    *    notice, this list of conditions and the following disclaimer in
   14    *    the documentation and/or other materials provided with the
   15    *    distribution.
   16    *
   17    * 3. The end-user documentation included with the redistribution, if
   18    *    any, must include the following acknowledgement:
   19    *       "This product includes software developed by the
   20    *        Visigoth Software Society (http://www.visigoths.org/)."
   21    *    Alternately, this acknowledgement may appear in the software itself,
   22    *    if and wherever such third-party acknowledgements normally appear.
   23    *
   24    * 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the 
   25    *    project contributors may be used to endorse or promote products derived
   26    *    from this software without prior written permission. For written
   27    *    permission, please contact visigoths@visigoths.org.
   28    *
   29    * 5. Products derived from this software may not be called "FreeMarker" or "Visigoth"
   30    *    nor may "FreeMarker" or "Visigoth" appear in their names
   31    *    without prior written permission of the Visigoth Software Society.
   32    *
   33    * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   34    * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   35    * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   36    * DISCLAIMED.  IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR
   37    * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   38    * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   39    * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   40    * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   41    * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   42    * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   43    * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   44    * SUCH DAMAGE.
   45    * ====================================================================
   46    *
   47    * This software consists of voluntary contributions made by many
   48    * individuals on behalf of the Visigoth Software Society. For more
   49    * information on the Visigoth Software Society, please see
   50    * http://www.visigoths.org/
   51    */
   52   
   53   package freemarker.ext.beans;
   54   
   55   import java.util.Collection;
   56   import java.util.List;
   57   
   58   import freemarker.ext.util.ModelFactory;
   59   import freemarker.template.ObjectWrapper;
   60   import freemarker.template.TemplateCollectionModel;
   61   import freemarker.template.TemplateModel;
   62   import freemarker.template.TemplateModelException;
   63   import freemarker.template.TemplateModelIterator;
   64   import freemarker.template.TemplateSequenceModel;
   65   
   66   /**
   67    * <p>A special case of {@link BeanModel} that can wrap Java collections
   68    * and that implements the {@link TemplateCollectionModel} in order to be usable 
   69    * in a <tt>&lt;foreach></tt> block.</p>
   70    * @author Attila Szegedi
   71    * @version $Id: CollectionModel.java,v 1.22 2003/06/03 13:21:32 szegedia Exp $
   72    */
   73   public class CollectionModel
   74   extends
   75       StringModel
   76   implements
   77       TemplateCollectionModel,
   78       TemplateSequenceModel
   79   {
   80       static final ModelFactory FACTORY =
   81           new ModelFactory()
   82           {
   83               public TemplateModel create(Object object, ObjectWrapper wrapper)
   84               {
   85                   return new CollectionModel((Collection)object, (BeansWrapper)wrapper);
   86               }
   87           };
   88   
   89   
   90       /**
   91        * Creates a new model that wraps the specified collection object.
   92        * @param collection the collection object to wrap into a model.
   93        * @param wrapper the {@link BeansWrapper} associated with this model.
   94        * Every model has to have an associated {@link BeansWrapper} instance. The
   95        * model gains many attributes from its wrapper, including the caching 
   96        * behavior, method exposure level, method-over-item shadowing policy etc.
   97        */
   98       public CollectionModel(Collection collection, BeansWrapper wrapper)
   99       {
  100           super(collection, wrapper);
  101       }
  102   
  103       /**
  104        * Retrieves the i-th object from the collection, wrapped as a TemplateModel.
  105        * @throws TemplateModelException if the index is out of bounds, or the
  106        * underlying collection is not a List.
  107        */
  108       public TemplateModel get(int index)
  109       throws
  110           TemplateModelException
  111       {
  112           if(object instanceof List)
  113           {
  114               try
  115               {
  116                   return wrap(((List)object).get(index));
  117               }
  118               catch(IndexOutOfBoundsException e)
  119               {
  120                   return null;
  121   //                throw new TemplateModelException("Index out of bounds: " + index);
  122               }
  123           }
  124           else
  125           {
  126               throw new TemplateModelException("Underlying collection is not a list, it's " + object.getClass().getName());
  127           }
  128       }
  129       
  130       public TemplateModelIterator iterator()
  131       {
  132           return new IteratorModel(((Collection)object).iterator(), wrapper);
  133       }
  134   
  135       public int size()
  136       {
  137           return ((Collection)object).size();
  138       }
  139   }

Home » freemarker-2.3.13 » freemarker.ext.beans » [javadoc | source]