blackboard.platform.plugin
Interface ContentHandlerXmlPersister

All Superinterfaces:

Persister

public interface ContentHandlerXmlPersister
extends Persister

ContentHandlerXmlPersister

Since:

Bb 6.3

Version:

$Revision: #1 $ $Date: 2005/06/27 $

Field Summary

static java.lang.String

TYPE Type used to obtain an instance of the class configured to provide the implementation for this interface.

Method Summary

org.w3c.dom.Element	persist(ContentHandler obj, org.w3c.dom.Document doc) Generates an Element tree whose values and structure matches the contents of the provided ContentHandler object.
org.w3c.dom.Element	persistList(BbList list, org.w3c.dom.Document doc) Generates an Element whose children are the provided ContentHandler objects persisted to XML.

Methods inherited from interface blackboard.persist.Persister

getAppVersion, init

Field Detail

TYPE

static final java.lang.String TYPE

Type used to obtain an instance of the class configured to provide the implementation for this interface. Used when making a call to BbPersistenceManager.getPersister(String)

See Also:

Constant Field Values

Method Detail

persist

org.w3c.dom.Element persist(ContentHandler obj,
                            org.w3c.dom.Document doc)
                            throws ValidationException,
                                   PersistenceException

Generates an Element tree whose values and structure matches the contents of the provided ContentHandler object.

Parameters:

obj - the ContentHandler we should generate the XML tree for.

doc - the Document we should use to create the Element with. No assumptions should be made concerning the state of this Document -- it should only be used for Element creation.

Returns:

an Element that matches the contents of this ContentHandler object

Throws:

ValidationException - thrown if the provided ContentHandler is not in a proper condition for persisting.

PersistenceException - thrown if an error occurs in the element writing process.

persistList

org.w3c.dom.Element persistList(BbList list,
                                org.w3c.dom.Document doc)
                                throws ValidationException,
                                       PersistenceException

Generates an Element whose children are the provided ContentHandler objects persisted to XML.

Parameters:

list - the BbList of ContentHandler objects we should persist.

doc - the Document we should use to create the Element with. No assumptions should be made concerning the state of this Document -- it should only be used for Element creation.

Returns:

an Element that is the root of a list of ContentHandler object XML

Throws:

ValidationException - thrown if one of the provided ContentHandler objects is not in a proper condition for persisting.

PersistenceException - thrown if an error occurs in the element writing process.