Package XSLForms :: Module Fields
[show private | hide private]
[frames | no frames]

Module XSLForms.Fields

Interpretation of field collections from sources such as HTTP request parameter
dictionaries.

Copyright (C) 2005, 2006, 2007 Paul Boddie <paul@boddie.org.uk>

This program is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the Free
Software Foundation; either version 3 of the License, or (at your option) any
later version.

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
details.

You should have received a copy of the GNU Lesser General Public License along
with this program.  If not, see <http://www.gnu.org/licenses/>.

--------

Classes which process field collections, producing instance documents. Each
field entry consists of a field name mapped to a string value, where the field
name may have the following formats:

    /name1$n1/name2
    /name1$n1/name2$n2/name3
    /name1$n1/name2$n2/name3$n3/name4
    ...

The indexes n1, n2, n3, ... indicate the position of elements (starting from 1)
in the entire element list, whose elements may have different names. For
example:

    /zoo$1/name
    /zoo$1/cage$1/name
    /zoo$1/cage$2/name
    /zoo$1/funding$3/contributor$1/name

Where multiple values can be collected for a given field, the following notation
is employed:

    /package$1/categories$1/category$$value

Some fields may contain the "=" string. This string is reserved and all text
following it is meant to specify a path into a particular document. For example:

    _action_add_animal=/zoo$1/cage$2

Classes
FieldProcessor A class which converts fields in the documented form to XML instance documents.
Fields A class which converts fields in the documented form to XML instance documents.
Form A collection of documents processed from form fields.

Exceptions
FieldsError  

Generated by Epydoc 2.1 on Tue Sep 18 23:43:25 2007 http://epydoc.sf.net