com.screenscraper.datamanager.xml

Class XmlReader

java.lang.Object

com.screenscraper.datamanager.xml.XmlReader

public class XmlReader
extends java.lang.Object

Helper methods for reading and generating DataNodes from an XML document

Field Summary

Fields

Modifier and Type	Field and Description
DataManager	dm

Constructor Summary

Constructors

Constructor and Description
XmlReader(DataManager dm)

Method Summary

Modifier and Type	Method and Description
DataNode	addDataNode(org.w3c.dom.Element ele) Adds a DataNode to the root node
DataNode	addDataNode(org.w3c.dom.Element ele, java.lang.String schema_identifier) Adds a DataNode to the root node
void	addDataToNode(DataNode node, org.w3c.dom.Element ele) Adds Data to an existing node from an element.
java.util.List<org.w3c.dom.Element>	getChildren(org.w3c.dom.Node node) Retrieves the child Elements
java.util.List<org.w3c.dom.Element>	getChildren(org.w3c.dom.Node node, java.lang.String name) Retrieves the child Elements with the given name
void	getId(org.w3c.dom.Element ele, DataNode n) This method will automatically add an id value to the node's schema if an id XML element exists in the element passed to it.
org.w3c.dom.Document	load(java.io.File file) Loads an XML document from a file

Methods inherited from class java.lang.Object

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

Field Detail

dm

public DataManager dm

Constructor Detail

XmlReader

public XmlReader(DataManager dm)

Method Detail

load

public org.w3c.dom.Document load(@NotNull
                                 java.io.File file)
                          throws java.io.IOException,
                                 javax.xml.parsers.ParserConfigurationException,
                                 org.xml.sax.SAXException,
                                 java.sql.SQLException

Loads an XML document from a file

Throws:

java.io.IOException

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.sql.SQLException

getChildren

@NotNull
public java.util.List<org.w3c.dom.Element> getChildren(@NotNull
                                                                 org.w3c.dom.Node node,
                                                                 java.lang.String name)

Retrieves the child Elements with the given name

getChildren

@NotNull
public java.util.List<org.w3c.dom.Element> getChildren(@NotNull
                                                                 org.w3c.dom.Node node)

Retrieves the child Elements

getId

public void getId(@NotNull
                  org.w3c.dom.Element ele,
                  @NotNull
                  DataNode n)
           throws java.lang.Exception

This method will automatically add an id value to the node's schema if an id XML element exists in the element passed to it.

This method should be called when you are generating unique id every time for a given element, and the id for that element was previously set

Parameters:

ele -

n -

Throws:

java.lang.Exception

addDataNode

@NotNull
public DataNode addDataNode(@NotNull
                                      org.w3c.dom.Element ele)
                               throws java.lang.Exception

Adds a DataNode to the root node

Throws:

java.lang.Exception

addDataNode

@NotNull
public DataNode addDataNode(@NotNull
                                      org.w3c.dom.Element ele,
                                      java.lang.String schema_identifier)
                               throws java.lang.Exception

Adds a DataNode to the root node

Throws:

java.lang.Exception

addDataToNode

public void addDataToNode(@NotNull
                          DataNode node,
                          @NotNull
                          org.w3c.dom.Element ele)
                   throws java.lang.Exception

Adds Data to an existing node from an element. It loops through all the children of the element searching for children with the same name as the string given to it. If they match, it will add that child as data to the node

Throws:

java.lang.Exception