You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@cocoon.apache.org by vg...@apache.org on 2007/12/19 16:43:47 UTC
svn commit: r605590 - in
/cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/transformation:
I18nTransformer.java IncludeTransformer.java JPathTransformer.java
SimpleFormInstanceExtractionTransformer.java SimpleFormTransformer.java
Author: vgritsenko
Date: Wed Dec 19 07:43:46 2007
New Revision: 605590
URL: http://svn.apache.org/viewvc?rev=605590&view=rev
Log:
javadoc
Modified:
cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/transformation/I18nTransformer.java
cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/transformation/IncludeTransformer.java
cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/transformation/JPathTransformer.java
cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/transformation/SimpleFormInstanceExtractionTransformer.java
cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/transformation/SimpleFormTransformer.java
Modified: cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/transformation/I18nTransformer.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/transformation/I18nTransformer.java?rev=605590&r1=605589&r2=605590&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/transformation/I18nTransformer.java (original)
+++ cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/transformation/I18nTransformer.java Wed Dec 19 07:43:46 2007
@@ -62,14 +62,10 @@
import java.util.StringTokenizer;
/**
- * @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.documentation.caching TBD
- *
- * <h3>I18n Transformer</h3>
+ * <h3>Overview</h3>
* <p>The i18n transformer works by finding a translation for the user's locale
* in the configured catalogues. Locale is passed as parameter to the transformer,
* and it can be determined based on the request, session, or a cookie data by
@@ -263,6 +259,12 @@
* <li>Introduce new <get-locale/> element
* <li>Move all formatting routines to I18nUtils
* </ul>
+ *
+ * @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.documentation.caching Yes
*
* @version $Id$
*/
Modified: cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/transformation/IncludeTransformer.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/transformation/IncludeTransformer.java?rev=605590&r1=605589&r2=605590&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/transformation/IncludeTransformer.java (original)
+++ cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/transformation/IncludeTransformer.java Wed Dec 19 07:43:46 2007
@@ -164,6 +164,7 @@
* A simple transformer including resolvable sources (accessed through
* Cocoon's SourceResolver) from its input.
* @cocoon.sitemap.component.name include
+ * @cocoon.sitemap.component.documentation.caching Yes
* @cocoon.sitemap.component.pooling.max 16
*
* @version $Id$
Modified: cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/transformation/JPathTransformer.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/transformation/JPathTransformer.java?rev=605590&r1=605589&r2=605590&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/transformation/JPathTransformer.java (original)
+++ cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/transformation/JPathTransformer.java Wed Dec 19 07:43:46 2007
@@ -33,11 +33,7 @@
import org.xml.sax.helpers.AttributesImpl;
/**
- * @cocoon.sitemap.component.documentation
- * Transformer implementation of the JPath XSP tag library.
- *
- * @cocoon.sitemap.component.name jpath
- *
+ * Transformer implementation of the JPath XSP tag library.
*
* <p>
* This transformer (so far) supports the following jpath elements:
@@ -52,6 +48,11 @@
* <pre><form name="myform" jpath:action="../cont/id">..</form></pre>
* </ul>
* </p>
+ *
+ * @cocoon.sitemap.component.documentation
+ * Transformer implementation of the JPath XSP tag library.
+ * @cocoon.sitemap.component.name jpath
+ * @cocoon.sitemap.component.documentation.caching No
*
* @version $Id$
*/
Modified: cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/transformation/SimpleFormInstanceExtractionTransformer.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/transformation/SimpleFormInstanceExtractionTransformer.java?rev=605590&r1=605589&r2=605590&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/transformation/SimpleFormInstanceExtractionTransformer.java (original)
+++ cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/transformation/SimpleFormInstanceExtractionTransformer.java Wed Dec 19 07:43:46 2007
@@ -38,7 +38,6 @@
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
@@ -50,12 +49,23 @@
* that the extracted form instance data is used only when no similar
* request parameter exists.
*
+ * @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
+ * another enclosing tag. Default configuration fires on
+ * <form-instance/> and uses @name of enclosing <form/>
+ * tag. Default OutputModule is request-attr. This is usefull in
+ * conjunction with the SimpleFormTransformer when setting the
+ * 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
*
* @version $Id$
*/
public class SimpleFormInstanceExtractionTransformer extends AbstractExtractionTransformer
- implements Configurable, Serviceable {
+ implements Configurable, Serviceable {
protected class ElementData {
public String uri = null;
@@ -72,7 +82,6 @@
}
public boolean equals(String uri, String loc, String raw) {
-
if (!this.uri.equals(uri))
return false;
if (!this.loc.equals(loc))
@@ -98,6 +107,7 @@
ServiceManager manager = null;
Map objectModel = null;
+
public void configure(Configuration config) throws ConfigurationException {
this.startElement = new ElementData();
Modified: cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/transformation/SimpleFormTransformer.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/transformation/SimpleFormTransformer.java?rev=605590&r1=605589&r2=605590&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/transformation/SimpleFormTransformer.java (original)
+++ cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/transformation/SimpleFormTransformer.java Wed Dec 19 07:43:46 2007
@@ -43,14 +43,10 @@
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
- *
- *
- * <p>This transformer fills all HTML 4 form elements with values from
+ * <p>This transformer fills all HTML form elements with values from
* an InputModule, e.g. request, with the same name. It handles select
* boxes, textareas, checkboxes, radio buttons, password and text
* fields, and buttons. Form elements and complete forms can be protected
@@ -141,6 +137,11 @@
* <input name="user.name" size="50" maxlength="60"/>
* <error name="user.name" when-ge="error">required</error>
* </pre></p>
+ *
+ * @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
*
* @version $Id$
*/