Java Doc for Group.java in  » Web-Framework » TURBINE » org » apache » turbine » services » intake » model » 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.model 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.turbine.services.intake.model.Group

Group
public class Group (Code)
Holds a group of Fields
author:
   John McNally
author:
   Henning P. Schmiedehausen
author:
   Quinton McCombs
author:
   Jürgen Hoffmann
version:
   $Id: Group.java 538811 2007-05-17 05:55:42Z seade $

Inner Class :public static class GroupFactory extends BaseKeyedPoolableObjectFactory

Field Summary
final public static  StringEMPTY
    
final public static  StringNEW
    
protected  Mapfields
     A map of the fields in this group mapped by field name.
protected  Field[]fieldsArray
     An array of fields in this group.
final protected  Stringgid
     The key used to represent this group in a parameter.
protected  booleanisDeclared
     A flag to help prevent duplicate hidden fields declaring this group.
protected  MapmapToObjectFields
    
final protected  Stringname
     The name used in templates and java code to refer to this group.
protected  Stringoid
    
protected  ValueParserpp
    

Constructor Summary
public  Group(XmlGroup group)
     Constructs a new Group based on the xml specification.

Method Summary
public  voidappendHtmlFormInput(StringBuffer sb)
     A xhtml valid hidden input field that notifies intake of the group's presence.
public  Fieldget(String fieldName)
     Get the Field .
public  String[]getFieldNames()
     Gets a list of the names of the fields stored in this object.
public  StringgetGID()
     Get the part of the key used to specify the group.
public  StringgetHtmlFormInput()
     A xhtml valid hidden input field that notifies intake of the group's presence.
public  StringgetIntakeGroupName()
     Return the name given to this group.
public  StringgetOID()
     Get the part of the key that distinguishes a group from others of the same name.
public  StringgetObjectKey()
     Concatenation of gid and oid.
public  ArrayListgetObjects(ValueParser pp)
     Describe getObjects method here.
public  intgetPoolCapacity()
     Get the number of Group objects that will be pooled.
public  voidgetProperties(Object obj)
     Calls getter methods on objects that are known to Intake so that field values in forms can be initialized from the values contained in the intake tool.
public  Groupinit(ValueParser pp)
     Initializes the default Group using parameters.
public  Groupinit(String key, ValueParser pp)
     Initializes the Group with parameters from RunData corresponding to key.
public  Groupinit(Retrievable obj)
     Initializes the group with properties from an object.
public  booleanisAllValid()
     Performs an AND between all the fields in this group.
public  voidremoveFromRequest()
    
public  voidresetDeclared()
     To be used in the event this group is used within multiple forms within the same template.
public  voidsetProperties(Object obj)
     Calls a setter methods on obj, for fields which have been set.
public  voidsetValidProperties(Object obj)
     Calls a setter methods on obj, for fields which pass validity tests. In most cases one should call Intake.isAllValid() and then if that test passes call setProperties.

Field Detail
EMPTY
final public static String EMPTY(Code)



NEW
final public static String NEW(Code)



fields
protected Map fields(Code)
A map of the fields in this group mapped by field name.



fieldsArray
protected Field[] fieldsArray(Code)
An array of fields in this group.



gid
final protected String gid(Code)
The key used to represent this group in a parameter. This key is usually a prefix as part of a field key.



isDeclared
protected boolean isDeclared(Code)
A flag to help prevent duplicate hidden fields declaring this group.



mapToObjectFields
protected Map mapToObjectFields(Code)
Map of the fields by mapToObject



name
final protected String name(Code)
The name used in templates and java code to refer to this group.



oid
protected String oid(Code)
The object id used to associate this group to a bean for one request cycle



pp
protected ValueParser pp(Code)
The object containing the request data




Constructor Detail
Group
public Group(XmlGroup group) throws IntakeException(Code)
Constructs a new Group based on the xml specification. Groups are instantiated and pooled by the IntakeService and should not be instantiated otherwise.
Parameters:
  group - a XmlGroup value
exception:
  IntakeException - if an error occurs in other classes




Method Detail
appendHtmlFormInput
public void appendHtmlFormInput(StringBuffer sb)(Code)
A xhtml valid hidden input field that notifies intake of the group's presence.



get
public Field get(String fieldName) throws IntakeException(Code)
Get the Field . Field.
throws:
  IntakeException - indicates the field could not be found.



getFieldNames
public String[] getFieldNames()(Code)
Gets a list of the names of the fields stored in this object. A String array containing the list of names.



getGID
public String getGID()(Code)
Get the part of the key used to specify the group. This is specified in the key attribute in the xml file. a String value



getHtmlFormInput
public String getHtmlFormInput()(Code)
A xhtml valid hidden input field that notifies intake of the group's presence. a String value



getIntakeGroupName
public String getIntakeGroupName()(Code)
Return the name given to this group. The long name is to avoid conflicts with the get(String key) method. a String value



getOID
public String getOID()(Code)
Get the part of the key that distinguishes a group from others of the same name. a String value



getObjectKey
public String getObjectKey()(Code)
Concatenation of gid and oid. a String value



getObjects
public ArrayList getObjects(ValueParser pp) throws IntakeException(Code)
Describe getObjects method here.
Parameters:
  pp - a ValueParser value an ArrayList value
exception:
  IntakeException - if an error occurs



getPoolCapacity
public int getPoolCapacity()(Code)
Get the number of Group objects that will be pooled. an int value



getProperties
public void getProperties(Object obj) throws IntakeException(Code)
Calls getter methods on objects that are known to Intake so that field values in forms can be initialized from the values contained in the intake tool.
Parameters:
  obj - Object that will be used to as a source of data forsetting the values of the fields within the group.
throws:
  IntakeException - indicates that a failure occurred whileexecuting the setter methods of the mapped object.



init
public Group init(ValueParser pp) throws TurbineException(Code)
Initializes the default Group using parameters.
Parameters:
  pp - a ValueParser value this Group



init
public Group init(String key, ValueParser pp) throws IntakeException(Code)
Initializes the Group with parameters from RunData corresponding to key.
Parameters:
  pp - a ValueParser value this Group



init
public Group init(Retrievable obj)(Code)
Initializes the group with properties from an object.
Parameters:
  obj - a Persistent value a Group value



isAllValid
public boolean isAllValid()(Code)
Performs an AND between all the fields in this group. a boolean value



removeFromRequest
public void removeFromRequest()(Code)
Removes references to this group and its fields from the query parameters



resetDeclared
public void resetDeclared()(Code)
To be used in the event this group is used within multiple forms within the same template.



setProperties
public void setProperties(Object obj) throws IntakeException(Code)
Calls a setter methods on obj, for fields which have been set.
Parameters:
  obj - Object to be set with the values from the group.
throws:
  IntakeException - indicates that a failure occurred whileexecuting the setter methods of the mapped object.



setValidProperties
public void setValidProperties(Object obj)(Code)
Calls a setter methods on obj, for fields which pass validity tests. In most cases one should call Intake.isAllValid() and then if that test passes call setProperties. Use this method when some data is known to be invalid, but you still want to set the object properties that are valid.



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)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.