org.licas_xml.abs

Class Document

java.lang.Object

org.licas_xml.abs.Document

Direct Known Subclasses:

DocumentImpl

public abstract class Document
extends java.lang.Object

This class describes the functionality required by an XML document.

Author:

Kieran Greer

Field Summary

Fields

Modifier and Type	Field and Description
protected Element	rootElem The root element of any parsed document

Constructor Summary

Constructors

Constructor and Description
Document() Create a new instance of DocumentImpl.

Method Summary

Modifier and Type	Method and Description
abstract Element	getRootElement() Get the root element of the document.
protected abstract void	initialise() Initialise some values.
abstract Element	parse(java.io.InputStream xmlStream) Parse the String-based xml stream and return the root element.
abstract Element	parse(java.lang.String xmlStream) Parse the String-based xml stream and return the root element.
abstract void	setRootElement(Element theRootElement) Set the root element value of the document.

Methods inherited from class java.lang.Object

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

Field Detail

rootElem

protected Element rootElem

The root element of any parsed document

Constructor Detail

Document

public Document()
         throws java.lang.Exception

Create a new instance of DocumentImpl.

Throws:

java.lang.Exception - any error.

Method Detail

initialise

protected abstract void initialise()
                            throws java.lang.Exception

Initialise some values.

Throws:

java.lang.Exception - any error.

parse

public abstract Element parse(java.lang.String xmlStream)
                       throws java.lang.Exception

Parse the String-based xml stream and return the root element.

Parameters:

xmlStream - the XML description in String format.

Returns:

the root element of the parsed document model.

Throws:

java.lang.Exception - any error.

parse

public abstract Element parse(java.io.InputStream xmlStream)
                       throws java.lang.Exception

Parse the String-based xml stream and return the root element.

Parameters:

xmlStream - the input stream, for example, a file.

Returns:

the root element of the parsed document model.

Throws:

java.lang.Exception - any error.

setRootElement

public abstract void setRootElement(Element theRootElement)

Set the root element value of the document.

Parameters:

theRootElement - the root element.

getRootElement

public abstract Element getRootElement()

Get the root element of the document.

Returns:

the value of rootElem.