edu.gvsu.kurmasz.zawilinski

Class MediaWikiLoader

java.lang.Object

edu.gvsu.kurmasz.zawilinski.MediaWikiLoader

public class MediaWikiLoader
extends Object

Generate the DOM for a MediaWiki XML document. In particular, this class uses JAXB to unmarshall an XML stream into Java objects. This class is written specifically to support MediaWiki XML documents only because it expects the root of the DOM to be a MediaWikiType object.

Debug levels used:

• PARSE_BEGIN_END: Announce beginning and end of parsing

Author:

Zachary Kurmas

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MediaWikiLoader.XMLConfigurationException Exception describing a problem with the XML software setup.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTEXT_PATH Name of package containing schema-derived classes (i.e., the classes that correspond to each element in the MediaWiki schema).

Method Summary

Modifier and Type	Method and Description
static Unmarshaller	createUnmarshaller() Create a JAXB Unmarshaller for documents using the current MediaWiki schema.
static JAXBElement<MediaWikiType>	load(InputStream input, edu.gvsu.kurmasz.warszawa.log.Log log) Loads the entire XML document and returns a JAXBElement<MediaWikiType> object representing the root.
static JAXBElement<MediaWikiType>	load(Source source, edu.gvsu.kurmasz.warszawa.log.Log log) Loads the entire XML document and returns a JAXBElement<MediaWikiType> object representing the root.
static JAXBElement<MediaWikiType>	load(Source source, edu.gvsu.kurmasz.warszawa.log.SimpleLog log, Unmarshaller unmarshaller) Loads the entire XML document and returns a JAXBElement<MediaWikiType> object representing the root.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONTEXT_PATH

public static final String CONTEXT_PATH

Name of package containing schema-derived classes (i.e., the classes that correspond to each element in the MediaWiki schema).

See Also:

Constant Field Values

Method Detail

createUnmarshaller

public static Unmarshaller createUnmarshaller()

Create a JAXB Unmarshaller for documents using the current MediaWiki schema.

Returns:

a JAXB Unmarshaller for documents using the current MediaWiki schema.

Throws:

MediaWikiLoader.XMLConfigurationException - if there is a problem creating the JAXB context

load

public static JAXBElement<MediaWikiType> load(Source source,
                                              edu.gvsu.kurmasz.warszawa.log.SimpleLog log,
                                              Unmarshaller unmarshaller)
                                       throws JAXBException

Loads the entire XML document and returns a JAXBElement<MediaWikiType> object representing the root.

Parameters:

source - the source of the XML data

log - a Log to which to report progress

unmarshaller - the JAXB Unmarshaller

Returns:

a JAXBElement<MediaWikiType> object representing the root of the loaded XML document.

Throws:

JAXBException - if there is a problem generating the DOM

IllegalArgumentException - if any parameters are null

load

public static JAXBElement<MediaWikiType> load(Source source,
                                              edu.gvsu.kurmasz.warszawa.log.Log log)
                                       throws JAXBException

Loads the entire XML document and returns a JAXBElement<MediaWikiType> object representing the root.

Parameters:

source - the source of the XML data

log - a Log to which to report progress

Returns:

a JAXBElement<MediaWikiType> object representing the root of the loaded XML document.

Throws:

JAXBException - if there is a problem generating the DOM

MediaWikiLoader.XMLConfigurationException - if there is a problem creating the JAXB context

IllegalArgumentException - if any parameters are null

load

public static JAXBElement<MediaWikiType> load(InputStream input,
                                              edu.gvsu.kurmasz.warszawa.log.Log log)
                                       throws JAXBException

Loads the entire XML document and returns a JAXBElement<MediaWikiType> object representing the root.

Parameters:

input - the source of the XML data

log - a Log to which to report progress

Returns:

a JAXBElement<MediaWikiType> object representing the root of the loaded XML document.

Throws:

JAXBException - if there is a problem generating the DOM

MediaWikiLoader.XMLConfigurationException - if there is a problem creating the JAXB context

IllegalArgumentException - if any parameters are null