/*
    * Copyright (c) 2001 - 2005 ivata limited.
    * All rights reserved.
    * -----------------------------------------------------------------------------
    * ivata masks may be redistributed under the GNU General Public
    * License as published by the Free Software Foundation;
    * version 2 of the License.
    *
    * These programs are free software; you can redistribute them and/or
   * modify them under the terms of the GNU General Public License
   * as published by the Free Software Foundation; version 2 of the License.
   *
   * These programs are distributed in the hope that they will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   *
   * See the GNU General Public License in the file LICENSE.txt for more
   * details.
   *
   * If you would like a copy of the GNU General Public License write to
   *
   * Free Software Foundation, Inc.
   * 59 Temple Place - Suite 330
   * Boston, MA 02111-1307, USA.
   *
   *
   * To arrange commercial support and licensing, contact ivata at
   *                  http://www.ivata.com/contact.jsp
   * -----------------------------------------------------------------------------
   * $Log: MapEntryTag.java,v $
   * Revision 1.4  2005/04/22 09:48:12  colinmacleod
   * Added checkigng for a missing page
   * context attribute.
   *
   * Revision 1.3  2005/04/09 18:04:20  colinmacleod
   * Changed copyright text to GPL v2 explicitly.
   *
   * Revision 1.2  2005/03/10 10:28:26  colinmacleod
   * Fixed for tomcat4.
   * Now uses getAttribute and only in page context.
   * (Was findAttribute before.)
   *
   * Revision 1.1  2005/01/19 12:58:20  colinmacleod
   * Moved from ivata groupware.
   *
   * Revision 1.2  2004/11/12 18:16:07  colinmacleod
   * Ordered imports.
   *
   * Revision 1.1  2004/09/30 15:16:03  colinmacleod
   * Split off addressbook elements into security subproject.
   *
   * Revision 1.2  2004/03/21 21:16:18  colinmacleod
   * Shortened name to ivata op.
   *
   * Revision 1.1.1.1  2004/01/27 20:57:58  colinmacleod
   * Moved ivata openportal to SourceForge..
   *
   * Revision 1.1.1.1  2003/10/13 20:50:13  colin
   * Restructured portal into subprojects
   *
   * Revision 1.1  2003/02/25 08:15:50  colin
   * moved to jsp category
   *
   * Revision 1.5  2003/02/13 10:52:20  colin
   * changed to always include the body (helps with cached tags)
   *
   * Revision 1.4  2003/02/04 17:43:51  colin
   * copyright notice
   *
   * Revision 1.3  2003/01/24 12:03:28  colin
   * added mapName attribute
   * -----------------------------------------------------------------------------
   */
  package com.ivata.mask.web.tag.util;
  
  import java.util.Map;
  
  import javax.servlet.jsp.JspException;
  import javax.servlet.jsp.JspWriter;
  import javax.servlet.jsp.tagext.BodyContent;
  import javax.servlet.jsp.tagext.BodyTagSupport;
  
  
  /***
   * <p>This tag must always be contained within a {@link MapTag MapTag}
   * and defines the name and value of an entry in the map.</p>
   *
   * <p><b>Tag attributes:</b><br/>
   * <table cellpadding='2' cellspacing='5' border='0' align='center'
   * width='85%'>
   *   <tr class='TableHeadingColor'>
   *     <th>attribute</th>
   *     <th>reqd.</th>
   *     <th>param. class</th>
   *     <th width='100%'>description</th>
   *   </tr>
   *   <tr class='TableRowColor'>
   *     <td>mapName</td>
   *     <td>false</td>
  *     <td><code>String</code></td>
  *     <td>If the <code>mapEntry</code> is not inside a
  * <code>map</code> tag, use this attribute to specify a
  * <code>java.util.Map</code> instance in the current page
  * context.</td>
  *   </tr>
  *   <tr class='TableRowColor'>
  *     <td>name</td>
  *     <td>true</td>
  *     <td><code>String</code></td>
  *     <td>Specifies the name of the entry to put in the parent
  * map.</td>
  *   </tr>
  *   <tr class='TableRowColor'>
  *     <td>value</td>
  *     <td>false</td>
  *     <td><code>String</code></td>
  *     <td>Specifies the value of the entry with the name
  * speciified. If this attribute is not specified, you should specify
  * a tag body.</td>
  *   </tr>
  * </table>
  * </p>
  *
  *
  * @since ivata masks 0.5 (2002-01-23)
  * @author Colin MacLeod
  * <a href='mailto:colin.macleod@ivata.com'>colin.macleod@ivata.com</a>
  * @version $Revision: 1.4 $
  */
 public class MapEntryTag extends BodyTagSupport {
     /***
      * <p>If the <code>mapEntry</code> is not inside a <code>map</code>
      * tag, use this attribute to specify a <code>java.util.Map</code>
      * instance in the current page context.</p>
      */
     private String mapName = null;
     /***
      * <p>Refers to the parent of this map item.</p>
      */
     private MapTag mapTag;
     /***
      * <p>Specifies the name of the entry to put in the parent map.</p>
      */
     private String name;
     /***
      * <p>Specifies the value of the entry to put in the parent map.</p>
      */
     private String value;
 
     /***
      * <p>This method is called after the JSP engine processes the body
      * content of the tag.</p>
      * @exception JspException encapsulates any exception when calling
      * {@link #writeTagBodyContent writeTagBodyContent}.
      * @return <code>SKIP_BODY</code> since we only ever want to evaluate
      * this tag once.
      * @see #writeTagBodyContent( JspWriter out, BodyContent bodyContent
      * )
      *
      */
     public int doAfterBody() throws JspException {
         if (getBodyContent() != null) {
             value = getBodyContent().getString();
         }
         return SKIP_BODY;
     }
 
     /***
      * <p>This method is called after the JSP engine finished processing
      * the tag.</p>
      *
      * @exception JspException encapsulates any exception when calling
      * <code>out.println</code>
      * @return <code>EVAL_PAGE</code> since we always want to evaluate
      * the page after this tag.
      */
     public int doEndTag() throws JspException {
         Map map;
         if (mapName != null) {
             map = (Map) pageContext.findAttribute(mapName);
             if (map == null) {
                 throw new JspException("Cannot find map called '"
                         + mapName
                         + "' at any scope.");
             }
         } else {
             map = mapTag.getMap();
         }
 
         if (value == null) {
             map.remove(name);
         } else {
             map.put(name, value);
         }
         return EVAL_PAGE;
     }
 
     /***
      * <p>This method is called when the JSP engine encounters the start
      * tag, after the attributes are processed.<p>
      *
      * <p>Scripting variables (if any) have their values set here.</p>
      *
      * @return <code>EVAL_BODY_BUFFERED</code> if no value was specified,
      * otherwise <code>SKIP_BODY</code>.
      * @throws JspException encapsulates any exception when calling
      * <code>out.println</code>
      */
     public int doStartTag() throws JspException {
         mapTag = (MapTag) findAncestorWithClass(this, MapTag.class);
         if ((mapTag == null)
                 && (mapName == null)) {
             throw new JspException("ERROR in MapEntryTag name '"
                 + name
                 + "', value '"
                 + value
                 + "': missing map. Specify parent MapTag, "
                 + "or mapName attribute.");
         }
 
         // evaluate the body - there may be something interesting there
         return EVAL_BODY_BUFFERED;
     }
 
     /***
      * <p>If the <code>mapEntry</code> is not inside a <code>map</code>
      * tag, use this attribute to specify a <code>java.util.Map</code>
      * instance in the current page context.</p>
      *
      * @return the current value of mapName.
      */
     public final String getMapName() {
         return mapName;
     }
 
     /***
      * <p>Specifies the name of the entry to put in the parent map.</p>
      *
      * @return the current value of name.
      */
     public final String getName() {
         return name;
     }
 
     /***
      * <p>Specifies the value of the entry to put in the parent map.</p>
      *
      * @return the current value of value.
      */
     public final String getValue() {
         return value;
     }
 
     /***
      * <p>If the <code>mapEntry</code> is not inside a <code>map</code>
      * tag, use this attribute to specify a <code>java.util.Map</code>
      * instance in the current page context.</p>
      *
      * @param mapNameParam the new value of mapName.
      */
     public final void setMapName(final String mapNameParam) {
         this.mapName = mapNameParam;
     }
 
     /***
      * <p>Specifies the name of the entry to put in the parent map.</p>
      *
      * @param nameParam the new value of name.
      */
     public final void setName(final String nameParam) {
         this.name = nameParam;
     }
 
     /***
      * <p>Specifies the value of the entry to put in the parent map.</p>
      *
      * @param valueParam the new value of value.
      */
     public final void setValue(final String valueParam) {
         this.value = valueParam;
     }
 }
 /*
 MapEntryTag.setValue(Object){
         this.value = value;
     }
 
 */