cocoon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cziege...@apache.org
Subject cvs commit: cocoon-2.1/src/java/org/apache/cocoon/components/treeprocessor TreeProcessor.java
Date Sun, 06 Jun 2004 11:40:34 GMT
cziegeler    2004/06/06 04:40:34

  Modified:    src/java/org/apache/cocoon/components/treeprocessor
                        TreeProcessor.java
  Log:
  Update comments
  
  Revision  Changes    Path
  1.35      +47 -22    cocoon-2.1/src/java/org/apache/cocoon/components/treeprocessor/TreeProcessor.java
  
  Index: TreeProcessor.java
  ===================================================================
  RCS file: /home/cvs/cocoon-2.1/src/java/org/apache/cocoon/components/treeprocessor/TreeProcessor.java,v
  retrieving revision 1.34
  retrieving revision 1.35
  diff -u -r1.34 -r1.35
  --- TreeProcessor.java	5 Jun 2004 08:18:50 -0000	1.34
  +++ TreeProcessor.java	6 Jun 2004 11:40:34 -0000	1.35
  @@ -65,8 +65,6 @@
                  Disposable,
                  Initializable {
   
  -    public static final String COCOON_REDIRECT_ATTR = "sitemap:cocoon-redirect";
  -
       private static final String XCONF_URL =
           "resource://org/apache/cocoon/components/treeprocessor/treeprocessor-builtins.xml";
   
  @@ -170,19 +168,31 @@
           return new TreeProcessor(this, delayedSource, checkReload, prefix);
       }
   
  +    /* (non-Javadoc)
  +     * @see org.apache.avalon.framework.context.Contextualizable#contextualize(org.apache.avalon.framework.context.Context)
  +     */
       public void contextualize(Context context) throws ContextException {
           this.context = context;
       }
   
  +    /* (non-Javadoc)
  +     * @see org.apache.avalon.framework.component.Composable#compose(org.apache.avalon.framework.component.ComponentManager)
  +     */
       public void compose(ComponentManager manager) throws ComponentException {
           this.manager = manager;
           this.resolver = (SourceResolver)this.manager.lookup(SourceResolver.ROLE);
       }
   
  +    /* (non-Javadoc)
  +     * @see org.apache.avalon.excalibur.component.RoleManageable#setRoleManager(org.apache.avalon.excalibur.component.RoleManager)
  +     */
       public void setRoleManager(RoleManager rm) {
           this.roleManager = rm;
       }
   
  +    /* (non-Javadoc)
  +     * @see org.apache.avalon.framework.activity.Initializable#initialize()
  +     */
       public void initialize() throws Exception {
           // setup the environment helper
           if (this.environmentHelper == null ) {
  @@ -193,13 +203,16 @@
           ContainerUtil.service(this.environmentHelper, new ComponentManagerWrapper(manager));
       }
   
  -/*
  -  <processor>
  -    <reload delay="10"/>
  -    <root-language name="sitemap"/>
  -    <language>...</language>
  -  </processor>
  -*/
  +    /** 
  +     * Configure the tree processor:
  +     * <processor>
  +     *   <reload delay="10"/>
  +     *   <root-language name="sitemap"/>
  +     *   <language>...</language>
  +     * </processor>
  +     * 
  +     * @see org.apache.avalon.framework.configuration.Configurable#configure(org.apache.avalon.framework.configuration.Configuration)
  +     */
       public void configure(Configuration config)
       throws ConfigurationException {
           this.fileName = config.getAttribute("file", null);
  @@ -262,9 +275,9 @@
        */
       public boolean process(Environment environment) throws Exception {
       	
  -    		setupConcreteProcessor(environment);
  +        setupConcreteProcessor(environment);
       		
  -    		return this.concreteProcessor.process(environment);
  +        return this.concreteProcessor.process(environment);
       }
   
       
  @@ -276,9 +289,9 @@
       public InternalPipelineDescription buildPipeline(Environment environment)
       throws Exception {
       	
  -    		setupConcreteProcessor(environment);
  +        setupConcreteProcessor(environment);
       		
  -    		return this.concreteProcessor.buildPipeline(environment);
  +        return this.concreteProcessor.buildPipeline(environment);
       }
         
       /* (non-Javadoc)
  @@ -297,14 +310,14 @@
        * Set the sitemap component configurations
        */
       public void setComponentConfigurations(Configuration componentConfigurations) {
  -    		this.concreteProcessor.setComponentConfigurations(componentConfigurations);
  +        this.concreteProcessor.setComponentConfigurations(componentConfigurations);
       }
   
       /* (non-Javadoc)
        * @see org.apache.cocoon.Processor#getComponentConfigurations()
        */
       public Map getComponentConfigurations() {
  -    		return this.concreteProcessor.getComponentConfigurations();
  +        return this.concreteProcessor.getComponentConfigurations();
       }
   
       /* (non-Javadoc)
  @@ -321,6 +334,10 @@
           return this.environmentHelper;
       }
   
  +    /**
  +     * The current environment helper used by the MountNode
  +     * @return EnvironmentHelper 
  +     */
       public EnvironmentHelper getEnvironmentHelper() {
           return this.environmentHelper;   
       }
  @@ -349,7 +366,12 @@
           ConcreteTreeProcessor newProcessor = new ConcreteTreeProcessor(this);
           long newLastModified;
           this.setupLogger(newProcessor);
  -        //FIXME (SW): why do we need to enterProcessor here?
  +        // We have to do a call to enterProcessor() here as during building
  +        // of the tree, components (e.g. actions) are already instantiated 
  +        // (ThreadSafe ones mostly).
  +        // If these components try to access the current processor or the
  +        // current service manager they must get this one - which is currently
  +        // in the process of initialization.
           EnvironmentHelper.enterProcessor(this, new ComponentManagerWrapper(this.manager),
env);
           try {
               if (builder instanceof Recomposable) {
  @@ -387,21 +409,24 @@
   
           // Dispose the old processor, if any
           if (oldProcessor != null) {
  -                    oldProcessor.markForDisposal();
  +            oldProcessor.markForDisposal();
           }
       }
   
  +    /* (non-Javadoc)
  +     * @see org.apache.avalon.framework.activity.Disposable#dispose()
  +     */
       public void dispose() {
           // Dispose the concrete processor. No need to check for existing requests, as there
           // are none when a TreeProcessor is disposed.
           if (this.concreteProcessor != null) {
  -                this.concreteProcessor.dispose();
  +          this.concreteProcessor.dispose();
           }
   
           if (this.parent == null) {
  -        		// root processor : dispose the builder selector
  -        		this.builderSelector.dispose();
  -        	}
  +            // root processor : dispose the builder selector
  +            this.builderSelector.dispose();
  +        }
   
   	    if ( this.manager != null ) {
   	        if ( this.source != null ) {
  
  
  

Mime
View raw message