org.licas_xml.model

Class DocumentImpl

java.lang.Object

org.licas_xml.abs.Document

org.licas_xml.model.DocumentImpl

public class DocumentImpl
extends Document

This class extends an XML document's functionality over a lighter version.

Author:

Kieran Greer

Field Summary

Fields

Modifier and Type	Field and Description
protected net.n3.nanoxml.IXMLParser	parser The parser to parse the XML stream

Fields inherited from class org.licas_xml.abs.Document

rootElem

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	convertSymbols(java.lang.String xmlStream) Can be some symbol clashes tht need to be corrected first.
Element	getRootElement() Get the root element of the document.
protected void	initialise() Initialise some values.
Element	parse(java.io.InputStream xmlStream) Parse the String-based xml stream and return the root element.
Element	parse(java.lang.String xmlStream) Parse the String-based xml stream and return the root element.
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

parser

protected net.n3.nanoxml.IXMLParser parser

The parser to parse the XML stream

Constructor Detail

DocumentImpl

public DocumentImpl()
             throws java.lang.Exception

Create a new instance of DocumentImpl.

Throws:

java.lang.Exception - any error.

Method Detail

initialise

protected void initialise()
                   throws java.lang.Exception

Initialise some values.

Specified by:

initialise in class Document

Throws:

java.lang.Exception - any error.

parse

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

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

Specified by:

parse in class Document

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 Element parse(java.io.InputStream xmlStream)
              throws java.lang.Exception

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

Specified by:

parse in class Document

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 void setRootElement(Element theRootElement)

Set the root element value of the document.

Specified by:

setRootElement in class Document

Parameters:

theRootElement - the root element.

getRootElement

public Element getRootElement()

Get the root element of the document.

Specified by:

getRootElement in class Document

Returns:

the value of rootElem.

convertSymbols

protected java.lang.String convertSymbols(java.lang.String xmlStream)

Can be some symbol clashes tht need to be corrected first.

Parameters:

xmlStream - the XML description in String format.

Returns:

the same string with some symbols converted.