Java Doc for BeanHandler.java in  » Web-Framework » rife-1.6.1 » com » uwyn » rife » template » 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 » rife 1.6.1 » com.uwyn.rife.template 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


com.uwyn.rife.template.BeanHandler

All known Subclasses:   com.uwyn.rife.template.AbstractBeanHandler,
BeanHandler
public interface BeanHandler (Code)
Handles the process of setting values in a template based on a Java bean instance.
author:
   Keith Lea <keith[remove] at cs dot oswego dot edu>
author:
   Geert Bevin (gbevin[remove] at uwyn dot com)
version:
   $Revision: 3634 $
since:
   1.0




Method Summary
public  FormBuildergetFormBuilder()
     Returns a form builder which will be used to in the corresponding template.
public  voidremoveBean(Template template, Object bean, String prefix)
     Reverts all values to their defaults when the identifiers match properties of the given bean preceded by the given prefix, whether or not those values were set with a previous call to Template.setBean(Object) .
public  voidsetBean(Template template, Object bean, String prefix, boolean encode)
     Sets all values in the given template whose names match names of properties in the given bean, preceded by the given prefix, if present. If the given prefix is null, it is ignored.

For example, given a class:

class Person {
 private String first;
 private String last;
 public String getFirstName() { return first; }
 public void setFirstName(String name) { this.first = name; }
 public String getLastName() { return last; }
 public void setLastName(String name) { this.last = name; }
 }

And given a template:

Hello <!--V 'NAME:firstName'/--> <!--V 'NAME:lastName'/-->.

Calling this method with an instance of Person where first was "Jim" and last was "James", and the prefix "NAME:", would produce:

Hello Jim James.

Calling this method is equivalent to calling Template.setValue(StringString) setValue individually for each property of the bean prefixed with the given prefix.

If encode is true, this method will use the template's to encode the bean properties before setting the values.

Only bean properties will be considered for insertion in the template.




Method Detail
getFormBuilder
public FormBuilder getFormBuilder()(Code)
Returns a form builder which will be used to in the corresponding template. a form builder for use with the corresponding template
since:
   1.0



removeBean
public void removeBean(Template template, Object bean, String prefix) throws TemplateException(Code)
Reverts all values to their defaults when the identifiers match properties of the given bean preceded by the given prefix, whether or not those values were set with a previous call to Template.setBean(Object) . The values of the bean's properties are ignored.

Calling this method is equivalent to calling Template.removeValue once for the name of each property of the given bean, prefixed with the given prefix.
Parameters:
  bean - a bean whose property names will be used to determinewhether
Parameters:
  prefix - a prefix
exception:
  TemplateException - if this template has no bean handlingcapability; or

an error occurred during the introspection of the bean
since:
   1.0




setBean
public void setBean(Template template, Object bean, String prefix, boolean encode) throws TemplateException(Code)
Sets all values in the given template whose names match names of properties in the given bean, preceded by the given prefix, if present. If the given prefix is null, it is ignored.

For example, given a class:

class Person {
 private String first;
 private String last;
 public String getFirstName() { return first; }
 public void setFirstName(String name) { this.first = name; }
 public String getLastName() { return last; }
 public void setLastName(String name) { this.last = name; }
 }

And given a template:

Hello <!--V 'NAME:firstName'/--> <!--V 'NAME:lastName'/-->.

Calling this method with an instance of Person where first was "Jim" and last was "James", and the prefix "NAME:", would produce:

Hello Jim James.

Calling this method is equivalent to calling Template.setValue(StringString) setValue individually for each property of the bean prefixed with the given prefix.

If encode is true, this method will use the template's to encode the bean properties before setting the values.

Only bean properties will be considered for insertion in the template. This means only properties with a getter and a setter will be considered.
Parameters:
  template - the template whose values will be filled
Parameters:
  bean - a bean whose properties will be used to fill in values inthe template
Parameters:
  prefix - the prefix of values which will be filled with the givenbean's property values
exception:
  TemplateException - if this template has no bean handlingcapability; or

an error occurred during the introspection of the bean
since:
   1.0




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