danielf 2004/06/08 08:40:08
Modified: src/blocks/forms/java/org/apache/cocoon/forms/flow/javascript
Form.js
src/blocks/forms/samples sitemap.xmap welcome.xml
src/blocks/forms/samples/flow binding_example.js
src/blocks/forms/samples/forms form2_model.xml
Added: src/blocks/forms/java/org/apache/cocoon/forms/util
XMLAdapter.java
src/blocks/forms/samples/forms form2_simple_data.xml
form2simpleXML_result.xml
Log:
Added XMLAdapter which populates a form from XML and serialize a form from
XML without needing any binding description. Also added samples for the XML
binding.
Revision Changes Path
1.16 +7 -3
cocoon-2.1/src/blocks/forms/java/org/apache/cocoon/forms/flow/javascript/Form.js
Index: Form.js
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/forms/java/org/apache/cocoon/forms/flow/javascript/Form.js,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- Form.js 1 Jun 2004 14:32:31 -0000 1.15
+++ Form.js 8 Jun 2004 15:40:08 -0000 1.16
@@ -58,8 +58,8 @@
*/
Form.prototype.getWidget = function(name) {
if (name != undefined) {
- throw "getWidget(id) has been deprecated.\n" +
- "Consider using getChild(id) or lookupWidget(path) instead."
+ throw "getWidget(id) has been deprecated.\n" +
+ "Consider using getChild(id) or lookupWidget(path) instead."
}
return this.form;
}
@@ -181,6 +181,10 @@
Form.prototype.removeAttribute = function(name) {
this.form.removeAttribute(name);
+}
+
+Form.prototype.getXML = function() {
+ return new Packages.org.apache.cocoon.forms.util.XMLAdapter(this.form);
}
function handleForm() {
1.1
cocoon-2.1/src/blocks/forms/java/org/apache/cocoon/forms/util/XMLAdapter.java
Index: XMLAdapter.java
===================================================================
/*
* Copyright 1999-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.cocoon.forms.util;
import java.util.Iterator;
import java.util.Locale;
import org.apache.cocoon.xml.AbstractXMLConsumer;
import org.apache.cocoon.forms.datatype.Datatype;
import org.apache.cocoon.forms.datatype.convertor.ConversionResult;
import org.apache.cocoon.forms.formmodel.Action;
import org.apache.cocoon.forms.formmodel.AggregateField;
import org.apache.cocoon.forms.formmodel.BooleanField;
import org.apache.cocoon.forms.formmodel.ContainerWidget;
import org.apache.cocoon.forms.formmodel.DataWidget;
import org.apache.cocoon.forms.formmodel.Form;
import org.apache.cocoon.forms.formmodel.MultiValueField;
import org.apache.cocoon.forms.formmodel.Repeater;
import org.apache.cocoon.forms.formmodel.Union;
import org.apache.cocoon.forms.formmodel.Widget;
import org.apache.excalibur.xml.sax.XMLizable;
import org.xml.sax.Attributes;
import org.xml.sax.ContentHandler;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.AttributesImpl;
/**
* Adapter class that wraps a <code>Form</code> object and makes it
* possible to populate a widget hierarchy from XML in form of SAX
* events and serialize the content of the widget hierarchy as XML.
*
* The XML format is such that there is one XML element for each
* widget and the element get the widgets id as name. Exceptions from
* this is that the elements in a repeater gets the name
* <code>item</code> and a attribute <code>position</code> with the
* position of the repeater child, instead of just a number (which is
* not allowed as element name). Childs of a
* <code>MultiValueField</code> are also embeded within a
* <code>item</code> element. If the <code>Form</code> widget does
* not have an id it get the name <code>uknown</code>.
*
* An <code>AggregateField</code> can both be interpreted as one value
* and as several widgets. This ambiguity is resolved by chosing to emit
* the single value rather than the fields as XML. For population of the
* form both forms are however allowed.
*
* @version CVS $Id: XMLAdapter.java,v 1.1 2004/06/08 15:40:08 danielf Exp $
*/
public class XMLAdapter extends AbstractXMLConsumer implements XMLizable {
/** Name of element in list. */
private final static String ITEM = "item";
/** Name of unkown element. */
private final static String UNKNOWN = "unknown";
/** Name of position attribute in list. */
private final static String POSITION = "position";
/** The namespace prefix of this component. */
private final static String PREFIX = "";
/** The namespace URI of this component. */
private final static String URI = "";
/** The <code>ContentHandler</code> receiving SAX events. */
private ContentHandler contentHandler;
/** The <code>Widget</code> to read and write XML to. */
private Widget widget;
/** The <code>Widget</code> that we are currently writing to. */
private Widget currentWidget = null;
/** The <code>Locale</code> that decides how to convert widget values to
strings */
private Locale locale;
/** Is a <code>MultiValueField</code> handled? */
private boolean isMultiValueItem = false;
/**
* Wrap a <code>Form</code> with an <code>XMLAdapter</code>
*
*/
public XMLAdapter(Widget widget) {
this.widget = widget;
this.locale = widget.getForm().getLocale();
}
/**
* Set the locale used for conversion between XML data and Java objects
*/
public void setLocale(Locale locale) {
this.locale = locale;
}
/**
* Get the locale used for conversion between XML data and Java objects
*/
public Locale getLocale() {
return this.locale;
}
/* ================ SAX -> Widget ================ */
/*
* The current state during handling of input events is described
* by <code>currentWidget</code> that points to the widget that is
* beeing populated. The state that the population has not began
* yet or that it is finished is encoded by setting
* <code>currentWidget</code> to <code>null</code> and the state of
* being within a <code>item</code> within a
* <code>MultiValueField</code> is encoded by setting the variable
* <code>isMultiValueItem</code> to true.
*/
/**
* Receive notification of the beginning of an element.
*
* @param uri The Namespace URI, or the empty string if the element has no
* Namespace URI or if Namespace
* processing is not being performed.
* @param loc The local name (without prefix), or the empty string if
* Namespace processing is not being performed.
* @param raw The raw XML 1.0 name (with prefix), or the empty string if
* raw names are not available.
* @param a The attributes attached to the element. If there are no
* attributes, it shall be an empty Attributes object.
*/
public void startElement(String uri, String loc, String raw, Attributes a)
throws SAXException {
if (this.currentWidget == null) {
// The name of the root element is ignored
this.currentWidget = this.widget;
return;
} else if (this.currentWidget instanceof ContainerWidget) {
Widget child =
((ContainerWidget)this.currentWidget).getChild(loc);
if (child != null)
this.currentWidget = child;
else
throw new SAXException("There is no widget with id: " + loc +
" as child to: " +
this.currentWidget.getId());
} else if (this.currentWidget instanceof Repeater) {
// In a repeater the XML elements are added in the order
// they are recieved, the position attribute is not used
if (ITEM.equals(loc)) {
Repeater repeater = (Repeater)currentWidget;
currentWidget = repeater.addRow();
} else
throw new SAXException("The element: " + loc +
" is not allowed as a direct child of
a Repeater");
} else if (this.currentWidget instanceof MultiValueField) {
this.isMultiValueItem = true;
if (!ITEM.equals(loc))
throw new SAXException("The element: " + loc +
" is not allowed as a direct child of
a MultiValueField");
}
}
/**
* Receive notification of the end of an element.
*
* @param uri The Namespace URI, or the empty string if the element has no
* Namespace URI or if Namespace
* processing is not being performed.
* @param loc The local name (without prefix), or the empty string if
* Namespace processing is not being performed.
* @param raw The raw XML 1.0 name (with prefix), or the empty string if
* raw names are not available.
*/
public void endElement(String uri, String loc, String raw)
throws SAXException {
if (this.currentWidget == null)
throw new SAXException("Wrong state");
String id = this.currentWidget.getId();
if (this.currentWidget instanceof Form) {
this.currentWidget = null;
return;
} else if (this.currentWidget instanceof AggregateField) {
((AggregateField)this.currentWidget).combineFields();
} else if (this.currentWidget instanceof Repeater.RepeaterRow) {
id = ITEM;
} else if (this.currentWidget instanceof MultiValueField &&
loc.equals(ITEM)) {
this.isMultiValueItem = false;
return;
}
if (loc.equals(id))
this.currentWidget = this.currentWidget.getParent();
else
throw new SAXException("Unexpected element, was: " + loc +
" expected: " + id);
}
/**
* Receive notification of character data.
*
* @param ch The characters from the XML document.
* @param start The start position in the array.
* @param len The number of characters to read from the array.
*/
public void characters(char ch[], int start, int len)
throws SAXException {
String input = new String(ch, start, len);
if ("".equals(input.trim()))
return;
if (this.currentWidget instanceof DataWidget) {
DataWidget data = (DataWidget)this.currentWidget;
Datatype type = data.getDatatype();
ConversionResult conv =
type.convertFromString(input, this.locale);
if (conv.isSuccessful()) {
data.setValue(conv.getResult());
} else
throw new SAXException("Could not convert: " + input +
" to " + type.getTypeClass());
} else if (this.currentWidget instanceof BooleanField) {
// FIXME: BooleanField should implement DataWidget, which
// would make this case unnesecary
if ("true".equals(input))
this.currentWidget.setValue(Boolean.TRUE);
else if ("false".equals(input))
this.currentWidget.setValue(Boolean.FALSE);
else
throw new SAXException("Unkown boolean: " + input);
} else if (this.currentWidget instanceof MultiValueField &&
isMultiValueItem) {
MultiValueField field = (MultiValueField)this.currentWidget;
Datatype type = field.getDatatype();
ConversionResult conv =
type.convertFromString(input, this.locale);
if (conv.isSuccessful()) {
Object[] values = (Object[])field.getValue();
int valLen = values == null ? 0 : values.length;
Object[] newValues = new Object[valLen + 1];
for (int i = 0; i < valLen; i++)
newValues[i] = values[i];
newValues[valLen] = conv.getResult();
field.setValues(newValues);
} else
throw new SAXException("Could not convert: " + input +
" to " + type.getTypeClass());
} else
throw new SAXException("Unknown widget type: " +
this.currentWidget);
}
/* ================ Widget -> SAX ================ */
/*
* Just recurses in deep first order over the widget hierarchy and
* emits XML
*/
/**
* Generates SAX events representing the object's state.
*/
public void toSAX( ContentHandler handler ) throws SAXException {
this.contentHandler = handler;
this.contentHandler.startDocument();
this.contentHandler.startPrefixMapping(PREFIX, URI);
generateSAX(this.widget);
this.contentHandler.endPrefixMapping(PREFIX);
this.contentHandler.endDocument();
}
/**
* Generate XML data.
*/
private void generateSAX(Widget widget)
throws SAXException {
generateSAX(widget, null);
}
private void generateSAX(Widget widget, String id)
throws SAXException {
// no XML output for actions
if (widget instanceof Action)
return;
if (id == null)
id = widget.getId() == "" ? UNKNOWN : widget.getId();
final AttributesImpl attr = new AttributesImpl();
if (widget instanceof Repeater.RepeaterRow)
attribute(attr, POSITION, widget.getId());
start(id, attr);
// Placing the handling DataWidget before ContainerWidget
// means that an AggregateField is handled like a DataWidget
if (widget instanceof DataWidget) {
Datatype datatype = ((DataWidget)widget).getDatatype();
if (widget.getValue() != null)
data(datatype.convertToString(widget.getValue(),
this.locale));
} else if (widget instanceof BooleanField) {
// FIXME: BooleanField should implement DataWidget, which
// would make this case unnesecary
if (widget.getValue() != null)
data((Boolean)widget.getValue() == Boolean.TRUE ? "true" :
"false");
} else if (widget instanceof MultiValueField) {
Datatype datatype = ((MultiValueField)widget).getDatatype();
Object[] values = (Object[])widget.getValue();
if (values != null)
for (int i = 0; i < values.length; i++) {
start(ITEM, attr);
data(datatype.convertToString(values[i], this.locale));
end(ITEM);
}
} else if (widget instanceof ContainerWidget) {
Iterator children = ((ContainerWidget)widget).getChildren();
while (children.hasNext())
generateSAX((Widget)children.next());
} else if (widget instanceof Repeater) {
Repeater repeater = (Repeater)widget;
for (int i = 0; i < repeater.getSize(); i++)
generateSAX(repeater.getRow(i), ITEM);
}
end(id);
}
private void attribute(AttributesImpl attr, String name, String value) {
attr.addAttribute("", name, name, "CDATA", value);
}
private void start(String name, AttributesImpl attr)
throws SAXException {
String qName = PREFIX == "" ? name : PREFIX + ":" + name;
this.contentHandler.startElement(URI, name, qName, attr);
attr.clear();
}
private void end(String name)
throws SAXException {
String qName = PREFIX == "" ? name : PREFIX + ":" + name;
this.contentHandler.endElement(URI, name, qName);
}
private void data(String data)
throws SAXException {
this.contentHandler.characters(data.toCharArray(), 0, data.length());
}
}
1.9 +18 -0 cocoon-2.1/src/blocks/forms/samples/sitemap.xmap
Index: sitemap.xmap
===================================================================
RCS file: /home/cvs/cocoon-2.1/src/blocks/forms/samples/sitemap.xmap,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- sitemap.xmap 6 May 2004 14:23:04 -0000 1.8
+++ sitemap.xmap 8 Jun 2004 15:40:08 -0000 1.9
@@ -208,6 +208,14 @@
</map:call>
</map:match>
+ <map:match pattern="form2simpleXML.flow">
+ <map:call function="handleForm">
+ <map:parameter name="function" value="form2simpleXML"/>
+ <map:parameter name="form-definition"
value="forms/form2_model.xml"/>
+ <map:parameter name="documentURI"
value="forms/form2_simple_data.xml"/>
+ </map:call>
+ </map:match>
+
<map:match pattern="form2bean.flow">
<map:call function="handleForm">
<map:parameter name="function" value="form2bean"/>
@@ -216,11 +224,21 @@
</map:call>
</map:match>
+ <map:match pattern="forms/form2_simple_data.xml">
+ <map:generate src="forms/form2_simple_data.xml"/>
+ <map:serialize type="xml"/>
+ </map:match>
+
<map:match pattern="form2-success-pipeline">
<map:generate src="forms/form2_data-result.xml"/>
<map:transform type="i18n">
<map:parameter name="locale" value="en-US"/>
</map:transform>
+ <map:serialize type="xml"/>
+ </map:match>
+
+ <map:match pattern="form2simpleXML-success-pipeline">
+ <map:generate type="jx" src="forms/form2simpleXML_result.xml"/>
<map:serialize type="xml"/>
</map:match>
1.10 +3 -2 cocoon-2.1/src/blocks/forms/samples/welcome.xml
Index: welcome.xml
===================================================================
RCS file: /home/cvs/cocoon-2.1/src/blocks/forms/samples/welcome.xml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- welcome.xml 11 May 2004 12:01:38 -0000 1.9
+++ welcome.xml 8 Jun 2004 15:40:08 -0000 1.10
@@ -47,9 +47,10 @@
Cocoon Forms has a binding framework which assists in copying Java-bean
or XML (DOM) data into a form and back.
</note>
<sample name="XML Binding" href="form2xml.flow">A form for just editing an
XML file.</sample>
+ <sample name="Simple XML Binding" href="form2simpleXML.flow">A form for
just editing XML data. Illustrates the XMLAdapter.</sample>
<sample name="Bean Binding" href="form2bean.flow">A form for just editing
a Java bean</sample>
<note>
- Step-by-step tutorial into individual binding features:
+ Step-by-step tutorial into individual binding features:
</note>
<sample name="1. Binding Simple Values"
href="binding-01value.flow">fb:*/@direction and fb:value/*</sample>
<sample name="2. Lenient Binding"
href="binding-02lenient.flow">fb:*/@lenient</sample>
1.3 +20 -0
cocoon-2.1/src/blocks/forms/samples/flow/binding_example.js
Index: binding_example.js
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/forms/samples/flow/binding_example.js,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- binding_example.js 11 Mar 2004 02:56:33 -0000 1.2
+++ binding_example.js 8 Jun 2004 15:40:08 -0000 1.3
@@ -46,6 +46,26 @@
cocoon.sendPage("form2-success-pipeline");
}
+function form2simpleXML(form) {
+ // get the documentURI parameter from the sitemap which contains the
+ // location of the file to be edited
+ var documentURI = cocoon.parameters["documentURI"];
+
+ // get the XML adapter
+ var xmlAdapter = form.getXML();
+
+ // parse the document to a widget tree
+ var pipeUtil =
+
cocoon.createObject(Packages.org.apache.cocoon.components.flow.util.PipelineUtil);
+ pipeUtil.processToSAX(documentURI, null, xmlAdapter);
+
+ // show the form to the user until it is validated successfully
+ form.showForm("form2-display-pipeline");
+
+ // show the xml generated from the form
+ cocoon.sendPage("form2simpleXML-success-pipeline", xmlAdapter);
+}
+
// bean variant of the binding sample
function form2bean(form) {
var bean = new Packages.org.apache.cocoon.forms.samples.Form2Bean();
1.3 +1 -0 cocoon-2.1/src/blocks/forms/samples/forms/form2_model.xml
Index: form2_model.xml
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/forms/samples/forms/form2_model.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- form2_model.xml 5 Apr 2004 12:25:29 -0000 1.2
+++ form2_model.xml 8 Jun 2004 15:40:08 -0000 1.3
@@ -15,6 +15,7 @@
limitations under the License.
-->
<fd:form
+ id="data"
xmlns:fd="http://apache.org/cocoon/forms/1.0#definition";
xmlns:i18n="http://apache.org/cocoon/i18n/2.1";>
1.1
cocoon-2.1/src/blocks/forms/samples/forms/form2_simple_data.xml
Index: form2_simple_data.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright 1999-2004 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<data>
<email>[EMAIL PROTECTED]</email>
<phone>+32-2-2222222</phone>
<ipaddress>10.34.44.78</ipaddress>
<birthday>10/04/1960</birthday>
<number>3</number>
<choose>true</choose>
<drinks>
<item>Jupiler</item>
<item>Hoegaarden</item>
</drinks>
<contacts>
<item>
<firstname>Lucien</firstname>
<lastname>Vandevelde</lastname>
<phone>+32-2-2222222</phone>
<email>[EMAIL PROTECTED]</email>
</item>
<item>
<firstname>Joris</firstname>
<lastname>Veldweghel</lastname>
<phone>+32-59-595959</phone>
<email>[EMAIL PROTECTED]</email>
</item>
</contacts>
</data>
1.1
cocoon-2.1/src/blocks/forms/samples/forms/form2simpleXML_result.xml
Index: form2simpleXML_result.xml
===================================================================
<?xml version="1.0"?>
<jx:template xmlns:jx="http://apache.org/cocoon/templates/jx/1.0";>
<jx:out value="#{.}"/>
</jx:template>
