You are viewing a plain text version of this content. The canonical link for it is here.
Posted to docs@cocoon.apache.org by da...@cocoon.zones.apache.org on 2005/09/11 14:00:40 UTC
[DAISY] Updated: Basic Contracts
A document has been updated:
http://cocoon.zones.apache.org/daisy/documentation/664.html
Document ID: 664
Branch: main
Language: default
Name: Basic Contracts (unchanged)
Document Type: Document (unchanged)
Updated on: 9/11/05 12:00:23 PM
Updated by: Geoff Howard
A new version has been created, state: publish
Parts
=====
Content
-------
This part has been updated.
Mime type: text/xml (unchanged)
File name: (unchanged)
Size: 2553 bytes (previous version: 2578 bytes)
Content diff:
(12 equal lines skipped)
CacheableProcessingComponent, Generator, Transformer, Serializer, Reader, and
Action.</p>
--- <p>The goal of this series is to instroduce you to the mechanics of the
--- different components and how they are created. When applicable we will address
--- when is a good time to create these components, although that is not the primary
--- focus.</p>
+++ <p>The goal of this series is to introduce you to the mechanics of the different
+++ components and how they are created. When applicable we will address when is a
+++ good time to create these components, although that is not the primary focus.
+++ </p>
<h2>Core Sitemap Contracts</h2>
<p>The sitemap is responsible for setting up and using the components for a
--- given pipeline. A pipeline consists of one or more SitemapModelComponents and a
--- SitemapOutputComponent. Examples of this are a pipeline consisting of a
--- Generator, some Transformers, and a Serializer. The Generator and Transformer
+++ given pipeline. A pipeline consists of one or more SitemapModelComponents and a
+++ SitemapOutputComponent. Examples of this are a pipeline consisting of a
+++ Generator, some Transformers, and a Serializer. The Generator and Transformer
interfaces implement the SitemapModelComponent while the Serializer interface
--- implements the SitemapOutputComponent. The same goes for a pipeline consisting
--- only of a Reader. The Reader interface implements both the
--- SitemapModelComponent interface and the SitemapOutputComponent interface.</p>
+++ implements the SitemapOutputComponent. The same goes for a pipeline consisting
+++ only of a Reader. The Reader interface implements both the SitemapModelComponent
+++ interface and the SitemapOutputComponent interface.</p>
<p>The basic progression of a request consists of the Sitemap reserving the
--- components that will be used for the request. It then performs the setup that
--- is necessary for the components to find the resources they use and set up any
--- caching directives. Next, it executes the pipeline to produce your results.
+++ components that will be used for the request. It then performs the setup that is
+++ necessary for the components to find the resources they use and set up any
+++ caching directives. Next, it executes the pipeline to produce your results.
Lastly, it releases all the components used to process the request back to the
respective pools.</p>
<h2>Extended Contracts</h2>
<p>The particular pipeline type used can support additional contracts like
--- caching. The CachingPipeline uses the CacheableProcessingComponent interface to
--- determine how and when to control caching. Remember that some items in your
--- system are dependent on more than the URL used to access it. For example, if
--- you are navigating through a list, the important meta-information of what page
--- you are on should be part of the cache so that you don't get repeated results
--- just because the URL didn't really change. We'll look at that in more detail as
--- well.</p>
+++ caching. The CachingPipeline uses the CacheableProcessingComponent interface to
+++ determine how and when to control caching. Remember that some items in your
+++ system are dependent on more than the URL used to access it. For example, if you
+++ are navigating through a list, the important meta-information of what page you
+++ are on should be part of the cache so that you don't get repeated results just
+++ because the URL didn't really change. We'll look at that in more detail as well.
+++ </p>
</body>
</html>
Fields
======
no changes
Links
=====
no changes
Custom Fields
=============
no changes
Collections
===========
no changes