com.ivata.mask.web.tag.util
Class MapTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      javax.servlet.jsp.tagext.BodyTagSupport
          com.ivata.mask.web.tag.util.MapTag

All Implemented Interfaces:

javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, java.io.Serializable, javax.servlet.jsp.tagext.Tag

public class MapTag

extends javax.servlet.jsp.tagext.BodyTagSupport

This tag defines a Map in page scope and assigns the entries to it defined by MapEntryTag instance within the tag body.

Tag attributes:

attribute	reqd.	param. class	description
id	true	String	Specifies the name of the scripting variable and associated page scope attribute which will be made available.

Since:

ivata masks 0.5 (2002-01-23)

Version:

$Revision: 1.2 $

Author:

Colin MacLeod colin.macleod@ivata.com

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport

bodyContent

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

pageContext

Fields inherited from interface javax.servlet.jsp.tagext.BodyTag

EVAL_BODY_BUFFERED, EVAL_BODY_TAG

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

MapTag()

Method Summary

int	doStartTag() This method is called when the JSP engine encounters the start tag, after the attributes are processed.
java.lang.String	getId() Specifies the name of the scripting variable and associated page scope attribute which will be made available.
java.util.HashMap	getMap() This internal implementaion actually does all the work :-).
void	setId(java.lang.String idParam) Specifies the name of the scripting variable and associated page scope attribute which will be made available.
void	setMap(java.util.HashMap mapParam) This internal implementaion actually does all the work :-).

Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport

doAfterBody, doEndTag, doInitBody, getBodyContent, getPreviousOut, release, setBodyContent

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

findAncestorWithClass, getParent, getValue, getValues, removeValue, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.servlet.jsp.tagext.Tag

getParent, setPageContext, setParent

Constructor Detail

MapTag

public MapTag()

Method Detail

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException

This method is called when the JSP engine encounters the start tag, after the attributes are processed.

Scripting variables (if any) have their values set here.

Returns:

EVAL_BODY_BUFFERED since we always want to evaluate the tag body once.

Throws:

javax.servlet.jsp.JspException - if there is a NamingExcpetion getting the InitialContext

javax.servlet.jsp.JspException - encapsulates any exception when calling out.println

getId

public final java.lang.String getId()

Specifies the name of the scripting variable and associated page scope attribute which will be made available.

Returns:

the current value of id.

setId

public final void setId(java.lang.String idParam)

Specifies the name of the scripting variable and associated page scope attribute which will be made available.

Parameters:

idParam - the new value of id.

getMap

public final java.util.HashMap getMap()

This internal implementaion actually does all the work :-).

Returns:

the current value of map.

setMap

public final void setMap(java.util.HashMap mapParam)

This internal implementaion actually does all the work :-).

Parameters:

mapParam - the new value of map.