| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc on Fri Jun 15 16:53:35 PDT 2001 --> |
| <TITLE> |
| Apache Struts API Documentation: Class CallParamRule |
| </TITLE> |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| </HEAD> |
| <BODY BGCOLOR="white"> |
| |
| <!-- ========== START OF NAVBAR ========== --> |
| <A NAME="navbar_top"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/struts/digester/CallMethodRule.html"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/struts/digester/Digester.html"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> |
| <A HREF="CallParamRule.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <!-- =========== END OF NAVBAR =========== --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.struts.digester</FONT> |
| <BR> |
| Class CallParamRule</H2> |
| <PRE> |
| java.lang.Object |
| | |
| +--<A HREF="../../../../org/apache/struts/digester/Rule.html">org.apache.struts.digester.Rule</A> |
| | |
| +--<B>org.apache.struts.digester.CallParamRule</B> |
| </PRE> |
| <HR> |
| <DL> |
| <DT>public class <B>CallParamRule</B><DT>extends <A HREF="../../../../org/apache/struts/digester/Rule.html">Rule</A></DL> |
| |
| <P> |
| Rule implementation that saves a parameter from either an attribute of |
| this element, or from the element body, to be used in a call generated |
| by a surrounding CallMethodRule rule. |
| <P> |
| <DL> |
| <DT><B>Version: </B><DD>$Revision: 1.1 $ $Date$</DD> |
| <DT><B>Author: </B><DD>Craig McClanahan</DD> |
| </DL> |
| <HR> |
| |
| <P> |
| <!-- ======== INNER CLASS SUMMARY ======== --> |
| |
| |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/digester/CallParamRule.html#attributeName">attributeName</A></B></CODE> |
| |
| <BR> |
| The attribute from which to save the parameter value</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/digester/CallParamRule.html#bodyText">bodyText</A></B></CODE> |
| |
| <BR> |
| The body text collected from this element.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/digester/CallParamRule.html#paramIndex">paramIndex</A></B></CODE> |
| |
| <BR> |
| The zero-relative index of the parameter we are saving.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.apache.struts.digester.Rule"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Fields inherited from class org.apache.struts.digester.<A HREF="../../../../org/apache/struts/digester/Rule.html">Rule</A></B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/struts/digester/Rule.html#digester">digester</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Constructor Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/digester/CallParamRule.html#CallParamRule(org.apache.struts.digester.Digester, int)">CallParamRule</A></B>(<A HREF="../../../../org/apache/struts/digester/Digester.html">Digester</A> digester, |
| int paramIndex)</CODE> |
| |
| <BR> |
| Construct a "call parameter" rule that will save the body text of this |
| element as the parameter value.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/digester/CallParamRule.html#CallParamRule(org.apache.struts.digester.Digester, int, java.lang.String)">CallParamRule</A></B>(<A HREF="../../../../org/apache/struts/digester/Digester.html">Digester</A> digester, |
| int paramIndex, |
| java.lang.String attributeName)</CODE> |
| |
| <BR> |
| Construct a "call parameter" rule that will save the value of the |
| specified attribute as the parameter value.</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/digester/CallParamRule.html#begin(org.xml.sax.AttributeList)">begin</A></B>(org.xml.sax.AttributeList attributes)</CODE> |
| |
| <BR> |
| Process the start of this element.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/digester/CallParamRule.html#body(java.lang.String)">body</A></B>(java.lang.String bodyText)</CODE> |
| |
| <BR> |
| Process the body text of this element.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/digester/CallParamRule.html#end()">end</A></B>()</CODE> |
| |
| <BR> |
| Process the end of this element.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/digester/CallParamRule.html#finish()">finish</A></B>()</CODE> |
| |
| <BR> |
| Clean up after parsing is complete.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Methods inherited from class java.lang.Object</B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><clinit>, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait</CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Field Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="attributeName"><!-- --></A><H3> |
| attributeName</H3> |
| <PRE> |
| protected java.lang.String <B>attributeName</B></PRE> |
| <DL> |
| <DD>The attribute from which to save the parameter value</DL> |
| <HR> |
| |
| <A NAME="bodyText"><!-- --></A><H3> |
| bodyText</H3> |
| <PRE> |
| protected java.lang.String <B>bodyText</B></PRE> |
| <DL> |
| <DD>The body text collected from this element.</DL> |
| <HR> |
| |
| <A NAME="paramIndex"><!-- --></A><H3> |
| paramIndex</H3> |
| <PRE> |
| protected int <B>paramIndex</B></PRE> |
| <DL> |
| <DD>The zero-relative index of the parameter we are saving.</DL> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="CallParamRule(org.apache.struts.digester.Digester, int)"><!-- --></A><H3> |
| CallParamRule</H3> |
| <PRE> |
| public <B>CallParamRule</B>(<A HREF="../../../../org/apache/struts/digester/Digester.html">Digester</A> digester, |
| int paramIndex)</PRE> |
| <DL> |
| <DD>Construct a "call parameter" rule that will save the body text of this |
| element as the parameter value.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>digester</CODE> - The associated Digester<DD><CODE>paramIndex</CODE> - The zero-relative parameter number</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="CallParamRule(org.apache.struts.digester.Digester, int, java.lang.String)"><!-- --></A><H3> |
| CallParamRule</H3> |
| <PRE> |
| public <B>CallParamRule</B>(<A HREF="../../../../org/apache/struts/digester/Digester.html">Digester</A> digester, |
| int paramIndex, |
| java.lang.String attributeName)</PRE> |
| <DL> |
| <DD>Construct a "call parameter" rule that will save the value of the |
| specified attribute as the parameter value.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>digester</CODE> - The associated Digester<DD><CODE>paramIndex</CODE> - The zero-relative parameter number<DD><CODE>attributeName</CODE> - The name of the attribute to save</DL> |
| </DD> |
| </DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="begin(org.xml.sax.AttributeList)"><!-- --></A><H3> |
| begin</H3> |
| <PRE> |
| public void <B>begin</B>(org.xml.sax.AttributeList attributes) |
| throws java.lang.Exception</PRE> |
| <DL> |
| <DD>Process the start of this element.<DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/struts/digester/Rule.html#begin(org.xml.sax.AttributeList)">begin</A></CODE> in class <CODE><A HREF="../../../../org/apache/struts/digester/Rule.html">Rule</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>attributes</CODE> - The attribute list for this element</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="body(java.lang.String)"><!-- --></A><H3> |
| body</H3> |
| <PRE> |
| public void <B>body</B>(java.lang.String bodyText) |
| throws java.lang.Exception</PRE> |
| <DL> |
| <DD>Process the body text of this element.<DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/struts/digester/Rule.html#body(java.lang.String)">body</A></CODE> in class <CODE><A HREF="../../../../org/apache/struts/digester/Rule.html">Rule</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>bodyText</CODE> - The body text of this element</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="end()"><!-- --></A><H3> |
| end</H3> |
| <PRE> |
| public void <B>end</B>() |
| throws java.lang.Exception</PRE> |
| <DL> |
| <DD>Process the end of this element.<DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/struts/digester/Rule.html#end()">end</A></CODE> in class <CODE><A HREF="../../../../org/apache/struts/digester/Rule.html">Rule</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="finish()"><!-- --></A><H3> |
| finish</H3> |
| <PRE> |
| public void <B>finish</B>() |
| throws java.lang.Exception</PRE> |
| <DL> |
| <DD>Clean up after parsing is complete.<DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/struts/digester/Rule.html#finish()">finish</A></CODE> in class <CODE><A HREF="../../../../org/apache/struts/digester/Rule.html">Rule</A></CODE></DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| <!-- ========== START OF NAVBAR ========== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/struts/digester/CallMethodRule.html"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/struts/digester/Digester.html"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> |
| <A HREF="CallParamRule.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <!-- =========== END OF NAVBAR =========== --> |
| |
| <HR> |
| Copyright © 2000-2001 - Apache Software Foundation |
| </BODY> |
| </HTML> |