crafterm    2002/10/23 09:17:25

  Modified:    src/webapp sitemap.xmap
  Log:
  Sitemap patch explaining the different pipeline implementations.
  
  PR: Bugzilla#13880
  Obtained By: Michael Melhem <[EMAIL PROTECTED]>
  
  Revision  Changes    Path
  1.79      +34 -0     xml-cocoon2/src/webapp/sitemap.xmap
  
  Index: sitemap.xmap
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/src/webapp/sitemap.xmap,v
  retrieving revision 1.78
  retrieving revision 1.79
  diff -u -r1.78 -r1.79
  --- sitemap.xmap      18 Oct 2002 14:09:06 -0000      1.78
  +++ sitemap.xmap      23 Oct 2002 16:17:25 -0000      1.79
  @@ -311,6 +311,40 @@
   
     <!--
        The different pipeline implementations
  +
  +     NON-CACHING:
  +     The non caching implementation of cocoon pipelines.
  +
  +     CACHING:
  +     Traditional longest cachable key caching.
  +     
  +     CACHING-POINT:
  +     The caching-point pipeline implements an extended
  +     caching algorithm which is of particular benefit for use with 
  +     those pipelines that utilise cocoon-views and/or provide 
  +     drill-down functionality.
  +     
  +     The autoCachingPoint algorithim (if enabled) will automatically
  +     cache common elements of the pipeline currently being processed - as well
  +     as the entire cachable pipeline according to the "longest cachable key"
  +     algorithm.
  +
  +     Consider the following simple pipeline, where generator G is labelled with
  +     a cocoon-view enabling the pipeline to serialize data to either html or pdf 
  +     depending on the value of cocoon-view (as provided by the request):
  +     G - T -  S(html)
  +     |__ T -  S(pdf)
  +     
  +     If cocoon-view=html, then the caching-point algorithm will not only cache 
  +     the longest cachable path, which would be GTS(html) but also the
  +     *common element* which in this case would be the results from G. If the
  +     next request to this pipeline was cocoon-view=pdf, then there would be no
  +     need to invoke the generator a second time, as it's value has already been
  +     cached (provided G generates the same cache key)
  +
  +     Also note: One can switch "Off" autoCachingPoint and use "pipeline-hints" to
  +     manually indicate that certain pipeline-components should be considered as
  +     cache points.
     -->
     <map:pipelines default="caching">
        <map:pipeline name="caching" 
src="org.apache.cocoon.components.pipeline.impl.CachingProcessingPipeline"/>
  
  
  

----------------------------------------------------------------------
In case of troubles, e-mail:     [EMAIL PROTECTED]
To unsubscribe, e-mail:          [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to