org.vast.xml

Class XMLDocument

java.lang.Object

org.vast.xml.XMLDocument

public class XMLDocument
extends Object

TODO XMLDocument type description

Since:

Nov 3, 2005

Author:

Alex Robin

Field Summary

Fields

Modifier and Type	Field and Description
protected Document	domDocument w3c.Document object
protected static DOMImplementation	domImpl
protected Map<String,Element>	identifiers map linking each (local) ID (String) to an Element (w3c.Element)
protected Map<String,String>	nsPrefixToUri map linking NS Prefix (String) to a NS URI (String)
protected Map<String,String>	nsUriToPrefix map linking NS URI (String) to a NS prefix (String)
protected URI	uri document URI

Constructor Summary

Constructors

Constructor and Description
XMLDocument()
XMLDocument(Document doc)
XMLDocument(InputStream inputStream, boolean validate)
XMLDocument(InputStream inputStream, boolean validate, Map<String,String> schemaLocations)
XMLDocument(org.vast.xml.QName qname)

Method Summary

Methods

Modifier and Type	Method and Description
void	addId(String id, Element elt) Adds a pair identifier/node in the list
void	addNS(String prefix, String uri) Adds mapping from uri to prefix and prefix to uri for further lookups
Document	getDocument() Get the dom document object
Element	getDocumentElement() Get this dom document root element
Element	getElementByID(String id) Retrieve a node from the unique ID
String	getNSPrefix(String nsUri) Retrieve a namespace prefix for this document
Map<String,String>	getNSTable() Retrieves the namespace table
String	getNSUri(String nsPrefix) Retrieves the namespace uri matching the given prefix
URI	getUri()
protected Document	parseDOM_JAXP(InputStream inputStream, boolean validate, Map<String,String> schemaLocations)
protected Document	parseDOM_LS(InputStream inputStream, boolean validate, Map<String,String> schemaLocations)
protected Document	parseDOM(InputStream inputStream, boolean validate, Map<String,String> schemaLocations) Parse DOM from given input stream
void	readIdentifiers(Element elt, boolean recursive) This function looks and stores all identifiers attributes found in the document This adds every id it founds to the corresponding hashtable in the given XMLDocument This is called recursively for each child node
void	readNamespaces(Element elt, boolean recursive) Reads all the namespace prefix:domain pairs and store them in the hashtable of the XMLDocument
void	serialize(Node node, OutputStream out, boolean pretty) Helper method to serialize this DOM to a stream
protected void	serializeDOM_JAXP(Element elt, OutputStream out, boolean pretty)
protected void	serializeDOM_LS(Element elt, OutputStream out, boolean pretty)
void	setUri(URI uri)

Methods inherited from class java.lang.Object

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

Field Detail

domImpl

protected static DOMImplementation domImpl

uri

protected URI uri

document URI

domDocument

protected Document domDocument

w3c.Document object

identifiers

protected Map<String,Element> identifiers

map linking each (local) ID (String) to an Element (w3c.Element)

nsUriToPrefix

protected Map<String,String> nsUriToPrefix

map linking NS URI (String) to a NS prefix (String)

nsPrefixToUri

protected Map<String,String> nsPrefixToUri

map linking NS Prefix (String) to a NS URI (String)

Constructor Detail

XMLDocument

public XMLDocument()

XMLDocument

public XMLDocument(org.vast.xml.QName qname)

XMLDocument

public XMLDocument(Document doc)

XMLDocument

public XMLDocument(InputStream inputStream,
           boolean validate)
            throws DOMHelperException

Throws:

DOMHelperException

XMLDocument

public XMLDocument(InputStream inputStream,
           boolean validate,
           Map<String,String> schemaLocations)
            throws DOMHelperException

Throws:

DOMHelperException

Method Detail

addId

public void addId(String id,
         Element elt)

Adds a pair identifier/node in the list

Parameters:

id - XML Identifier

elt - XML Node

addNS

public void addNS(String prefix,
         String uri)

Adds mapping from uri to prefix and prefix to uri for further lookups

Parameters:

prefix -

uri -

getElementByID

public Element getElementByID(String id)
                       throws DOMHelperException

Retrieve a node from the unique ID

Parameters:

id - Node identifier

Returns:

the corresponding Node object

Throws:

DOMHelperException - if no node with the given ID belongs to the document

getNSPrefix

public String getNSPrefix(String nsUri)

Retrieve a namespace prefix for this document

Parameters:

nsUri - namespace domain uri

Returns:

the prefix string or null if not found

getNSUri

public String getNSUri(String nsPrefix)

Retrieves the namespace uri matching the given prefix

Parameters:

nsPrefix - namespace prefix string

Returns:

the uri or null if not found

getNSTable

public Map<String,String> getNSTable()

Retrieves the namespace table

Returns:

map of namespace prefix to URI

getDocument

public Document getDocument()

Get the dom document object

Returns:

Document object

getDocumentElement

public Element getDocumentElement()

Get this dom document root element

Returns:

Element

getUri

public URI getUri()

Returns:

Returns the base uri of the document.

setUri

public void setUri(URI uri)

Parameters:

uri - The uri to set as base uri for this document.

parseDOM

protected Document parseDOM(InputStream inputStream,
                boolean validate,
                Map<String,String> schemaLocations)
                     throws DOMHelperException

Parse DOM from given input stream

Parameters:

inputSource - Stream containing XML file we want to parse

validation - boolean if true force the validation process with the schema

Returns:

The XMLDocument object created

Throws:

DOMHelperException - if a problem occur during parsing

parseDOM_LS

protected Document parseDOM_LS(InputStream inputStream,
                   boolean validate,
                   Map<String,String> schemaLocations)
                        throws Exception

Throws:

Exception

parseDOM_JAXP

protected Document parseDOM_JAXP(InputStream inputStream,
                     boolean validate,
                     Map<String,String> schemaLocations)
                          throws Exception

Throws:

Exception

serialize

public void serialize(Node node,
             OutputStream out,
             boolean pretty)
               throws IOException

Helper method to serialize this DOM to a stream

Parameters:

node -

out -

pretty - set to true to indent output

Throws:

IOException

serializeDOM_LS

protected void serializeDOM_LS(Element elt,
                   OutputStream out,
                   boolean pretty)
                        throws Exception

Throws:

Exception

serializeDOM_JAXP

protected void serializeDOM_JAXP(Element elt,
                     OutputStream out,
                     boolean pretty)
                          throws Exception

Throws:

Exception

readIdentifiers

public void readIdentifiers(Element elt,
                   boolean recursive)

This function looks and stores all identifiers attributes found in the document

This adds every id it founds to the corresponding hashtable in the given XMLDocument

This is called recursively for each child node

Parameters:

elt - the DOM element where to start the search

recursive - if true, all children elements are also processed recursively

readNamespaces

public void readNamespaces(Element elt,
                  boolean recursive)

Reads all the namespace prefix:domain pairs and store them in the hashtable of the XMLDocument

Parameters:

elt - the DOM element where to start the search

recursive - if true, all children elements are also processed recursively