DbDom


DbDom API DbDom 4ODS API Application Programming Interface for DbDom.

The DbDom API

The main interfaces in DbDom are thos of the Document Object Module. This document will only cover the extensions.

Module Ft.DbDom

A persistent DOM implementation

Module Summary

Command Line

Command Line Executeable initDomDb

Initialize a DbDom 4ODS database

initDomDb connect_string [odlFile]
Argument Summary
connect_string The 4ODS connection string with the name of the database (required)
odlFile The installed location of dom.odl. Defaults to the directory that DbDom was installed too.

Command Line Executeable addDbDomDocument

Add a document to a DbDom database.

addDbDomDocument connect_string document_name  < xmlFile
Argument Summary
connect_string The 4ODS connection string with the name of the database (required)
document_name The name to bind this new document too. (required)
< xmlFile The XML source. (required)

Command Line Executeable transformDbDom

Apply a stylesheet to a document in the DbDom database.

transformDbDom connect_string document_name xslFileName
Argument Summary
connect_string The 4ODS connection string with the name of the database (required)
document_name The bound name of the document. (required)
xslFileName The file name of the XSLT document. (required)

Classes

Class Summary
Reader A class supporting the DOM reader interface for loading a XML stream into a DbDom.

Class Reader

A class supporting the DOM reader interface for loading a XML stream into a DbDom.

Method Summary
fromStream Create a new Document object from a XML stream.
fromString  Create a new Document object from a XML string.
fromUri  Create a new Document object from a URI.

Method Details

fromStream

fromStream(stream)

Create a new Document object from a XML stream.

Parameters
stream of type A standard python stream(file, socket, StringIO)

The stream to read from.

Return Value
None

fromString

fromString(string)

Create a new Document object from a XML string.

Parameters
string of type A string

The string of XML to be read from.

Return Value
None

fromUri

fromUri(uri)

Create a new Document object from a URI.

Parameters
uri of type A URI

A URI that references an XML resource to be read.

Return Value
None