blackboard.platform.plugin
Interface ContentHandlerXmlLoader

All Superinterfaces:

Loader

public interface ContentHandlerXmlLoader
extends Loader

ContentHandlerXmlLoader

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

ContentHandler	load(org.w3c.dom.Element rootElement) Generates a ContentHandler object given an Element tree whose structure and contents match those generated by ContentHandlerXmlPerister.
ContentHandler	load(java.io.InputStream is) Generates a ContentHandler object given an InputStream which contains XML whose structure and contents match those generated by ContentHandlerXmlPerister.
BbList	loadList(org.w3c.dom.Element rootElement) Generates a BbList of ContentHandler objects from the Element tree provided.
BbList	loadList(java.io.InputStream is) Generates a BbList of ContentHandler objects from the InputStream provided.

Methods inherited from interface blackboard.persist.Loader

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.getLoader(String)

See Also:

Constant Field Values

Method Detail

load

ContentHandler load(org.w3c.dom.Element rootElement)
                    throws java.lang.IllegalArgumentException,
                           PersistenceException

Generates a ContentHandler object given an Element tree whose structure and contents match those generated by ContentHandlerXmlPerister.

Parameters:

rootElement - the root Element of a valid ContentHandler XML tree that should be transformed.

Returns:

a ContentHandler whose contents match those of the Element tree provided.

Throws:

java.lang.IllegalArgumentException - thrown if the provided Element is not the root of a valid ContentHandler XML tree.

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

load

ContentHandler load(java.io.InputStream is)
                    throws java.lang.IllegalArgumentException,
                           PersistenceException

Generates a ContentHandler object given an InputStream which contains XML whose structure and contents match those generated by ContentHandlerXmlPerister.

Parameters:

is - the InputStream containing the XML to load the course navigation item from

Returns:

a ContentHandler whose contents match those of the XML contained within the provided stream.

Throws:

java.lang.IllegalArgumentException - thrown if the provided stream does not contain a valid ContentHandler XML tree.

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

loadList

BbList loadList(org.w3c.dom.Element rootElement)
                throws java.lang.IllegalArgumentException,
                       PersistenceException

Generates a BbList of ContentHandler objects from the Element tree provided.

Parameters:

rootElement - the root Element of a valid list of ContentHandler XML trees that should be transformed.

Returns:

a BbList of ContentHandler objects from the tree provided

Throws:

java.lang.IllegalArgumentException - thrown if the provided Element is not the root of a valid list of course navigation items

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

loadList

BbList loadList(java.io.InputStream is)
                throws java.lang.IllegalArgumentException,
                       PersistenceException

Generates a BbList of ContentHandler objects from the InputStream provided.

Parameters:

is - the InputStream containing the XML to load the course navigation items list from

Returns:

a BbList of ContentHandler objects from the tree provided

Throws:

java.lang.IllegalArgumentException - thrown if the provided stream is not the root of a valid list of course navigation items

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