uk.ac.ed.epcc.webapp.editors.xml

Class DomWalker

java.lang.Object

uk.ac.ed.epcc.webapp.editors.xml.DomWalker

All Implemented Interfaces:

org.xml.sax.ContentHandler, org.xml.sax.ErrorHandler, InfoProvider

public class DomWalker
extends java.lang.Object
implements org.xml.sax.ContentHandler, org.xml.sax.ErrorHandler, InfoProvider

This Class is responsible to building location paths to identify XML node. It operates in two distinct modes. Both modes are implemented in the same class to keep the dependency on the path syntax in one place. In DOM mode it walks a DOM tree building a location path (not an Xpath) for the Node objects it visits. and applies a DomVisitor to these nodes (this can also control if a node is recursed into). In SAX mode is operates as a ContentHandler and ErrorHandler it visits the entire tree building the path down to the element level and caches errors indexed by path. The form of the location path is the responsibility of this class. The actions performed are the responsibility of the DomVisitor.This allows different visitors to agree on the path locations. This allows the DomVisitor to build a GUI/HTML representation of the document. The controls on the document can then use a different visitor to follow the path to the desired node to implement a change.

Constructor Summary

Constructors

Constructor and Description
DomWalker()

Method Summary

Modifier and Type	Method and Description
void	addErrors(java.util.Map<java.util.LinkedList<java.lang.String>,java.util.Set<java.lang.String>> errors)
void	characters(char[] ch, int start, int length)
void	endDocument()
void	endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName)
void	endPrefixMapping(java.lang.String prefix)
void	error(org.xml.sax.SAXParseException e)
void	fatalError(org.xml.sax.SAXParseException exception)
java.util.Set<java.lang.String>	getError(java.util.LinkedList<java.lang.String> path)
java.util.Map<java.util.LinkedList<java.lang.String>,java.util.Set<java.lang.String>>	getErrors()
java.util.LinkedList<java.lang.String>	getPath()
org.w3c.dom.TypeInfo	getTypeInfo(java.util.LinkedList<java.lang.String> path)
java.util.Map<java.util.LinkedList<java.lang.String>,org.w3c.dom.TypeInfo>	getTypes()
void	ignorableWhitespace(char[] ch, int start, int length)
static boolean	isAttribute(java.lang.String element)
static boolean	isElment(java.lang.String element)
static boolean	isText(java.lang.String element)
void	processingInstruction(java.lang.String target, java.lang.String data)
void	setContentHandler(org.xml.sax.ContentHandler h)
void	setDocumentLocator(org.xml.sax.Locator locator)
void	setLogger(Logger log)
void	setPath(java.util.LinkedList<java.lang.String> sax_path)
void	skippedEntity(java.lang.String name)
void	startDocument()
void	startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts)
void	startPrefixMapping(java.lang.String prefix, java.lang.String uri)
void	visitElement(org.w3c.dom.Element e, DomVisitor vis)
void	visitElement(org.w3c.dom.Element e, java.util.LinkedList<java.lang.String> path, DomVisitor vis) Visit an Element in DOM mode.
void	warning(org.xml.sax.SAXParseException e)

Methods inherited from class java.lang.Object

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

Constructor Detail

DomWalker

public DomWalker()

Method Detail

setLogger

public void setLogger(Logger log)

setContentHandler

public void setContentHandler(org.xml.sax.ContentHandler h)

visitElement

public void visitElement(org.w3c.dom.Element e,
                         java.util.LinkedList<java.lang.String> path,
                         DomVisitor vis)

Visit an Element in DOM mode.

Parameters:

e -

path -

vis -

visitElement

public void visitElement(org.w3c.dom.Element e,
                         DomVisitor vis)

isText

public static boolean isText(java.lang.String element)

isElment

public static boolean isElment(java.lang.String element)

isAttribute

public static boolean isAttribute(java.lang.String element)

getPath

public java.util.LinkedList<java.lang.String> getPath()

setPath

public void setPath(java.util.LinkedList<java.lang.String> sax_path)

endElement

public void endElement(java.lang.String uri,
                       java.lang.String localName,
                       java.lang.String qName)
                throws org.xml.sax.SAXException

Specified by:

endElement in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

startElement

public void startElement(java.lang.String uri,
                         java.lang.String localName,
                         java.lang.String qName,
                         org.xml.sax.Attributes atts)
                  throws org.xml.sax.SAXException

Specified by:

startElement in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

addErrors

public void addErrors(java.util.Map<java.util.LinkedList<java.lang.String>,java.util.Set<java.lang.String>> errors)

getErrors

public java.util.Map<java.util.LinkedList<java.lang.String>,java.util.Set<java.lang.String>> getErrors()

Specified by:

getErrors in interface InfoProvider

getTypes

public java.util.Map<java.util.LinkedList<java.lang.String>,org.w3c.dom.TypeInfo> getTypes()

Specified by:

getTypes in interface InfoProvider

error

public void error(org.xml.sax.SAXParseException e)
           throws org.xml.sax.SAXException

Specified by:

error in interface org.xml.sax.ErrorHandler

Throws:

org.xml.sax.SAXException

warning

public void warning(org.xml.sax.SAXParseException e)
             throws org.xml.sax.SAXException

Specified by:

warning in interface org.xml.sax.ErrorHandler

Throws:

org.xml.sax.SAXException

fatalError

public void fatalError(org.xml.sax.SAXParseException exception)
                throws org.xml.sax.SAXException

Specified by:

fatalError in interface org.xml.sax.ErrorHandler

Throws:

org.xml.sax.SAXException

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws org.xml.sax.SAXException

Specified by:

characters in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

endDocument

public void endDocument()
                 throws org.xml.sax.SAXException

Specified by:

endDocument in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

endPrefixMapping

public void endPrefixMapping(java.lang.String prefix)
                      throws org.xml.sax.SAXException

Specified by:

endPrefixMapping in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
                                int start,
                                int length)
                         throws org.xml.sax.SAXException

Specified by:

ignorableWhitespace in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

processingInstruction

public void processingInstruction(java.lang.String target,
                                  java.lang.String data)
                           throws org.xml.sax.SAXException

Specified by:

processingInstruction in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

setDocumentLocator

public void setDocumentLocator(org.xml.sax.Locator locator)

Specified by:

setDocumentLocator in interface org.xml.sax.ContentHandler

skippedEntity

public void skippedEntity(java.lang.String name)
                   throws org.xml.sax.SAXException

Specified by:

skippedEntity in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

startDocument

public void startDocument()
                   throws org.xml.sax.SAXException

Specified by:

startDocument in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

startPrefixMapping

public void startPrefixMapping(java.lang.String prefix,
                               java.lang.String uri)
                        throws org.xml.sax.SAXException

Specified by:

startPrefixMapping in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

getError

public java.util.Set<java.lang.String> getError(java.util.LinkedList<java.lang.String> path)

Specified by:

getError in interface InfoProvider

getTypeInfo

public org.w3c.dom.TypeInfo getTypeInfo(java.util.LinkedList<java.lang.String> path)

Specified by:

getTypeInfo in interface InfoProvider