cocoon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From vgritse...@apache.org
Subject svn commit: r605605 - in /cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon: generation/ serialization/ transformation/
Date Wed, 19 Dec 2007 16:19:53 GMT
Author: vgritsenko
Date: Wed Dec 19 08:19:51 2007
New Revision: 605605

URL: http://svn.apache.org/viewvc?rev=605605&view=rev
Log:
javadoc

Modified:
    cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/CSVGenerator.java
    cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/CalendarGenerator.java
    cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/DirectoryGenerator.java
    cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/FileGenerator.java
    cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/FileGeneratorBean.java
    cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/ImageDirectoryGenerator.java
    cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/LinkStatusGenerator.java
    cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/MP3DirectoryGenerator.java
    cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/RequestGenerator.java
    cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/SessionAttributeGenerator.java
    cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/XPathDirectoryGenerator.java
    cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/serialization/HTMLSerializer.java
    cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/AugmentTransformer.java
    cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/EncodeURLTransformer.java
    cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/FilterTransformer.java
    cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/LogTransformer.java
    cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/ReadDOMSessionTransformer.java
    cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/RoleFilterTransformer.java
    cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/SourceWritingTransformer.java
    cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/StripNameSpacesTransformer.java
    cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/TeeTransformer.java
    cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/TraxTransformer.java
    cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/WriteDOMSessionTransformer.java
    cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/XIncludeTransformer.java
    cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/XSLTTransformer.java

Modified: cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/CSVGenerator.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/CSVGenerator.java?rev=605605&r1=605604&r2=605605&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/CSVGenerator.java (original)
+++ cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/CSVGenerator.java Wed Dec 19 08:19:51 2007
@@ -101,8 +101,8 @@
  * @cocoon.sitemap.component.documentation
  * A simple parser converting a Comma Separated Values (CSV) file into XML.
  * @cocoon.sitemap.component.name   csv
- * @cocoon.sitemap.component.documentation.caching
- *     Uses the last modification date of the xml document for validation
+ * @cocoon.sitemap.component.documentation.caching Yes.
+ *   Uses the last modification date of the xml document for validation
  *
  * @version $Id$
  */

Modified: cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/CalendarGenerator.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/CalendarGenerator.java?rev=605605&r1=605604&r2=605605&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/CalendarGenerator.java (original)
+++ cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/CalendarGenerator.java Wed Dec 19 08:19:51 2007
@@ -81,9 +81,9 @@
  *               
  * @cocoon.sitemap.component.documentation
  * Generates an XML document representing a calendar for a given month and year.
- * @cocoon.sitemap.component.documentation.caching TBD
  * @cocoon.sitemap.component.name   calendar
  * @cocoon.sitemap.component.label  content
+ * @cocoon.sitemap.component.documentation.caching Yes
  *
  * @version $Id$
  */

Modified: cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/DirectoryGenerator.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/DirectoryGenerator.java?rev=605605&r1=605604&r2=605605&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/DirectoryGenerator.java (original)
+++ cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/DirectoryGenerator.java Wed Dec 19 08:19:51 2007
@@ -46,15 +46,16 @@
 import org.xml.sax.helpers.AttributesImpl;
 
 /**
+ * Generates an XML directory listing.
+ * A more general approach is implemented by the {@link TraversableGenerator}.
+ *
  * @cocoon.sitemap.component.documentation
  * Generates an XML directory listing.
- * A more general approach is implemented by the TraversableGenerator (src/blocks/repository/java/org/apache/cocoon/generation/TraversableGenerator.java)
- * 
+ * A more general approach is implemented by the {@link TraversableGenerator}.
  * @cocoon.sitemap.component.name   directory
  * @cocoon.sitemap.component.label  content
- * @cocoon.sitemap.component.documentation.caching
- *               Uses the last modification date of the directory and the contained files
- * 
+ * @cocoon.sitemap.component.documentation.caching Yes.
+ *   Uses the last modification date of the directory and the contained files.
  * @cocoon.sitemap.component.pooling.max  16
  *
  * @version $Id$

Modified: cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/FileGenerator.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/FileGenerator.java?rev=605605&r1=605604&r2=605605&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/FileGenerator.java (original)
+++ cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/FileGenerator.java Wed Dec 19 08:19:51 2007
@@ -35,15 +35,16 @@
 import org.xml.sax.SAXException;
 
 /**
- * @cocoon.sitemap.component.documentation
  * The <code>FileGenerator</code> is a class that reads XML from a source
- * and generates SAX Events. The <code>FileGenerator</code> implements the
- * <code>CacheableProcessingComponent</code> interface.
+ * and generates SAX Events. The <code>FileGenerator</code> is cacheable.
  *
+ * @cocoon.sitemap.component.documentation
+ * The <code>FileGenerator</code> is a class that reads XML from a source
+ * and generates SAX Events. The <code>FileGenerator</code> is cacheable.
  * @cocoon.sitemap.component.name   file
  * @cocoon.sitemap.component.label  content
- * @cocoon.sitemap.component.documentation.caching
- *     Uses the last modification date of the xml document for validation
+ * @cocoon.sitemap.component.documentation.caching Yes.
+ * Uses the last modification date of the xml document for validation
  *
  * @version $Id$
  */

Modified: cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/FileGeneratorBean.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/FileGeneratorBean.java?rev=605605&r1=605604&r2=605605&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/FileGeneratorBean.java (original)
+++ cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/FileGeneratorBean.java Wed Dec 19 08:19:51 2007
@@ -35,21 +35,21 @@
 import java.util.Map;
 
 /**
- * @cocoon.sitemap.component.documentation
  * The <code>FileGenerator</code> is a class that reads XML from a source
- * and generates SAX Events. The <code>FileGenerator</code> implements the
- * <code>CacheableProcessingComponent</code> interface.
+ * and generates SAX Events. The <code>FileGenerator</code> is cacheable.
  *
+ * @cocoon.sitemap.component.documentation
+ * The <code>FileGenerator</code> is a class that reads XML from a source
+ * and generates SAX Events. The <code>FileGenerator</code> is cacheable.
  * @cocoon.sitemap.component.name   file
  * @cocoon.sitemap.component.label  content
  * @cocoon.sitemap.component.documentation.caching
- *     Uses the last modification date of the xml document for validation
+ * Uses the last modification date of the xml document for validation
  *
  * @version $Id$
  */
-public class FileGeneratorBean
-    extends AbstractLogEnabled
-    implements Generator, CacheableProcessingComponent, DisposableSitemapComponent {
+public class FileGeneratorBean extends AbstractLogEnabled
+                               implements Generator, CacheableProcessingComponent, DisposableSitemapComponent {
 
     /** The input source */
     protected Source inputSource;
@@ -63,6 +63,7 @@
     /** The SAX Parser. */
     protected SAXParser parser;
 
+
     public void setParser(SAXParser parser) {
         this.parser = parser;
     }
@@ -71,7 +72,7 @@
      * @see org.apache.cocoon.sitemap.DisposableSitemapComponent#dispose()
      */
     public void dispose() {
-        if ( this.inputSource != null ) {
+        if (this.inputSource != null) {
             this.resolver.release(this.inputSource);
             this.inputSource = null;
         }

Modified: cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/ImageDirectoryGenerator.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/ImageDirectoryGenerator.java?rev=605605&r1=605604&r2=605605&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/ImageDirectoryGenerator.java (original)
+++ cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/ImageDirectoryGenerator.java Wed Dec 19 08:19:51 2007
@@ -27,18 +27,17 @@
 import org.xml.sax.SAXException;
 
 /**
+ * Generates an XML directory listing. This is an extension of
+ * the {@link DirectoryGenerator} that adds extra attributes for image files.
+ *
  * @cocoon.sitemap.component.documentation
  * Generates an XML directory listing. This is an extension of 
- * the <link href="directory-generator.html">Directory Generator</link> that 
- * adds extra attributes for image files.
- * 
+ * the {@link DirectoryGenerator} that adds extra attributes for image files.
  * @cocoon.sitemap.component.name   imagedirectory
  * @cocoon.sitemap.component.label  content
- * @cocoon.sitemap.component.documentation.caching
- *               Uses the last modification date of the directory and the contained files
- * 
+ * @cocoon.sitemap.component.documentation.caching Yes.
+ * Uses the last modification date of the directory and the contained files
  * @cocoon.sitemap.component.pooling.max  16
- *
  *
  * @version $Id$
  */

Modified: cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/LinkStatusGenerator.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/LinkStatusGenerator.java?rev=605605&r1=605604&r2=605605&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/LinkStatusGenerator.java (original)
+++ cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/LinkStatusGenerator.java Wed Dec 19 08:19:51 2007
@@ -45,11 +45,13 @@
 import java.util.ArrayList;
 
 /**
+ * Generates a list of links that are reachable from the src and their status.
+ *
  * @cocoon.sitemap.component.documentation
  * Generates a list of links that are reachable from the src and their status.
- * 
  * @cocoon.sitemap.component.name   linkstatus
  * @cocoon.sitemap.component.label  content
+ * @cocoon.sitemap.component.documentation.caching No
  *
  * @version $Id$
  */

Modified: cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/MP3DirectoryGenerator.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/MP3DirectoryGenerator.java?rev=605605&r1=605604&r2=605605&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/MP3DirectoryGenerator.java (original)
+++ cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/MP3DirectoryGenerator.java Wed Dec 19 08:19:51 2007
@@ -23,15 +23,16 @@
 import java.io.RandomAccessFile;
 
 /**
+ * An extension of {@link DirectoryGenerator} that adds extra attributes for MP3
+ * files.
+ *
  * @cocoon.sitemap.component.documentation
- * An extension of DirectoryGenerators that adds extra attributes for MP3
+ * An extension of {@link DirectoryGenerator} that adds extra attributes for MP3
  * files.
- * 
  * @cocoon.sitemap.component.name   mp3directory
  * @cocoon.sitemap.component.label  content
- * @cocoon.sitemap.component.documentation.caching
- *               Uses the last modification date of the directory and the contained files
- * 
+ * @cocoon.sitemap.component.documentation.caching Yes.
+ * Uses the last modification date of the directory and the contained files
  *
  * @version $Id$
  */

Modified: cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/RequestGenerator.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/RequestGenerator.java?rev=605605&r1=605604&r2=605605&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/RequestGenerator.java (original)
+++ cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/RequestGenerator.java Wed Dec 19 08:19:51 2007
@@ -38,50 +38,56 @@
 import org.xml.sax.helpers.AttributesImpl;
 
 /**
- * @cocoon.sitemap.component.documentation
  * Generates an XML representation of the incoming request.
- * 
- * @cocoon.sitemap.component.name   request
- * @cocoon.sitemap.component.label  content
  *
- * @cocoon.sitemap.component.pooling.max  16
- * 
- * <p>
- * <b>Configuration options:</b>
+ * <p><b>Configuration options:</b>
  * <dl>
- * <dt> <i>container-encoding</i> (optional)
- * <dd> The encoding used by container. Default value is ISO-8859-1.
- * <dt> <i>form-encoding</i> (optional)
- * <dd> The supposed encoding of the request parameter. Default is null.
- * <dt> <i>generate-attributes</i> (optional)
- * <dd> If true, request attributes were also included. Default is false.
+ * <dt>container-encoding
+ * <dd>The encoding used by container. Optional, default value is ISO-8859-1.
+ * <dt>form-encoding
+ * <dd>The supposed encoding of the request parameter. Optional, default is null.
+ * <dt>generate-attributes
+ * <dd>If true, request attributes were also included. Optional, default is false.
  * </dl>
  * These configuration options are supported at both declaration and use time.
  * The configuration at use time takes priority over declaration time.
  *
+ * @cocoon.sitemap.component.documentation
+ * Generates an XML representation of the incoming request.
+ * @cocoon.sitemap.component.name   request
+ * @cocoon.sitemap.component.label  content
+ * @cocoon.sitemap.component.documentation.caching No
+ * @cocoon.sitemap.component.pooling.max  16
+ *
  * @version $Id$
  */
-public class RequestGenerator extends ServiceableGenerator implements Parameterizable {
+public class RequestGenerator extends ServiceableGenerator
+                              implements Parameterizable {
 
     /** The namespace prefix of this generator. */
     private final static String PREFIX = "h";
+
     /** The namespace URI of this generator. */
     private final static String URI = "http://apache.org/cocoon/request/2.0";
 
     /** The configured container encoding at declaration time. */
     private String global_container_encoding;
+
     /** The configured container encoding at use time. */
     private String container_encoding;
 
     /** The configured form encoding at declaration time. */
     private String global_form_encoding;
+
     /** The configured form encoding at use time. */
     private String form_encoding;
 
     /** The configuration for including request attributes at declaration time. */
     private boolean global_generate_attributes;
+
     /** The configuration for including request attributes at use time. */
     private boolean generate_attributes;
+
 
     public void parameterize(Parameters parameters)
     throws ParameterException {

Modified: cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/SessionAttributeGenerator.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/SessionAttributeGenerator.java?rev=605605&r1=605604&r2=605605&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/SessionAttributeGenerator.java (original)
+++ cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/SessionAttributeGenerator.java Wed Dec 19 08:19:51 2007
@@ -33,12 +33,8 @@
 import org.xml.sax.SAXException;
 
 /**
- * @cocoon.sitemap.component.documentation
  * Generates a document from a session attribute.
  *
- * @cocoon.sitemap.component.name   sessionattribute
- * @cocoon.sitemap.component.label  content
- *
  * Generates a document from a session attribute. The attribute may be a DOM
  * node, an <code>XMLizable</code>, or any other object, and is streamed using
  * the same rules as for &lt;xsp:expr&gt; in XSPs (see {@link
@@ -68,6 +64,12 @@
  *     &lt;map:parameter name="root-element" value="root"/&gt;
  *   &lt;/map:generate&gt;
  * </pre>
+ *
+ * @cocoon.sitemap.component.documentation
+ * Generates a document from a session attribute.
+ * @cocoon.sitemap.component.name   sessionattribute
+ * @cocoon.sitemap.component.label  content
+ * @cocoon.sitemap.component.documentation.caching No
  *
  * @see org.apache.cocoon.transformation.ReadDOMSessionTransformer
  * @see org.apache.cocoon.transformation.WriteDOMSessionTransformer

Modified: cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/XPathDirectoryGenerator.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/XPathDirectoryGenerator.java?rev=605605&r1=605604&r2=605605&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/XPathDirectoryGenerator.java (original)
+++ cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/generation/XPathDirectoryGenerator.java Wed Dec 19 08:19:51 2007
@@ -47,17 +47,10 @@
 
 
 /**
- * @cocoon.sitemap.component.documentation
- * Generates an XML directory listing performing XPath queries on XML files. It can be used both as a plain
- * DirectoryGenerator or, by specifying a parameter <code>xpath</code>, it will perform an XPath query on every XML
- * resource. 
- * 
- * @cocoon.sitemap.component.name   xpathdirectory
- * @cocoon.sitemap.component.label  content
- * @cocoon.sitemap.component.documentation.caching
- *               Uses the last modification date of the directory and the contained documents
- * 
- * 
+ * Generates an XML directory listing performing XPath queries on XML files. It
+ * can be used both as a plain DirectoryGenerator or, by specifying a parameter
+ * <code>xpath</code>, it will perform an XPath query on every XML resource.
+
  * <p>
  * Generates an XML directory listing performing XPath queries on XML files. It can be used both as a plain
  * DirectoryGenerator or, by specifying a parameter <code>xpath</code>, it will perform an XPath query on every XML
@@ -113,10 +106,18 @@
  *  &lt;/dir:directory&gt;
  * </pre>
  *
+ * @cocoon.sitemap.component.documentation
+ * Generates an XML directory listing performing XPath queries on XML files. It
+ * can be used both as a plain DirectoryGenerator or, by specifying a parameter
+ * <code>xpath</code>, it will perform an XPath query on every XML resource.
+ * @cocoon.sitemap.component.name   xpathdirectory
+ * @cocoon.sitemap.component.label  content
+ * @cocoon.sitemap.component.documentation.caching Yes.
+ * Uses the last modification date of the directory and the contained documents
+ *
  * @version $Id$
  */
-public class XPathDirectoryGenerator
-extends DirectoryGenerator {
+public class XPathDirectoryGenerator extends DirectoryGenerator {
     /** Local name for the element that contains the included XML snippet. */
     protected static final String XPATH_NODE_NAME = "xpath";
 

Modified: cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/serialization/HTMLSerializer.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/serialization/HTMLSerializer.java?rev=605605&r1=605604&r2=605605&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/serialization/HTMLSerializer.java (original)
+++ cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/serialization/HTMLSerializer.java Wed Dec 19 08:19:51 2007
@@ -26,22 +26,21 @@
 import java.io.OutputStream;
 
 /**
+ * The html serializer serializes sax events into an html document.
+
  * @cocoon.sitemap.component.documentation
  * The html serializer serializes sax events into an html document.
- * 
  * @cocoon.sitemap.component.name      html
+ * @cocoon.sitemap.component.documentation.caching Yes
  * @cocoon.sitemap.component.mimetype  text/html
- * 
  * @cocoon.sitemap.component.pooling.max  32
  * 
  * @cocoon.sitemap.component.configuration
  * <doctype-public>-//W3C//DTD HTML 4.01 Transitional//EN</doctype-public>
  * <doctype-system>http://www.w3.org/TR/html4/loose.dtd</doctype-system>
  *
- * 
  * @version $Id$
  */
-
 public class HTMLSerializer extends AbstractTextSerializer {
     
     /* (non-Javadoc)

Modified: cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/AugmentTransformer.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/AugmentTransformer.java?rev=605605&r1=605604&r2=605605&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/AugmentTransformer.java (original)
+++ cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/AugmentTransformer.java Wed Dec 19 08:19:51 2007
@@ -32,23 +32,26 @@
 import java.util.StringTokenizer;
 
 /**
- * @cocoon.sitemap.component.documentation
  * Augments all <code>href</code> attributes with the full path to
  * the request. You can optionally specify the <code>mount</code>
  * parameter.
  *
- * The set of attributes to augment can be specified in the
+ * <p>The set of attributes to augment can be specified in the
  * <code>attributes</code> parameter (defaults to href if
  * <code>attributes</code> is not present).  Any blank character, comma or colon
  * is considered as a separator to delimit attributes.
  *
+ * @cocoon.sitemap.component.documentation
+ * Augments all <code>href</code> attributes with the full path to
+ * the request. You can optionally specify the <code>mount</code>
+ * parameter.
  * @cocoon.sitemap.component.name   augment
+ * @cocoon.sitemap.component.documentation.caching No
  *
  * @since October 10, 2001
  * @version $Id$
  */
-public class AugmentTransformer
-    extends AbstractTransformer {
+public class AugmentTransformer extends AbstractTransformer {
 
     protected Map objectModel;
     protected Request request;
@@ -56,6 +59,7 @@
     protected Set augmentedAttributes;
 
     public static final String AUGMENTED_ATTRIBUTES="attributes";
+
 
     public void setup(SourceResolver resolver,
                       Map objectModel,

Modified: cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/EncodeURLTransformer.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/EncodeURLTransformer.java?rev=605605&r1=605604&r2=605605&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/EncodeURLTransformer.java (original)
+++ cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/EncodeURLTransformer.java Wed Dec 19 08:19:51 2007
@@ -40,33 +40,20 @@
 import org.xml.sax.helpers.AttributesImpl;
 
 /**
- * @cocoon.sitemap.component.documentation
  * The encodeURL transformer emits encoded URLs.
  *
- * @cocoon.sitemap.component.name   encodeurl
- * @cocoon.sitemap.component.documentation.caching
- *               TBD
+ * <p>This transformer applies encodeURL method to URLs.
+ * You may want to use this transform to avoid doing the manually
+ * encodeURL() calls.
  *
- * @cocoon.sitemap.component.pooling.max  32
+ * <p>Usually this transformer is appended as last transformer before
+ * the serialization process. In this case it is possible to encode
+ * URLs introduced in the generator, and xslt transformer phase.
  *
- * The encodeURL transformer emits encoded URLs.
- * <p>
- *   This transformer applies encodeURL method to URLs.
- *   You may want to use this transform to avoid doing the manually
- *   encodeURL() calls.
- * </p>
- * <p>
- *   Usually this transformer is appended as last transformer before
- *   the serialization process. In this case it is possible to encode
- *   URLs introduced in the generator, and xslt transformer phase.
- * </p>
- * <p>
- *   You can specify which attributes hold URL values in order to restrict
- *   URL rewriting to specific attributes only.
- * </p>
- * <p>
- * Usage in a sitemap:
- * </p>
+ * <p>You can specify which attributes hold URL values in order to restrict
+ * URL rewriting to specific attributes only.
+ *
+ * <p>Usage in a sitemap:
  * <pre><tt>
  *   &lt;map:composition&gt;
  *   ...
@@ -83,7 +70,15 @@
  *       ...
  *       &lt;map:transform type=&quot;encodeURL&quot;/&gt;
  *       ...
- * </pre></tt>
+ * </tt></pre>
+ *
+ * @cocoon.sitemap.component.documentation
+ * The encodeURL transformer emits encoded URLs.
+ * @cocoon.sitemap.component.name   encodeurl
+ * @cocoon.sitemap.component.documentation.caching Limited.
+ * Transformation result is cacheable only if no encoding was performed
+ * (no session or URL session tracking was used).
+ * @cocoon.sitemap.component.pooling.max  32
  *
  * @version $Id$
  */

Modified: cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/FilterTransformer.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/FilterTransformer.java?rev=605605&r1=605604&r2=605605&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/FilterTransformer.java (original)
+++ cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/FilterTransformer.java Wed Dec 19 08:19:51 2007
@@ -30,14 +30,6 @@
 import java.util.Map;
 
 /**
- * @cocoon.sitemap.component.documentation
- * The filter transformer can be used to let only an amount of elements through in
- * a given block.
- * 
- * @cocoon.sitemap.component.name   filter
- * @cocoon.sitemap.component.documentation.caching TBD
- * 
- * 
  * The filter transformer can be used to let only an amount of elements through in
  * a given block.
  *
@@ -53,11 +45,16 @@
  * <p><b>Known limitation: behaviour of transformer when trigger elements are nested
  * is not predictable.</b>
  *
+ * @cocoon.sitemap.component.documentation
+ * The filter transformer can be used to let only an amount of elements through in
+ * a given block.
+ * @cocoon.sitemap.component.name   filter
+ * @cocoon.sitemap.component.documentation.caching Yes
+ *
  * @version $Id$
  */
-public class FilterTransformer
-extends AbstractTransformer
-implements CacheableProcessingComponent {
+public class FilterTransformer extends AbstractTransformer
+                               implements CacheableProcessingComponent {
     
     private static final String ELEMENT = "element-name";
     private static final String COUNT = "count";
@@ -78,9 +75,9 @@
     
     /** BEGIN SitemapComponent methods **/
     public void setup(SourceResolver resolver,
-    Map objectModel,
-    String source,
-    Parameters parameters)
+                      Map objectModel,
+                      String source,
+                      Parameters parameters)
     throws ProcessingException, SAXException, IOException {
         this.counter=0;
         this.currentBlocknr=0;

Modified: cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/LogTransformer.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/LogTransformer.java?rev=605605&r1=605604&r2=605605&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/LogTransformer.java (original)
+++ cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/LogTransformer.java Wed Dec 19 08:19:51 2007
@@ -32,14 +32,6 @@
 import java.util.Map;
 
 /**
- * @cocoon.sitemap.component.documentation
- * The <code>LogTransformer</code> is a class that can be plugged into a pipeline
- * to print the SAX events which passes thru this transformer in a readable form
- * to a file.
- * 
- * @cocoon.sitemap.component.name  log
- * @cocoon.sitemap.component.pooling.max  16
- *
  * The <code>LogTransformer</code> is a class that can be plugged into a pipeline
  * to print the SAX events which passes thru this transformer in a readable form
  * to a file.
@@ -60,11 +52,17 @@
  * <br>
  * This transformations main purpose is debugging.
  *
- * @version $Id$
+ * @cocoon.sitemap.component.documentation
+ * The <code>LogTransformer</code> is a class that can be plugged into a pipeline
+ * to print the SAX events which passes thru this transformer in a readable form
+ * to a file.
+ * @cocoon.sitemap.component.name  log
+ * @cocoon.sitemap.component.documentation.caching No
+ * @cocoon.sitemap.component.pooling.max  16
  *
+ * @version $Id$
  */
-public class LogTransformer
-  extends AbstractTransformer {
+public class LogTransformer extends AbstractTransformer {
 
     private static String lf = System.getProperty("line.separator", "\n");
 

Modified: cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/ReadDOMSessionTransformer.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/ReadDOMSessionTransformer.java?rev=605605&r1=605604&r2=605605&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/ReadDOMSessionTransformer.java (original)
+++ cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/ReadDOMSessionTransformer.java Wed Dec 19 08:19:51 2007
@@ -31,20 +31,12 @@
 import org.xml.sax.Attributes;
 import org.xml.sax.SAXException;
 
-
 /**
- * @cocoon.sitemap.component.documentation
- * With this transformer, an object that is stored in the session, can be inserted
- * in the SAX stream at a given position, using usual &lt;xsp:expr&gt; rules.
- * Object can be DOM Node, XMLizable, or any other object supported by &lt;xsp:expr&gt;.
- * 
- * @cocoon.sitemap.component.name   readDOMsession
- * 
  * With this transformer, an object that is stored in the session, can be inserted
  * in the SAX stream at a given position, using usual &lt;xsp:expr&gt; rules.
  * Object can be DOM Node, XMLizable, or any other object supported by &lt;xsp:expr&gt;.
  *
- * Usage in sitemap:
+ * <p>Usage in sitemap:
  * <pre>
  *    &lt;map:transform type="read-session"&gt;
  *      &lt;map:parameter name="attribute-name" value="companyInfo"/&gt;
@@ -53,13 +45,20 @@
  *    &lt;/map:transform&gt;
  * </pre>
  *
- * Where:
+ * <p>Where:
  * <ul>
- *  <li><b>attribute-name</b> is the name of the object in the session
- *  <li><b>trigger-element</b> is the element that we need to insert the SAX events
- *  <li><b>postion</b> is the actual place where the stream will be inserted, ie before, after or in
- *  the trigger-element
+ * <li><b>attribute-name</b> is the name of the object in the session
+ * <li><b>trigger-element</b> is the element that we need to insert the SAX events
+ * <li><b>postion</b> is the actual place where the stream will be inserted, ie before, after or in
+ * the trigger-element
  * </ul>
+ *
+ * @cocoon.sitemap.component.documentation
+ * With this transformer, an object that is stored in the session, can be inserted
+ * in the SAX stream at a given position, using usual &lt;xsp:expr&gt; rules.
+ * Object can be DOM Node, XMLizable, or any other object supported by &lt;xsp:expr&gt;.
+ * @cocoon.sitemap.component.name   readDOMsession
+ * @cocoon.sitemap.component.documentation.caching No
  *
  * @version $Id$
  */

Modified: cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/RoleFilterTransformer.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/RoleFilterTransformer.java?rev=605605&r1=605604&r2=605605&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/RoleFilterTransformer.java (original)
+++ cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/RoleFilterTransformer.java Wed Dec 19 08:19:51 2007
@@ -32,15 +32,6 @@
 import java.util.StringTokenizer;
 
 /**
- * @cocoon.sitemap.component.documentation
- * Filter XML fragments based on a user's role.  This will help in
- * the development of smart forms that must only show information to
- * people who are logged in and have the correct role.  The Role is
- * specified by the Request semantics.  You can specify multiple roles
- * by using comma delimiting.
- * 
- * @cocoon.sitemap.component.name   role-filter
- * 
  * Filter XML fragments based on a user's role.  This will help in
  * the development of smart forms that must only show information to
  * people who are logged in and have the correct role.  The Role is
@@ -62,19 +53,27 @@
  * That means you can reassign the namespace to another prefix and all
  * will work as expected.
  *
+ * @cocoon.sitemap.component.documentation
+ * Filter XML fragments based on a user's role.  This will help in
+ * the development of smart forms that must only show information to
+ * people who are logged in and have the correct role.  The Role is
+ * specified by the Request semantics.  You can specify multiple roles
+ * by using comma delimiting.
+ * @cocoon.sitemap.component.name   role-filter
+ * @cocoon.sitemap.component.documentation.caching No
+ *
  * @version $Id$
  */
 public class RoleFilterTransformer extends AbstractTransformer
-        implements CacheableProcessingComponent {
+                                   implements CacheableProcessingComponent {
+
     private final static String URI = "http://apache.org/cocoon/role-filter/1.0";
     private final static String RESTRICT = "restricted";
     private final static String VIEW = "read-only";
     
-    Request request = null;
+    Request request;
     private int skipCounter = 0;
     
-    public RoleFilterTransformer() {
-    }
 
     public final void setup(SourceResolver resolver, Map objectModel, String src, Parameters params)
     throws ProcessingException, SAXException, IOException {
@@ -139,8 +138,8 @@
         }
     }
 
-    private final Attributes copyAttributes(final Attributes a, final int role,
-                                            final int view, boolean readOnly) {
+    private Attributes copyAttributes(final Attributes a, final int role,
+                                      final int view, boolean readOnly) {
         if (role < 0 && view < 0) {
             return a;
         }

Modified: cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/SourceWritingTransformer.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/SourceWritingTransformer.java?rev=605605&r1=605604&r2=605605&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/SourceWritingTransformer.java (original)
+++ cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/SourceWritingTransformer.java Wed Dec 19 08:19:51 2007
@@ -47,11 +47,6 @@
 import org.xml.sax.SAXException;
 
 /**
- * @cocoon.sitemap.component.documentation
- * This transformer allows you to output to a ModifiableSource.
- *
- * @cocoon.sitemap.component.name   sourcewriting
- *
  * This transformer allows you to output to a ModifiableSource.
  *
  * <p>Definition:</p>
@@ -225,6 +220,11 @@
  * TODO: Use the serializer instead of the XMLUtils for inserting of fragments<br/>
  * TODO: Add a &lt;source:before/&gt; tag.
  * </b>
+ *
+ * @cocoon.sitemap.component.documentation
+ * This transformer allows you to output to a ModifiableSource.
+ * @cocoon.sitemap.component.name   sourcewriting
+ * @cocoon.sitemap.component.documentation.caching No
  *
  * @version $Id$
  */

Modified: cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/StripNameSpacesTransformer.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/StripNameSpacesTransformer.java?rev=605605&r1=605604&r2=605605&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/StripNameSpacesTransformer.java (original)
+++ cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/StripNameSpacesTransformer.java Wed Dec 19 08:19:51 2007
@@ -29,55 +29,57 @@
 import org.xml.sax.SAXException;
 
 /**
- * @cocoon.sitemap.component.documentation
  * The <code>StripNameSpacesTransformer</code> is a class that can be plugged into a pipeline
  * to strip all namespaces from a SAX stream. It is much faster (certainly for larger
  * streams, but easily factor 100) then the conventional stripnamespaces.xsl
  *
+ * @cocoon.sitemap.component.documentation
+ * The <code>StripNameSpacesTransformer</code> is a class that can be plugged into a pipeline
+ * to strip all namespaces from a SAX stream. It is much faster (certainly for larger
+ * streams, but easily factor 100) then the conventional stripnamespaces.xsl
  * @cocoon.sitemap.component.name  stripnamespaces
+ * @cocoon.sitemap.component.documentation.caching Yes
  * @cocoon.sitemap.component.pooling.max  32
  *
  * @version $Id$
  * @author ard schrijvers
- *
  */
-public class StripNameSpacesTransformer extends AbstractTransformer implements
-		CacheableProcessingComponent {
+public class StripNameSpacesTransformer extends AbstractTransformer
+                                        implements CacheableProcessingComponent {
 
 	private static final String EMPTY_NS = "";
 
-	public void setup(SourceResolver resolver, Map objectModel, String src,
-			Parameters params) throws ProcessingException, SAXException,
-			IOException {
-           // nothing needed
-	}
-
-	public void startPrefixMapping(String prefix, String uri)
-			throws SAXException {
-		// no prefix
-	}
-
-	public void endPrefixMapping(String prefix) throws SAXException {
-		// no prefix
-	}
-
-	public void startElement(String uri, String localName, String qName,
-			Attributes attr) throws SAXException {
-
-		super.startElement(EMPTY_NS, localName, localName, attr);
-
-	}
 
-	public void endElement(String uri, String localName, String qName)
-			throws SAXException {
-		super.endElement(EMPTY_NS, localName, localName);
-	}
-
-	public Serializable getKey() {
-		return "1";
-	}
-
-	public SourceValidity getValidity() {
-		return NOPValidity.SHARED_INSTANCE;
-	}
-}
\ No newline at end of file
+    public void setup(SourceResolver resolver, Map objectModel, String src,
+                      Parameters params)
+    throws ProcessingException, SAXException, IOException {
+        // nothing needed
+	}
+
+    public Serializable getKey() {
+        return "1";
+    }
+
+    public SourceValidity getValidity() {
+        return NOPValidity.SHARED_INSTANCE;
+    }
+
+    public void startPrefixMapping(String prefix, String uri)
+    throws SAXException {
+        // no prefix
+    }
+
+    public void endPrefixMapping(String prefix) throws SAXException {
+        // no prefix
+    }
+
+    public void startElement(String uri, String localName, String qName, Attributes attr)
+    throws SAXException {
+        super.startElement(EMPTY_NS, localName, localName, attr);
+    }
+
+    public void endElement(String uri, String localName, String qName)
+    throws SAXException {
+        super.endElement(EMPTY_NS, localName, localName);
+    }
+}

Modified: cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/TeeTransformer.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/TeeTransformer.java?rev=605605&r1=605604&r2=605605&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/TeeTransformer.java (original)
+++ cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/TeeTransformer.java Wed Dec 19 08:19:51 2007
@@ -44,14 +44,10 @@
 import org.xml.sax.SAXException;
 
 /**
- * @cocoon.sitemap.component.name tee
- * @cocoon.sitemap.component.pooling.max  16
- * 
- * @cocoon.sitemap.component.documentation
- * This transformer works just like the unix "tee" command and is useful for debugging
- * received XML streams.
- * It is also able to launch an optional system command to view or edit the generated file, so that every time the
- * pipeline is executed, your editor pops up.
+ * This transformer works just like the unix "tee" command and is useful for
+ * debugging received XML streams. It is also able to launch an optional system
+ * command to view or edit the generated file, so that every time the pipeline
+ * is executed, your editor pops up.
  * 
  * <p>The Teetransformer serializes SAX events as-is to the {@link org.apache.excalibur.source.ModifiableSource}
  * specified by its <code>src</code> parameter. 
@@ -64,6 +60,15 @@
  * &lt;/map:transform&gt;
  * </pre>
  * 
+ * @cocoon.sitemap.component.documentation
+ * This transformer works just like the unix "tee" command and is useful for
+ * debugging received XML streams. It is also able to launch an optional system
+ * command to view or edit the generated file, so that every time the pipeline
+ * is executed, your editor pops up.
+ * @cocoon.sitemap.component.name tee
+ * @cocoon.sitemap.component.documentation.caching No
+ * @cocoon.sitemap.component.pooling.max  16
+ *
  * @version $Id$
  */
 public class TeeTransformer extends AbstractSAXTransformer {
@@ -80,7 +85,8 @@
     private OutputStream os;
 
     private String osCommand; 
-    private String fileName = null;
+    private String fileName;
+
     /*
      * (non-Javadoc)
      * 

Modified: cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/TraxTransformer.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/TraxTransformer.java?rev=605605&r1=605604&r2=605605&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/TraxTransformer.java (original)
+++ cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/TraxTransformer.java Wed Dec 19 08:19:51 2007
@@ -61,20 +61,13 @@
 import org.xml.sax.SAXException;
 
 /**
- * @cocoon.sitemap.component.documentation
- * The stylesheet processor
- *
- * @cocoon.sitemap.component.name   xslt
- * @cocoon.sitemap.component.documentation.caching
- *               Uses the last modification date of the xslt document for validation
+ * The XSLT stylesheet processor.
  *
- * @cocoon.sitemap.component.pooling.max  32
- * <p>
- * This Transformer is used to transform the incoming SAX stream using
+ * <p>This Transformer is used to transform the incoming SAX stream using
  * a TrAXProcessor. Use the following sitemap declarations to define, configure
  * and parameterize it:
- * </p>
- * <b>In the map:sitemap/map:components/map:transformers:</b><br>
+ *
+ * <p><b>In the map:sitemap/map:components/map:transformers:</b>
  * <pre>
  * &lt;map:transformer name="xslt" src="org.apache.cocoon.transformation.TraxTransformer"&gt;<br>
  *   &lt;use-request-parameters&gt;false&lt;/use-request-parameters&gt;
@@ -132,10 +125,18 @@
  * All &lt;parameter&gt; declarations will be made available in the XSLT stylesheet as
  * xsl:variables.
  *
+ * @cocoon.sitemap.component.documentation
+ * The XSLT stylesheet processor
+ * @cocoon.sitemap.component.name   xslt
+ * @cocoon.sitemap.component.documentation.caching Yes.
+ * Uses the last modification date of the xslt document for validation
+ * @cocoon.sitemap.component.pooling.max  32
+ *
  * @version SVN $Id$
  */
 public class TraxTransformer extends AbstractTransformer
-implements Serviceable, Configurable, CacheableProcessingComponent, Disposable {
+                             implements Serviceable, Configurable, CacheableProcessingComponent,
+                                        Disposable {
 
     /** The service manager instance (protected because used by subclasses) */
     protected ServiceManager manager;

Modified: cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/WriteDOMSessionTransformer.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/WriteDOMSessionTransformer.java?rev=605605&r1=605604&r2=605605&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/WriteDOMSessionTransformer.java (original)
+++ cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/WriteDOMSessionTransformer.java Wed Dec 19 08:19:51 2007
@@ -33,23 +33,23 @@
 import org.xml.sax.SAXException;
 
 /**
- * @cocoon.sitemap.component.documentation
- * Make a DOM object from SAX events and write it to the session.
- * 
- * @cocoon.sitemap.component.name   writeDOMsession
- * 
  * Make a DOM object from SAX events and write it to the session.
  *
- * Usage in sitemap:
+ * <p>Usage in sitemap:
  *    &lt;map:transform type="writeDOMsession"&gt;
  *      &lt;map:parameter name="dom-name" value="content"/&gt;
  *      &lt;map:parameter name="dom-root-element" value="companies"/&gt;
  *    &lt;/map:transform&gt;
  *
- * Where:
+ * <p>Where:
  *   dom-name is the name for the DOM object in the session
  *   dom-root-element is the trigger that will be the root element of the DOM
  *
+ * @cocoon.sitemap.component.documentation
+ * Make a DOM object from SAX events and write it to the session.
+ * @cocoon.sitemap.component.name   writeDOMsession
+ * @cocoon.sitemap.component.documentation.caching No
+ *
  * @version $Id$
  */
 public class WriteDOMSessionTransformer extends AbstractTransformer {
@@ -57,11 +57,12 @@
     public static final String DOM_NAME = "dom-name";
     public static final String DOM_ROOT_ELEMENT = "dom-root-element";
 
-    private boolean buildDom = false;
+    private boolean buildDom;
+
     /**
      * component was correctly setup
      */
-    private boolean setup = false;
+    private boolean setup;
 
     private HttpSession session;
     private DOMBuilder builder;
@@ -74,11 +75,11 @@
      * Recyclable
      */
     public void recycle() {
-        super.recycle();
         this.session = null;
         this.builder = null;
         this.buildDom = false;
         this.setup = false;
+        super.recycle();
     }
 
     /* BEGIN SitemapComponent methods */
@@ -190,5 +191,4 @@
             builder.startPrefixMapping(pre, uri);
         }
     }
-
 }

Modified: cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/XIncludeTransformer.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/XIncludeTransformer.java?rev=605605&r1=605604&r2=605605&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/XIncludeTransformer.java (original)
+++ cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/XIncludeTransformer.java Wed Dec 19 08:19:51 2007
@@ -58,21 +58,22 @@
 import org.xml.sax.ext.LexicalHandler;
 
 /**
- * @cocoon.sitemap.component.documentation
- * Implementation of an XInclude transformer.
- * 
- * @cocoon.sitemap.component.name   xinclude
- * 
- * @cocoon.sitemap.component.pooling.max  16
- * 
  * Implementation of an XInclude transformer. It supports xml:base attributes,
  * XPointer fragment identifiers (see the xpointer package to see what exactly is
  * supported), fallback elements, and does xinclude processing on the included content
  * and on the content of fallback elements (with loop inclusion detection).
  *
+ * @cocoon.sitemap.component.documentation
+ * Implementation of an XInclude transformer.
+ * @cocoon.sitemap.component.name   xinclude
+ * @cocoon.sitemap.component.documentation.caching Yes
+ * @cocoon.sitemap.component.pooling.max  16
+ *
  * @version $Id$
  */
-public class XIncludeTransformer extends AbstractTransformer implements Serviceable, CacheableProcessingComponent { 
+public class XIncludeTransformer extends AbstractTransformer
+                                 implements Serviceable, CacheableProcessingComponent {
+
     protected SourceResolver resolver;
     protected ServiceManager manager;
     private XIncludePipe xIncludePipe;
@@ -91,8 +92,9 @@
     /** The {@link SourceValidity} instance associated with this request. */ 
     protected MultiSourceValidity validity; 
 
+
     public void setup(SourceResolver resolver, Map objectModel, String source, Parameters parameters)
-            throws ProcessingException, SAXException, IOException {
+    throws ProcessingException, SAXException, IOException {
         this.resolver = resolver;
         this.validity = new MultiSourceValidity(resolver, MultiSourceValidity.CHECK_ALWAYS); 
         this.xIncludePipe = new XIncludePipe(); 

Modified: cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/XSLTTransformer.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/XSLTTransformer.java?rev=605605&r1=605604&r2=605605&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/XSLTTransformer.java (original)
+++ cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-components/src/main/java/org/apache/cocoon/transformation/XSLTTransformer.java Wed Dec 19 08:19:51 2007
@@ -60,16 +60,9 @@
 import org.xml.sax.SAXException;
 
 /**
- * @cocoon.sitemap.component.documentation
- * The stylesheet processor
- *
- * @cocoon.sitemap.component.name   xslt
- * @cocoon.sitemap.component.documentation.caching
- *               Uses the last modification date of the xslt document for validation
+ * The XSLT stylesheet processor
  *
- * @cocoon.sitemap.component.pooling.max  32
- * <p>
- * This Transformer is used to transform the incoming SAX stream using
+ * <p>This Transformer is used to transform the incoming SAX stream using
  * a TrAXProcessor. Use the following sitemap declarations to define, configure
  * and parameterize it:
  * </p>
@@ -131,10 +124,18 @@
  * All &lt;parameter&gt; declarations will be made available in the XSLT stylesheet as
  * xsl:variables.
  *
+ * @cocoon.sitemap.component.documentation
+ * The XSLT stylesheet processor
+ * @cocoon.sitemap.component.name   xslt
+ * @cocoon.sitemap.component.documentation.caching Yes.
+ * Uses the last modification date of the xslt document for validation
+ * @cocoon.sitemap.component.pooling.max  32
+ *
  * @version SVN $Id$
  */
 public class XSLTTransformer extends AbstractTransformer
-implements Serviceable, Configurable, CacheableProcessingComponent, Disposable {
+                             implements Serviceable, Configurable, CacheableProcessingComponent,
+                                        Disposable {
 
     /** The service manager instance (protected because used by subclasses) */
     protected ServiceManager manager;



Mime
View raw message