blackboard.persist.user
Interface UserXmlLoader

All Superinterfaces:

Loader

public interface UserXmlLoader

extends Loader

UserXmlLoader

Since:

Bb 6.0

Version:

$Revision: 5 $ $Date: 4/18/03 11:27a $

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

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

Methods inherited from interface blackboard.persist.Loader

getAppVersion, init

Field Detail

TYPE

public 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

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

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

Parameters:

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

Returns:

a User whose contents matches those of the Element tree provided.

Throws:

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

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

load

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

Generates an User object given an InputStream which contains XML whose structure and contents match those generated by UserXmlPerister.

Parameters:

is - the InputStream containing the XML to load the user from

Returns:

a User whose contents matches those of the XML contained within the provided stream.

Throws:

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

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

loadList

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

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

Parameters:

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

Returns:

a BbList of User objects from the tree provided

Throws:

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

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

loadList

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

Generates a BbList of User objects from the InputStream provided.

Parameters:

is - the InputStream containing the XML to load the users list from

Returns:

a BbList of User objects from the tree provided

Throws:

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

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