intaketool.html

turbine教程

</TR>
</TABLE>

<A NAME="DEFAULT_KEY"><!-- --></A><H3>
DEFAULT_KEY</H3>
<PRE>
public static final java.lang.String <B>DEFAULT_KEY</B></PRE>
<DL>
</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="IntakeTool()"><!-- --></A><H3>
IntakeTool</H3>
<PRE>
public <B>IntakeTool</B>()</PRE>
<DL>
</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="init(java.lang.Object)"><!-- --></A><H3>
init</H3>
<PRE>
public void <B>init</B>(java.lang.Object&nbsp;runData)</PRE>
<DL>
<DD>Prepares intake for a single request<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../../org/apache/turbine/services/pull/ApplicationTool.html#init(java.lang.Object)">init</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/turbine/services/pull/ApplicationTool.html">ApplicationTool</A></CODE></DL>
</DD>
<DD>Following copied from interface: <CODE>org.apache.turbine.services.pull.ApplicationTool</CODE></DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>data</CODE> - initialization data</DL>
</DD>
</DL>
<HR>

<A NAME="declareGroups()"><!-- --></A><H3>
declareGroups</H3>
<PRE>
public java.lang.String <B>declareGroups</B>()</PRE>
<DL>
<DD>A convenience method to write out the hidden form fields
 that notify intake of the relevant groups.  It should be used
 only in templates with 1 form.  In multiform templates, the groups
 that are relevant for each form need to be declared using
 $intake.newForm() and $intake.declareGroup($group) for the relevant
 groups in the form.<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="declareGroup(org.apache.turbine.services.intake.model.Group)"><!-- --></A><H3>
declareGroup</H3>
<PRE>
public java.lang.String <B>declareGroup</B>(<A HREF="../../../../../org/apache/turbine/services/intake/model/Group.html">Group</A>&nbsp;group)</PRE>
<DL>
<DD>A convenience method to write out the hidden form fields
 that notify intake of the group.<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="declareGroup(org.apache.turbine.services.intake.model.Group, java.lang.StringBuffer)"><!-- --></A><H3>
declareGroup</H3>
<PRE>
public void <B>declareGroup</B>(<A HREF="../../../../../org/apache/turbine/services/intake/model/Group.html">Group</A>&nbsp;group,
                         java.lang.StringBuffer&nbsp;sb)</PRE>
<DL>
<DD>xhtml valid hidden input field(s) that notifies intake of the
 group's presence.<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="newForm()"><!-- --></A><H3>
newForm</H3>
<PRE>
public void <B>newForm</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="refresh()"><!-- --></A><H3>
refresh</H3>
<PRE>
public void <B>refresh</B>()</PRE>
<DL>
<DD>Implementation of ApplicationTool interface is not needed for this
 tool as it is request scoped<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../../org/apache/turbine/services/pull/ApplicationTool.html#refresh()">refresh</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/turbine/services/pull/ApplicationTool.html">ApplicationTool</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="get(java.lang.String)"><!-- --></A><H3>
get</H3>
<PRE>
public java.lang.Object <B>get</B>(java.lang.String&nbsp;groupName)
                     throws java.lang.Exception</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isAllValid()"><!-- --></A><H3>
isAllValid</H3>
<PRE>
public boolean <B>isAllValid</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="get(java.lang.String, java.lang.String)"><!-- --></A><H3>
get</H3>
<PRE>
public <A HREF="../../../../../org/apache/turbine/services/intake/model/Group.html">Group</A> <B>get</B>(java.lang.String&nbsp;groupName,
                 java.lang.String&nbsp;key)
          throws java.lang.Exception</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="get(java.lang.String, java.lang.String, boolean)"><!-- --></A><H3>
get</H3>
<PRE>
public <A HREF="../../../../../org/apache/turbine/services/intake/model/Group.html">Group</A> <B>get</B>(java.lang.String&nbsp;groupName,
                 java.lang.String&nbsp;key,
                 boolean&nbsp;create)
          throws java.lang.Exception</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="remove(org.apache.turbine.services.intake.model.Group)"><!-- --></A><H3>
remove</H3>
<PRE>
public void <B>remove</B>(<A HREF="../../../../../org/apache/turbine/services/intake/model/Group.html">Group</A>&nbsp;group)</PRE>
<DL>
<DD>Removes group.  Primary use is to remove a group that has
 been processed by an action and is no longer appropriate
 in the view (screen).<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="removeAll()"><!-- --></A><H3>
removeAll</H3>
<PRE>
public void <B>removeAll</B>()</PRE>
<DL>
<DD>Removes all groups.  Primary use is to remove groups that have
 been processed by an action and are no longer appropriate
 in the view (screen).<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getGroups()"><!-- --></A><H3>
getGroups</H3>
<PRE>
public java.util.Map <B>getGroups</B>()</PRE>
<DL>
<DD>Get a Map containing all the groups.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the Group Map</DL>
</DD>
</DL>
<HR>

<A NAME="recycle()"><!-- --></A><H3>
recycle</H3>
<PRE>
public void <B>recycle</B>()</PRE>
<DL>
<DD>Recycles the object for a new client. Recycle methods with
 parameters must be added to implementing object and they will be
 automatically called by pool implementations when the object is
 taken from the pool for a new client. The parameters must
 correspond to the parameters of the constructors of the object.
 For new objects, constructors can call their corresponding recycle
 methods whenever applicable.
 The recycle methods must call their super.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../../org/apache/turbine/util/pool/Recyclable.html#recycle()">recycle</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/turbine/util/pool/Recyclable.html">Recyclable</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="dispose()"><!-- --></A><H3>
dispose</H3>
<PRE>
public void <B>dispose</B>()</PRE>
<DL>
<DD>Disposes the object after use. The method is called
 when the object is returned to its pool.
 The dispose method must call its super.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../../org/apache/turbine/util/pool/Recyclable.html#dispose()">dispose</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/turbine/util/pool/Recyclable.html">Recyclable</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="isDisposed()"><!-- --></A><H3>
isDisposed</H3>
<PRE>
public boolean <B>isDisposed</B>()</PRE>
<DL>
<DD>Checks whether the recyclable has been disposed.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../../org/apache/turbine/util/pool/Recyclable.html#isDisposed()">isDisposed</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/turbine/util/pool/Recyclable.html">Recyclable</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true, if the recyclable is disposed.</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>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/IntakeTool.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../../../org/apache/turbine/services/intake/IntakeTool.PullHelper.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>  &nbsp;
&nbsp;<A HREF="IntakeTool.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY: &nbsp;<A HREF="#inner_class_summary">INNER</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: &nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->

<HR>
Copyright &copy; 2000-2002 Apache Software Foundation. All Rights Reserved.
</BODY>
</HTML>