Java Doc for IntakeTool.java in  » Web-Framework » TURBINE » org » apache » turbine » services » intake » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation 1.  6.0 JDK Core 2.  6.0 JDK Modules 3.  6.0 JDK Modules com.sun 4.  6.0 JDK Modules com.sun.java 5.  6.0 JDK Modules sun 6.  6.0 JDK Platform 7.  Ajax 8.  Apache Harmony Java SE 9.  Aspect oriented 10.  Authentication Authorization 11.  Blogger System 12.  Build 13.  Byte Code 14.  Cache 15.  Chart 16.  Chat 17.  Code Analyzer 18.  Collaboration 19.  Content Management System 20.  Database Client 21.  Database DBMS 22.  Database JDBC Connection Pool 23.  Database ORM 24.  Development 25.  EJB Server geronimo 26.  EJB Server GlassFish 27.  EJB Server JBoss 4.2.1 28.  EJB Server resin 3.1.5 29.  ERP CRM Financial 30.  ESB 31.  Forum 32.  GIS 33.  Graphic Library 34.  Groupware 35.  HTML Parser 36.  IDE 37.  IDE Eclipse 38.  IDE Netbeans 39.  Installer 40.  Internationalization Localization 41.  Inversion of Control 42.  Issue Tracking 43.  J2EE 44.  JBoss 45.  JMS 46.  JMX 47.  Library 48.  Mail Clients 49.  Net 50.  Parser 51.  PDF 52.  Portal 53.  Profiler 54.  Project Management 55.  Report 56.  RSS RDF 57.  Rule Engine 58.  Science 59.  Scripting 60.  Search Engine 61.  Security 62.  Sevlet Container 63.  Source Control 64.  Swing Library 65.  Template Engine 66.  Test Coverage 67.  Testing 68.  UML 69.  Web Crawler 70.  Web Framework 71.  Web Mail 72.  Web Server 73.  Web Services 74.  Web Services apache cxf 2.0.1 75.  Web Services AXIS2 76.  Wiki Engine 77.  Workflow Engines 78.  XML 79.  XML UI Java Java Tutorial Java Open Source Jar File Download Java Articles Java Products Java by API Photoshop Tutorials Maya Tutorials Flash Tutorials 3ds-Max Tutorials Illustrator Tutorials GIMP Tutorials C# / C Sharp C# / CSharp Tutorial C# / CSharp Open Source ASP.Net ASP.NET Tutorial JavaScript DHTML JavaScript Tutorial JavaScript Reference HTML / CSS HTML CSS Reference C / ANSI-C C Tutorial C++ C++ Tutorial Ruby PHP Python Python Tutorial Python Open Source SQL Server / T-SQL SQL Server / T-SQL Tutorial Oracle PL / SQL Oracle PL/SQL Tutorial PostgreSQL SQL / MySQL MySQL Tutorial VB.Net VB.Net Tutorial Flash / Flex / ActionScript VBA / Excel / Access / Word XML XML Tutorial Microsoft Office PowerPoint 2007 Tutorial Microsoft Office Excel 2007 Tutorial Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Web Framework » TURBINE » org.apache.turbine.services.intake   Source Cross Reference   Class Diagram   Java Document (Java Doc)   java.lang.Object    org.apache.turbine.services.intake.IntakeTool IntakeTool public class IntakeTool implements ApplicationTool,Recyclable(Code) The main class through which Intake is accessed. author:    John D. McNally author:    Henning P. Schmiedehausen author:    Quinton McCombs version:    $Id: IntakeTool.java 534527 2007-05-02 16:10:59Z tv $ Inner Class :public class PullHelper Field Summary final public static  String DEFAULT_KEY      final public static  String INTAKE_GRP       StringBuffer allGroupsSB       HashMap declaredGroups       StringBuffer groupSB      Constructor Summary public   IntakeTool()      Method Summary public  void addGroupsToParameters(ValueParser vp)      public  String declareGroup(Group group)      A convenience method to write out the hidden form fields that notify intake of the group. public  void declareGroup(Group group, StringBuffer sb)      xhtml valid hidden input field(s) that notifies intake of the group's presence. public  String declareGroups()      A convenience method to write out the hidden form fields that notify intake of the relevant groups. public  void dispose()      Disposes the object after use. public  PullHelper get(String groupName)      public  PullHelper get(String groupName, boolean throwExceptions)      public  Group get(String groupName, String key)      Get a specific group by name and key. public  Group get(String groupName, String key, boolean create)      Get a specific group by name and key. public  Map getGroups()      Get a Map containing all the groups. public  void init(Object runData)      public  boolean isAllValid()      Loops through all of the Groups and checks to see if the data within the Group is valid. public  boolean isDisposed()      Checks whether the recyclable has been disposed. public  void newForm()      public  void recycle()      Recycles the object for a new client. public  void refresh()      public  void remove(Group group)      Removes group. public  void removeAll()      Removes all groups. Field Detail DEFAULT_KEY final public static String DEFAULT_KEY(Code) Constant for default key INTAKE_GRP final public static String INTAKE_GRP(Code) Constant for the hidden fieldname allGroupsSB StringBuffer allGroupsSB(Code) declaredGroups HashMap declaredGroups(Code) groupSB StringBuffer groupSB(Code) Constructor Detail IntakeTool public IntakeTool()(Code) Constructor Method Detail addGroupsToParameters public void addGroupsToParameters(ValueParser vp)(Code) declareGroup public String declareGroup(Group group)(Code) A convenience method to write out the hidden form fields that notify intake of the group. declareGroup public void declareGroup(Group group, StringBuffer sb)(Code) xhtml valid hidden input field(s) that notifies intake of the group's presence. declareGroups public String declareGroups()(Code) 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. dispose public void dispose()(Code) Disposes the object after use. The method is called when the object is returned to its pool. The dispose method must call its super. get public PullHelper get(String groupName) throws IntakeException(Code) get a specific group get public PullHelper get(String groupName, boolean throwExceptions) throws IntakeException(Code) Get a specific group Parameters:   throwExceptions - if false, exceptions will be supressed. throws:   IntakeException - could not retrieve group get public Group get(String groupName, String key) throws IntakeException(Code) Get a specific group by name and key. get public Group get(String groupName, String key, boolean create) throws IntakeException(Code) Get a specific group by name and key. Also specify whether or not you want to create a new group. getGroups public Map getGroups()(Code) Get a Map containing all the groups. the Group Map init public void init(Object runData)(Code) Prepares intake for a single request isAllValid public boolean isAllValid()(Code) Loops through all of the Groups and checks to see if the data within the Group is valid. isDisposed public boolean isDisposed()(Code) Checks whether the recyclable has been disposed. true, if the recyclable is disposed. newForm public void newForm()(Code) recycle public void recycle()(Code) 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. refresh public void refresh()(Code) Implementation of ApplicationTool interface is not needed for this tool as it is request scoped remove public void remove(Group group)(Code) 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). removeAll public void removeAll()(Code) 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). Methods inherited from java.lang.Object native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc) public boolean equals(Object obj)(Code)(Java Doc) protected void finalize() throws Throwable(Code)(Java Doc) final native public Class getClass()(Code)(Java Doc) native public int hashCode()(Code)(Java Doc) final native public void notify()(Code)(Java Doc) final native public void notifyAll()(Code)(Java Doc) public String toString()(Code)(Java Doc) final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc) final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc) final public void wait() throws InterruptedException(Code)(Java Doc)