XSLForms.Fields.FieldProcessor

Package XSLForms :: Module Fields :: Class FieldProcessor

[show private | hide private]

Class FieldProcessor

Known Subclasses:: Form

A class which converts fields in the documented form to XML instance documents.

Method Summary
	`__init__(self, encoding, values_are_lists)` Initialise the fields processor with the given 'encoding', which is optional and which only applies to field data in Python string form (and not Unicode objects).
	`complete_documents(self, documents, fields)` Complete the given 'documents' using the 'fields' items list.
	`complete_selectors(self, selectors, fields, documents)` Fill in the given 'selectors' dictionary using the given 'fields' so that it contains mappings from selector names to parts of the specified 'documents'.
	`get_selectors(self, fields, documents)` Get a dictionary containing a mapping of selector names to selected parts of the given 'documents'.
	`make_documents(self, fields)` Make a dictionary mapping model names to new documents prepared from the given 'fields' dictionary.
	`new_document(self, name)` Return an instance root of the given 'name' in a new document.
	`new_instance(self, name)` Return an instance root of the given 'name' in a new document.

Method Details

init(self, encoding='utf-8', values_are_lists=0)
(Constructor)

Initialise the fields processor with the given 'encoding', which is optional and which only applies to field data in Python string form (and not Unicode objects).

If the optional 'values_are_lists' parameter is set to true then each actual field value will be obtained by taking the first element from each supplied field value.

complete_documents(self, documents, fields)

Complete the given 'documents' using the 'fields' items list.

complete_selectors(self, selectors, fields, documents)

Fill in the given 'selectors' dictionary using the given 'fields' so that it contains mappings from selector names to parts of the specified 'documents'.

get_selectors(self, fields, documents)

Get a dictionary containing a mapping of selector names to selected parts of the given 'documents'.

make_documents(self, fields)

Make a dictionary mapping model names to new documents prepared from the given 'fields' dictionary.

new_document(self, name)

Return an instance root of the given 'name' in a new document.

new_instance(self, name)