Apache » Cocoon »

The Apache Cocoon Project

# Cocoon Forms 1.0

- Cocoon 2.2
- Core 2.2
- Blocks 2.2
- Maven Plugins 2.2
- Subprojects

# Simple XML Binding

# Concept

As an alternative for the more flexible binding framework, there is also a simpler solution that can be used when there is a 1-to-1 coupling between the XML and the form.

The XML format is such that there is one XML element for each widget and the element gets the widget id as name. Exceptions from this are that the elements in a repeater get the name "item" and an attribute "position" with the position of the repeater child, instead of just a number (which is not allowed as element name). Childs of a MultiValueField are also embedded within an "item" element. If the Form widget does not have an id it gets the name "unknown".

An AggregateField can both be interpreted as one value and as several widgets. This ambiguity is resolved by choosing to emit the single value rather than the fields as XML. For population of the form both forms are however allowed.

# Usage

The simple XML binding is implemented by the following class:

    org.apache.cocoon.forms.util.XMLAdapter

To load XML, you simply construct an XMLAdapter with a form instance as argument to the constructor. You can then load XML into the form simply by using the XMLAdapter as a ContentHandler for the XML parser, and save the XML by using the toSAX method on the XMLAdapter object.

In the flowscript CForm API, the form object has a `getXML()` method that returns an XMLAdapter instance. But more simply, there are also `form.loadXML(uri)` and `form.saveXML(uri)` methods.

Errors and Improvements? If you see any errors or potential improvements in this document please help us: View, Edit or comment on the latest development version (registration required).