cziegeler 2004/06/17 07:55:24
Modified: src/java/org/apache/cocoon/transformation
FilterTransformer.java LogTransformer.java
SourceWritingTransformer.java
SimpleFormInstanceExtractionTransformer.java
EncodeURLTransformer.java
ReadDOMSessionTransformer.java TraxTransformer.java
CIncludeTransformer.java RoleFilterTransformer.java
AugmentTransformer.java I18nTransformer.java
JPathTransformer.java XIncludeTransformer.java
WriteDOMSessionTransformer.java
JXTemplateTransformer.java
SimpleFormTransformer.java
Log:
Adding docs for transformers
Revision Changes Path
1.6 +11 -1
cocoon-2.1/src/java/org/apache/cocoon/transformation/FilterTransformer.java
Index: FilterTransformer.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/java/org/apache/cocoon/transformation/FilterTransformer.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- FilterTransformer.java 9 Mar 2004 00:57:35 -0000 1.5
+++ FilterTransformer.java 17 Jun 2004 14:55:24 -0000 1.6
@@ -29,6 +29,16 @@
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.logger sitemap.transformer.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.
*
1.5 +13 -1
cocoon-2.1/src/java/org/apache/cocoon/transformation/LogTransformer.java
Index: LogTransformer.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/java/org/apache/cocoon/transformation/LogTransformer.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- LogTransformer.java 5 Mar 2004 13:02:59 -0000 1.4
+++ LogTransformer.java 17 Jun 2004 14:55:24 -0000 1.5
@@ -31,6 +31,18 @@
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.logger sitemap.transformer.log
+ *
+ * @cocoon.sitemap.component.pooling.min 2
+ * @cocoon.sitemap.component.pooling.max 16
+ * @cocoon.sitemap.component.pooling.grow 2
+ *
*
* 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
1.12 +7 -1
cocoon-2.1/src/java/org/apache/cocoon/transformation/SourceWritingTransformer.java
Index: SourceWritingTransformer.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/java/org/apache/cocoon/transformation/SourceWritingTransformer.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- SourceWritingTransformer.java 17 Mar 2004 12:09:52 -0000 1.11
+++ SourceWritingTransformer.java 17 Jun 2004 14:55:24 -0000 1.12
@@ -46,6 +46,12 @@
import org.xml.sax.SAXException;
/**
+ * @cocoon.sitemap.component.documentation
+ * This transformer allows you to output to a ModifiableSource.
+ *
+ * @cocoon.sitemap.component.name write-source
+ * @cocoon.sitemap.component.logger sitemap.transformer.write-source
+ *
* This transformer allows you to output to a ModifiableSource.
*
* <p>Definition:</p>
1.4 +6 -2
cocoon-2.1/src/java/org/apache/cocoon/transformation/SimpleFormInstanceExtractionTransformer.java
Index: SimpleFormInstanceExtractionTransformer.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/java/org/apache/cocoon/transformation/SimpleFormInstanceExtractionTransformer.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- SimpleFormInstanceExtractionTransformer.java 5 Mar 2004 13:02:59
-0000 1.3
+++ SimpleFormInstanceExtractionTransformer.java 17 Jun 2004 14:55:24
-0000 1.4
@@ -39,6 +39,7 @@
import org.xml.sax.SAXException;
/**
+ * @cocoon.sitemap.component.documentation
* This transformer sieves an incoming stream of xml and extracts a
* document fragment from it depending on a given tag and stores the
* fragment using an OutputModule with a name based an attribute of
@@ -49,7 +50,10 @@
* InputModule for it to a chain of request-param and request-attr so
* that the extracted form instance data is used only when no similar
* request parameter exists.
- *
+ *
+ * @cocoon.sitemap.component.name simple-form-instance
+ * @cocoon.sitemap.component.logger sitemap.transformer.simple-form-instance
+ *
* @author <a href="mailto:[EMAIL PROTECTED]">Christian Haul</a>
* @version CVS $Id$
*/
1.8 +14 -2
cocoon-2.1/src/java/org/apache/cocoon/transformation/EncodeURLTransformer.java
Index: EncodeURLTransformer.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/java/org/apache/cocoon/transformation/EncodeURLTransformer.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- EncodeURLTransformer.java 6 Mar 2004 04:58:58 -0000 1.7
+++ EncodeURLTransformer.java 17 Jun 2004 14:55:24 -0000 1.8
@@ -38,6 +38,18 @@
import org.xml.sax.helpers.AttributesImpl;
/**
+ * @cocoon.sitemap.component.documentation
+ * The encodeURL transformer emits encoded URLs.
+ *
+ * @cocoon.sitemap.component.name encodeURL
+ * @cocoon.sitemap.component.logger sitemap.transformer.encodeURL
+ * @cocoon.sitemap.component.documentation.caching
+ * TBD
+ *
+ * @cocoon.sitemap.component.pooling.min 8
+ * @cocoon.sitemap.component.pooling.max 32
+ * @cocoon.sitemap.component.pooling.grow 4
+ *
* The encodeURL transformer emits encoded URLs.
* <p>
* This transformer applies encodeURL method to URLs.
1.4 +9 -1
cocoon-2.1/src/java/org/apache/cocoon/transformation/ReadDOMSessionTransformer.java
Index: ReadDOMSessionTransformer.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/java/org/apache/cocoon/transformation/ReadDOMSessionTransformer.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ReadDOMSessionTransformer.java 5 Mar 2004 13:02:59 -0000 1.3
+++ ReadDOMSessionTransformer.java 17 Jun 2004 14:55:24 -0000 1.4
@@ -31,6 +31,14 @@
/**
+ * @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 <xsp:expr> rules.
+ * Object can be DOM Node, XMLizable, or any other object supported by
<xsp:expr>.
+ *
+ * @cocoon.sitemap.component.name readDOMsession
+ * @cocoon.sitemap.component.logger sitemap.transformer.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 <xsp:expr> rules.
* Object can be DOM Node, XMLizable, or any other object supported by
<xsp:expr>.
1.12 +13 -1
cocoon-2.1/src/java/org/apache/cocoon/transformation/TraxTransformer.java
Index: TraxTransformer.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/java/org/apache/cocoon/transformation/TraxTransformer.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- TraxTransformer.java 5 Mar 2004 13:02:59 -0000 1.11
+++ TraxTransformer.java 17 Jun 2004 14:55:24 -0000 1.12
@@ -57,6 +57,18 @@
import org.xml.sax.SAXException;
/**
+ * @cocoon.sitemap.component.documentation
+ * The stylesheet processor
+ *
+ * @cocoon.sitemap.component.name xslt
+ * @cocoon.sitemap.component.logger sitemap.transformer.xslt
+ * @cocoon.sitemap.component.documentation.caching
+ * Uses the last modification date of the xslt document for
validation
+ *
+ * @cocoon.sitemap.component.pooling.min 8
+ * @cocoon.sitemap.component.pooling.max 32
+ * @cocoon.sitemap.component.pooling.grow 4
+ *
* This Transformer is used to transform the incoming SAX stream using
* a TrAXProcessor. Use the following sitemap declarations to define,
configure
* and parameterize it:
1.12 +11 -1
cocoon-2.1/src/java/org/apache/cocoon/transformation/CIncludeTransformer.java
Index: CIncludeTransformer.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/java/org/apache/cocoon/transformation/CIncludeTransformer.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- CIncludeTransformer.java 11 Jun 2004 20:32:20 -0000 1.11
+++ CIncludeTransformer.java 17 Jun 2004 14:55:24 -0000 1.12
@@ -48,6 +48,7 @@
import java.util.Map;
/**
+* @cocoon.sitemap.component.documentation
* This transformer triggers for the element <code>include</code> in the
* namespace "http://apache.org/cocoon/include/1.0";.
* The <code>src</code> attribute contains the url which points to
@@ -55,6 +56,15 @@
* With the attributes <code>element</code>, <code>ns</code> and
* <code>prefix</code> it is possible to specify an element
* which surrounds the included content.
+ *
+ * @cocoon.sitemap.component.name cinclude
+ * @cocoon.sitemap.component.logger sitemap.transformer.cinclude
+ * @cocoon.sitemap.component.documentation.caching
+ * See documentation for further information.
+ *
+ * @cocoon.sitemap.component.pooling.min 2
+ * @cocoon.sitemap.component.pooling.max 16
+ * @cocoon.sitemap.component.pooling.grow 2
*
* This transformer also supports a more verbose but flexible version:
* <cinclude:includexml
xmlns:cinclude="http://apache.org/cocoon/include/1.0"; ignoreErrors="false">
1.5 +11 -1
cocoon-2.1/src/java/org/apache/cocoon/transformation/RoleFilterTransformer.java
Index: RoleFilterTransformer.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/java/org/apache/cocoon/transformation/RoleFilterTransformer.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- RoleFilterTransformer.java 5 Mar 2004 13:02:59 -0000 1.4
+++ RoleFilterTransformer.java 17 Jun 2004 14:55:24 -0000 1.5
@@ -29,6 +29,16 @@
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
+ * @cocoon.sitemap.component.logger sitemap.transformer.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
1.6 +9 -12
cocoon-2.1/src/java/org/apache/cocoon/transformation/AugmentTransformer.java
Index: AugmentTransformer.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/java/org/apache/cocoon/transformation/AugmentTransformer.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- AugmentTransformer.java 6 Mar 2004 02:26:13 -0000 1.5
+++ AugmentTransformer.java 17 Jun 2004 14:55:24 -0000 1.6
@@ -28,17 +28,14 @@
import java.util.Map;
/**
- * <p>Augments all <code>href</code> attributes with the full path to
- * the request.</p>
- *
- * <p>Usage in sitemap:</p>
- *
- * <pre>
- * <map:transform type="augment">
- * <map:parameter name="mount" value="directory/to/be/appended"/>
- * </map:transform>
- * </pre>
- *
+* @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.logger sitemap.transformer.augment
+ *
* @author <a href="mailto:[EMAIL PROTECTED]">Ovidiu Predescu</a>
* @since October 10, 2001
* @version CVS $Id$
1.26 +9 -1
cocoon-2.1/src/java/org/apache/cocoon/transformation/I18nTransformer.java
Index: I18nTransformer.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/java/org/apache/cocoon/transformation/I18nTransformer.java,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -r1.25 -r1.26
--- I18nTransformer.java 5 Mar 2004 13:02:59 -0000 1.25
+++ I18nTransformer.java 17 Jun 2004 14:55:24 -0000 1.26
@@ -58,8 +58,16 @@
import org.xml.sax.helpers.AttributesImpl;
/**
+ * @cocoon.sitemap.component.documentation
* Internationalization transformer is used to transform i18n markup into
text
* based on a particular locale.
+ *
+ * @cocoon.sitemap.component.name i18n
+ * @cocoon.sitemap.component.logger sitemap.transformer.i18n
+ * @cocoon.sitemap.component.documentation.caching
+ * TBD
+ *
+ *
*
* <h3>i18n transformer</h3>
* <p>The <strong>i18n transformer</strong> works by obtaining the users
locale
1.6 +7 -6
cocoon-2.1/src/java/org/apache/cocoon/transformation/JPathTransformer.java
Index: JPathTransformer.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/java/org/apache/cocoon/transformation/JPathTransformer.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- JPathTransformer.java 5 Mar 2004 13:02:59 -0000 1.5
+++ JPathTransformer.java 17 Jun 2004 14:55:24 -0000 1.6
@@ -32,12 +32,13 @@
import org.xml.sax.helpers.AttributesImpl;
/**
- * JPath Transformer.
- *
- * <p>
+ * @cocoon.sitemap.component.documentation
* Transformer implementation of the JPath XSP tag library.
- * </p>
- *
+ *
+ * @cocoon.sitemap.component.name jpath
+ * @cocoon.sitemap.component.logger sitemap.transformer.jpath
+ *
+ *
* <p>
* This transformer (so far) supports the following jpath elements:
*
1.21 +11 -1
cocoon-2.1/src/java/org/apache/cocoon/transformation/XIncludeTransformer.java
Index: XIncludeTransformer.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/java/org/apache/cocoon/transformation/XIncludeTransformer.java,v
retrieving revision 1.20
retrieving revision 1.21
diff -u -r1.20 -r1.21
--- XIncludeTransformer.java 28 May 2004 22:07:55 -0000 1.20
+++ XIncludeTransformer.java 17 Jun 2004 14:55:24 -0000 1.21
@@ -50,6 +50,16 @@
import org.xml.sax.ext.LexicalHandler;
/**
+ * @cocoon.sitemap.component.documentation
+ * Implementation of an XInclude transformer.
+ *
+ * @cocoon.sitemap.component.name xinclude
+ * @cocoon.sitemap.component.logger sitemap.transformer.xinclude
+ *
+ * @cocoon.sitemap.component.pooling.min 2
+ * @cocoon.sitemap.component.pooling.max 16
+ * @cocoon.sitemap.component.pooling.grow 2
+ *
* 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
1.4 +8 -1
cocoon-2.1/src/java/org/apache/cocoon/transformation/WriteDOMSessionTransformer.java
Index: WriteDOMSessionTransformer.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/java/org/apache/cocoon/transformation/WriteDOMSessionTransformer.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- WriteDOMSessionTransformer.java 5 Mar 2004 13:02:59 -0000 1.3
+++ WriteDOMSessionTransformer.java 17 Jun 2004 14:55:24 -0000 1.4
@@ -32,6 +32,13 @@
/**
+ * @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.logger sitemap.transformer.writeDOMsession
+ *
+ *
* Make a DOM object from SAX events and write it to the session.
*
* Usage in sitemap:
1.3 +1 -0
cocoon-2.1/src/java/org/apache/cocoon/transformation/JXTemplateTransformer.java
Index: JXTemplateTransformer.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/java/org/apache/cocoon/transformation/JXTemplateTransformer.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- JXTemplateTransformer.java 6 Mar 2004 02:26:13 -0000 1.2
+++ JXTemplateTransformer.java 17 Jun 2004 14:55:24 -0000 1.3
@@ -19,6 +19,7 @@
/**
* Transformer adapter for [EMAIL PROTECTED]
org.apache.cocoon.generation.JXTemplateGenerator}
+ *
*/
public class JXTemplateTransformer extends
JXTemplateGenerator.TransformerAdapter {
1.16 +6 -1
cocoon-2.1/src/java/org/apache/cocoon/transformation/SimpleFormTransformer.java
Index: SimpleFormTransformer.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/java/org/apache/cocoon/transformation/SimpleFormTransformer.java,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- SimpleFormTransformer.java 28 Mar 2004 22:03:02 -0000 1.15
+++ SimpleFormTransformer.java 17 Jun 2004 14:55:24 -0000 1.16
@@ -44,8 +44,13 @@
import java.util.Map;
/**
+ * @cocoon.sitemap.component.documentation
* Eliminates the need for XSP to use FormValidatorAction or HTML forms.
* Caveat: Select options need a value attribute to work correctly.
+ *
+ * @cocoon.sitemap.component.name simple-form
+ * @cocoon.sitemap.component.logger sitemap.transformer.simple-form
+ *
*
* <p>This transformer fills all HTML 4 form elements with values from
* an InputModule, e.g. request, with the same name. It handles select
