Java Doc for XSLTResult.java in  » Web-Framework » struts-2.0.11 » org » apache » struts2 » views » xslt » 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 » struts 2.0.11 » org.apache.struts2.views.xslt 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.struts2.views.xslt.XSLTResult

XSLTResult
public class XSLTResult implements Result(Code)
XSLTResult uses XSLT to transform action object to XML. Recent version has been specifically modified to deal with Xalan flaws. When using Xalan you may notice that even though you have very minimal stylesheet like this one
 <xsl:template match="/result">
 <result />
 </xsl:template>

then Xalan would still iterate through every property of your action and it's all descendants.

If you had double-linked objects then Xalan would work forever analysing infinite object tree. Even if your stylesheet was not constructed to process them all. It's becouse current Xalan eagerly and extensively converts everything to it's internal DTM model before further processing.

Thet's why there's a loop eliminator added that works by indexing every object-property combination during processing. If it notices that some object's property were already walked through, it doesn't get any deeper. Say, you have two objects x and y with the following properties set (pseudocode):

 x.y = y;
 and
 y.x = x;
 action.x=x;

Due to that modification the resulting XML document based on x would be:

 <result>
 <x>
 <y/>
 </x>
 </result>

Without it there would be endless x/y/x/y/x/y/... elements.

The XSLTResult code tries also to deal with the fact that DTM model is built in a manner that childs are processed before siblings. The result is that if there is object x that is both set in action's x property, and very deeply under action's a property then it would only appear under a, not under x. That's not what we expect, and that's why XSLTResult allows objects to repeat in various places to some extent.

Sometimes the object mesh is still very dense and you may notice that even though you have relatively simple stylesheet execution takes a tremendous amount of time. To help you to deal with that obstacle of Xalan you may attach regexp filters to elements paths (xpath).

Note: In your .xsl file the root match must be named result.
This example will output the username by using getUsername on your action class:

 <xsl:template match="result">
 <html>
 <body>
 Hello <xsl:value-of select="username"/> how are you?
 </body>
 <html>
 <xsl:template/>
 

In the following example the XSLT result would only walk through action's properties without their childs. It would also skip every property that has "hugeCollection" in their name. Element's path is first compared to excludingPattern - if it matches it's no longer processed. Then it is compared to matchingPattern and processed only if there's a match.


 <result name="success" type="xslt">
 <param name="location">foo.xslt</param>
 <param name="matchingPattern">^/result/[^/*]$</param>
 <param name="excludingPattern">.*(hugeCollection).*</param>
 </result>
 

In the following example the XSLT result would use the action's user property instead of the action as it's base document and walk through it's properties. The exposedValue uses an ognl expression to derive it's value.

 <result name="success" type="xslt">
 <param name="location">foo.xslt</param>
 <param name="exposedValue">user$</param>
 </result>
 
This result type takes the following parameters:
  • location (default) - the location to go to after execution.
  • parse - true by default. If set to false, the location param will not be parsed for Ognl expressions.
  • matchingPattern - Pattern that matches only desired elements, by default it matches everything.
  • excludingPattern - Pattern that eliminates unwanted elements, by default it matches none.

struts.properties related configuration:

  • struts.xslt.nocache - Defaults to false. If set to true, disables stylesheet caching. Good for development, bad for production.
Example:

 <result name="success" type="xslt">foo.xslt</result>
 


Field Summary
final public static  StringDEFAULT_PARAM
     'stylesheetLocation' parameter.
protected  booleannoCache
     Determines whether or not the result should allow caching.

Constructor Summary
public  XSLTResult()
    
public  XSLTResult(String stylesheetLocation)
    

Method Summary
public  voidexecute(ActionInvocation invocation)
    
protected  AdapterFactorygetAdapterFactory()
    
protected  SourcegetDOMSourceForStack(Object value)
    
public  StringgetExcludingPattern()
    
public  StringgetExposedValue()
    
public  StringgetMatchingPattern()
    
public  StringgetStylesheetLocation()
    
protected  TemplatesgetTemplates(String path)
    
protected  URIResolvergetURIResolver()
     Get the URI Resolver to be called by the processor when it encounters an xsl:include, xsl:import, or document() function.
protected  voidsetAdapterFactory(AdapterFactory adapterFactory)
    
public  voidsetExcludingPattern(String excludingPattern)
    
public  voidsetExposedValue(String exposedValue)
    
public  voidsetLocation(String location)
    
public  voidsetMatchingPattern(String matchingPattern)
    
public  voidsetNoCache(String val)
    
public  voidsetParse(boolean parse)
     If true, parse the stylesheet location for OGNL expressions.
public  voidsetStylesheetLocation(String location)
    

Field Detail
DEFAULT_PARAM
final public static String DEFAULT_PARAM(Code)
'stylesheetLocation' parameter. Points to the xsl.



noCache
protected boolean noCache(Code)
Determines whether or not the result should allow caching.




Constructor Detail
XSLTResult
public XSLTResult()(Code)



XSLTResult
public XSLTResult(String stylesheetLocation)(Code)




Method Detail
execute
public void execute(ActionInvocation invocation) throws Exception(Code)



getAdapterFactory
protected AdapterFactory getAdapterFactory()(Code)



getDOMSourceForStack
protected Source getDOMSourceForStack(Object value) throws IllegalAccessException, InstantiationException(Code)



getExcludingPattern
public String getExcludingPattern()(Code)



getExposedValue
public String getExposedValue()(Code)



getMatchingPattern
public String getMatchingPattern()(Code)



getStylesheetLocation
public String getStylesheetLocation()(Code)



getTemplates
protected Templates getTemplates(String path) throws TransformerException, IOException(Code)



getURIResolver
protected URIResolver getURIResolver()(Code)
Get the URI Resolver to be called by the processor when it encounters an xsl:include, xsl:import, or document() function. The default is an instance of ServletURIResolver, which operates relative to the servlet context.



setAdapterFactory
protected void setAdapterFactory(AdapterFactory adapterFactory)(Code)



setExcludingPattern
public void setExcludingPattern(String excludingPattern)(Code)



setExposedValue
public void setExposedValue(String exposedValue)(Code)



setLocation
public void setLocation(String location)(Code)



setMatchingPattern
public void setMatchingPattern(String matchingPattern)(Code)



setNoCache
public void setNoCache(String val)(Code)



setParse
public void setParse(boolean parse)(Code)
If true, parse the stylesheet location for OGNL expressions.
Parameters:
  parse -



setStylesheetLocation
public void setStylesheetLocation(String location)(Code)



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.