Java Doc for DefaultTreeBuilder.java in  » Content-Management-System » apache-lenya-2.0 » org » apache » cocoon » components » treeprocessor » 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 » Content Management System » apache lenya 2.0 » org.apache.cocoon.components.treeprocessor 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.cocoon.components.treeprocessor.DefaultTreeBuilder

All known Subclasses:   org.apache.cocoon.components.treeprocessor.sitemap.SitemapLanguage,
DefaultTreeBuilder
public class DefaultTreeBuilder extends AbstractLogEnabled implements TreeBuilder,Recomposable,Configurable,Contextualizable,RoleManageable,Recyclable,Disposable(Code)

author:
   Sylvain Wallez
version:
   CVS $Id: DefaultTreeBuilder.java 446922 2006-09-16 19:24:36Z vgritsenko $


Field Summary
protected  Mapattributes
    
protected  ComponentSelectorbuilderSelector
    
protected  Configurationconfiguration
    
protected  Contextcontext
    
protected  StringfileName
    
protected  StringlanguageName
    
protected  LifecycleHelperlifecycle
    
protected  ComponentManagermanager
     Component manager created by DefaultTreeBuilder.createComponentManager(Configuration) .
protected  Stringnamespace
    
protected  StringparameterElement
    
protected  ComponentManagerparentManager
     The parent component manager, set using compose() and recompose() (implementation of Recomposable).
protected  RoleManagerparentRoleManager
     The parent role manager, set using setRoleManager (implementation of RoleManageable).
protected  ConcreteTreeProcessorprocessor
     The tree processor that we're building.
protected  RoleManagerroleManager
     Role manager result created by DefaultTreeBuilder.createRoleManager() .


Method Summary
public  ProcessingNodebuild(Source source)
    
public  ProcessingNodebuild(Configuration tree)
     Build a processing tree from a Configuration.
public  voidcompose(ComponentManager manager)
    
public  voidconfigure(Configuration config)
    
public  voidcontextualize(Context context)
    
protected  ComponentSelectorcreateBuilderSelector()
     Create a ComponentSelector for ProcessingNodeBuilders.
protected  ComponentManagercreateComponentManager(Configuration tree)
     Create a component manager that will be used for all Composable ProcessingNodeBuilders and ProcessingNodes.

The default here is to simply return the manager set by compose(), i.e.

public  ProcessingNodeBuildercreateNodeBuilder(Configuration config)
    
protected  RoleManagercreateRoleManager()
     Create a role manager that will be used by all RoleManageable components.
protected  ProcessingNodecreateTree(Configuration tree)
     Create the tree once component manager and node builders have been set up.
public  voiddispose()
    
public  ObjectgetAttribute(String name)
    
public  ListgetDisposableNodes()
     Return the list of ProcessingNodes part of this tree that are Disposable.
public  StringgetFileName()
    
public  StringgetLanguage()
     Returns the language that is being built (e.g.
protected  LocationImplgetLocation(Configuration config)
    
public  StringgetNamespace()
     Get the namespace URI that builders should use to find their nodes.
public  StringgetParameterName()
     Returns the name of the parameter element.
protected  MapgetParameters(Configuration config, Location location)
     Get <xxx:parameter> elements as a Map of ListOfMapResolvers, that can be turned into parameters using ListOfMapResolver.buildParameters().
public  ConcreteTreeProcessorgetProcessor()
    
public  ProcessingNodegetRegisteredNode(String name)
    
public  ComponentManagergetSitemapComponentManager()
    
public  StringgetTypeForStatement(Configuration statement, String role)
     Get the type for a statement : it returns the 'type' attribute if present, and otherwhise the default hint of the ExtendedSelector designated by role role.
protected  voidlinkNodes()
     Resolve links : call linkNode() on all LinkedProcessingNodeBuilders.
public  voidrecompose(ComponentManager manager)
    
public  voidrecycle()
    
public  booleanregisterNode(String name, ProcessingNode node)
    
public  voidsetAttribute(String name, Object value)
    
public  voidsetProcessor(ConcreteTreeProcessor processor)
    
public  voidsetRoleManager(RoleManager rm)
    
public  ProcessingNodesetupNode(ProcessingNode node, Configuration config)
     Setup a ProcessingNode by setting its location, calling all the lifecycle interfaces it implements and giving it the parameter map if it's a ParameterizableNode.

Field Detail
attributes
protected Map attributes(Code)



builderSelector
protected ComponentSelector builderSelector(Code)
Selector for ProcessingNodeBuilders



configuration
protected Configuration configuration(Code)



context
protected Context context(Code)



fileName
protected String fileName(Code)



languageName
protected String languageName(Code)



lifecycle
protected LifecycleHelper lifecycle(Code)



manager
protected ComponentManager manager(Code)
Component manager created by DefaultTreeBuilder.createComponentManager(Configuration) .



namespace
protected String namespace(Code)



parameterElement
protected String parameterElement(Code)



parentManager
protected ComponentManager parentManager(Code)
The parent component manager, set using compose() and recompose() (implementation of Recomposable).



parentRoleManager
protected RoleManager parentRoleManager(Code)
The parent role manager, set using setRoleManager (implementation of RoleManageable).



processor
protected ConcreteTreeProcessor processor(Code)
The tree processor that we're building.



roleManager
protected RoleManager roleManager(Code)
Role manager result created by DefaultTreeBuilder.createRoleManager() .





Method Detail
build
public ProcessingNode build(Source source) throws Exception(Code)



build
public ProcessingNode build(Configuration tree) throws Exception(Code)
Build a processing tree from a Configuration.



compose
public void compose(ComponentManager manager) throws ComponentException(Code)



configure
public void configure(Configuration config) throws ConfigurationException(Code)
Configurable



contextualize
public void contextualize(Context context) throws ContextException(Code)



createBuilderSelector
protected ComponentSelector createBuilderSelector() throws Exception(Code)
Create a ComponentSelector for ProcessingNodeBuilders. It creates a selector with the contents of the "node" element of the configuration. a selector for node builders



createComponentManager
protected ComponentManager createComponentManager(Configuration tree) throws Exception(Code)
Create a component manager that will be used for all Composable ProcessingNodeBuilders and ProcessingNodes.

The default here is to simply return the manager set by compose(), i.e. the component manager set by the calling TreeProcessor.

Subclasses can redefine this method to create a component manager local to a tree, such as for sitemap's <map:components>. a component manager




createNodeBuilder
public ProcessingNodeBuilder createNodeBuilder(Configuration config) throws Exception(Code)



createRoleManager
protected RoleManager createRoleManager() throws Exception(Code)
Create a role manager that will be used by all RoleManageable components. The default here is to create a role manager with the contents of the <roles> element of the configuration.

Subclasses can redefine this method to create roles from other sources than the one used here. the role manager




createTree
protected ProcessingNode createTree(Configuration tree) throws Exception(Code)
Create the tree once component manager and node builders have been set up. Can be overriden by subclasses to perform pre/post tree creation operations.



dispose
public void dispose()(Code)



getAttribute
public Object getAttribute(String name)(Code)



getDisposableNodes
public List getDisposableNodes()(Code)
Return the list of ProcessingNodes part of this tree that are Disposable. Care should be taken to properly dispose them before trashing the processing tree.



getFileName
public String getFileName()(Code)



getLanguage
public String getLanguage()(Code)
Returns the language that is being built (e.g. "sitemap").



getLocation
protected LocationImpl getLocation(Configuration config)(Code)



getNamespace
public String getNamespace()(Code)
Get the namespace URI that builders should use to find their nodes.



getParameterName
public String getParameterName()(Code)
Returns the name of the parameter element.



getParameters
protected Map getParameters(Configuration config, Location location) throws ConfigurationException(Code)
Get <xxx:parameter> elements as a Map of ListOfMapResolvers, that can be turned into parameters using ListOfMapResolver.buildParameters(). the Map of ListOfMapResolver, or null if there are no parameters.



getProcessor
public ConcreteTreeProcessor getProcessor()(Code)



getRegisteredNode
public ProcessingNode getRegisteredNode(String name)(Code)



getSitemapComponentManager
public ComponentManager getSitemapComponentManager()(Code)
Return the sitemap component manager



getTypeForStatement
public String getTypeForStatement(Configuration statement, String role) throws ConfigurationException(Code)
Get the type for a statement : it returns the 'type' attribute if present, and otherwhise the default hint of the ExtendedSelector designated by role role.
throws:
  ConfigurationException - if the default type could not be found.



linkNodes
protected void linkNodes() throws Exception(Code)
Resolve links : call linkNode() on all LinkedProcessingNodeBuilders. Can be overriden by subclasses to perform pre/post resolution operations.



recompose
public void recompose(ComponentManager manager) throws ComponentException(Code)



recycle
public void recycle()(Code)



registerNode
public boolean registerNode(String name, ProcessingNode node)(Code)

See Also:   org.apache.cocoon.components.treeprocessor.TreeBuilder.registerNode(java.lang.Stringorg.apache.cocoon.components.treeprocessor.ProcessingNode)



setAttribute
public void setAttribute(String name, Object value)(Code)



setProcessor
public void setProcessor(ConcreteTreeProcessor processor)(Code)



setRoleManager
public void setRoleManager(RoleManager rm)(Code)



setupNode
public ProcessingNode setupNode(ProcessingNode node, Configuration config) throws Exception(Code)
Setup a ProcessingNode by setting its location, calling all the lifecycle interfaces it implements and giving it the parameter map if it's a ParameterizableNode.

As a convenience, the node is returned by this method to allow constructs like return treeBuilder.setupNode(new MyNode(), config).




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