com.screenscraper.xml

Class XmlWriter

java.lang.Object

com.screenscraper.xml.XmlWriter

public class XmlWriter
extends java.lang.Object

Uses the dom4j library to write an xml document.

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	log Used for logging.

Constructor Summary

Constructors

Constructor and Description
XmlWriter(java.lang.String fileName, java.lang.String rootElementName) XML Writer constructor, creates the reference to a file writer with the given file name.
XmlWriter(java.lang.String fileName, java.lang.String rootElementName, java.lang.String rootElementText) XML Writer constructor, creates the reference to the file writer with the given file name.
XmlWriter(java.lang.String fileName, java.lang.String rootElementName, java.lang.String rootElementText, java.util.Hashtable attributes) XmlWriter constructor, creates the file writer with the given file name.
XmlWriter(java.lang.String fileName, java.lang.String rootElementName, java.lang.String rootElementText, java.util.Hashtable attributes, java.lang.String characterSet) XmlWriter constructor, creates the file writer with the given file name.

Method Summary

Modifier and Type	Method and Description
org.dom4j.Element	addElement(org.dom4j.Element elementToAppendTo, java.lang.String name) Adds a new element to the specified element with the given tag name and text.
org.dom4j.Element	addElement(org.dom4j.Element elementToAppendTo, java.lang.String name, java.lang.String text) Adds a new element to the specified element with the given tag name and text.
org.dom4j.Element	addElement(org.dom4j.Element elementToAppendTo, java.lang.String name, java.lang.String text, java.util.Hashtable attributes) Main entry point for adding elements.
org.dom4j.Element	addElement(java.lang.String name) Adds a new element to the root element with the given tag name.
org.dom4j.Element	addElement(java.lang.String name, java.util.Hashtable attributes) Adds a new element to the root element with the given tag name and text.
org.dom4j.Element	addElement(java.lang.String name, java.lang.String text) Adds a new element to the root element with the given tag name and text.
org.dom4j.Element	addElement(java.lang.String name, java.lang.String text, java.util.Hashtable attributes) Adds a new element to the root element with the given tag name and text.
org.dom4j.Element	addElements(org.dom4j.Element elementToAppendTo, java.lang.String name, java.util.Hashtable subElements) Creates a new parent Element and appends children to it.
org.dom4j.Element	addElements(org.dom4j.Element elementToAppendTo, java.lang.String name, java.lang.String text, java.util.Hashtable subElements) Creates a new parent Element and appends children to it.
org.dom4j.Element	addElements(org.dom4j.Element elementToAppendTo, java.lang.String name, java.lang.String text, java.util.Hashtable attributes, java.util.Hashtable subElements) All other addElements() methods should call this method with null as any missing values.
void	addElements(java.lang.String containingTagName, DataSet dataSet) Iterates over a DataSet object, adding all the datarecords to the xml feed.
org.dom4j.Element	addElements(java.lang.String name, java.util.Hashtable subElements) Creates a new parent Element and appends children to it.
void	addElements(java.lang.String containingTagName, java.lang.String containingTagText, DataSet dataSet) Iterates over a DataSet object, adding all the datarecords to the xml feed.
org.dom4j.Element	addElements(java.lang.String name, java.lang.String text, java.util.Hashtable subElements) Creates a new parent Element and appends children to it.
void	addElements(java.lang.String containingTagName, java.lang.String containingTagText, java.util.Hashtable attributes, DataSet dataSet) Iterates over a DataSet object, adding all the datarecords to the xml feed.
org.dom4j.Element	addElements(java.lang.String name, java.lang.String text, java.util.Hashtable attributes, java.util.Hashtable subElements) Creates a new parent Element and appends children to it.
void	close() Closes all open tags along with the file writer associated with this object.

Methods inherited from class java.lang.Object

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

Field Detail

log

public static org.apache.log4j.Logger log

Used for logging.

Constructor Detail

XmlWriter

public XmlWriter(java.lang.String fileName,
                 java.lang.String rootElementName)
          throws java.lang.Exception

XML Writer constructor, creates the reference to a file writer with the given file name. Creates the root element with the given name.

Parameters:

fileName - The file name that we need

rootElementName - The name of the Root Element.

Throws:

java.lang.Exception - On error creating the writer

XmlWriter

public XmlWriter(java.lang.String fileName,
                 java.lang.String rootElementName,
                 java.lang.String rootElementText)
          throws java.lang.Exception

XML Writer constructor, creates the reference to the file writer with the given file name. Creates the root element with the given name and text.

Parameters:

fileName - The file that will contain the XML.

rootElementName - The name of the root element.

rootElementText - Text that belongs inside the root tags.

Throws:

java.lang.Exception - On error creating the writer

XmlWriter

public XmlWriter(java.lang.String fileName,
                 java.lang.String rootElementName,
                 java.lang.String rootElementText,
                 java.util.Hashtable attributes)
          throws java.lang.Exception

XmlWriter constructor, creates the file writer with the given file name. Creates the root element with the given name, text, and attributes.

Parameters:

fileName - The file that will contain the XML.

rootElementName - The name of the root element.

rootElementText - The text that belongs inside the root tags.

attributes - Any attributes to add to the root element.

Throws:

java.lang.Exception - On error creating the writer

XmlWriter

public XmlWriter(java.lang.String fileName,
                 java.lang.String rootElementName,
                 java.lang.String rootElementText,
                 java.util.Hashtable attributes,
                 java.lang.String characterSet)
          throws java.lang.Exception

XmlWriter constructor, creates the file writer with the given file name. Creates the root element with the given name, text, and attributes.

Parameters:

fileName - The file that will contain the XML.

rootElementName - The name of the root element.

rootElementText - The text that belongs inside the root tags.

attributes - Any attributes to add to the root element.

characterSet - The character set to use.

Throws:

java.lang.Exception - On error creating the writer

Method Detail

addElement

public org.dom4j.Element addElement(java.lang.String name)
                             throws java.lang.Exception

Adds a new element to the root element with the given tag name.

Parameters:

name - The new element's tag name.

Returns:

The new Element.

Throws:

java.lang.Exception - If there is an error with writing the Element to the file.

addElement

public org.dom4j.Element addElement(java.lang.String name,
                                    java.lang.String text)
                             throws java.lang.Exception

Adds a new element to the root element with the given tag name and text.

Parameters:

name - The new Element's tag name.

text - The new Element's inner text.

Returns:

The new Element.

Throws:

java.lang.Exception - If there is an error with writing the Element to the file.

addElement

public org.dom4j.Element addElement(java.lang.String name,
                                    java.lang.String text,
                                    java.util.Hashtable attributes)
                             throws java.lang.Exception

Adds a new element to the root element with the given tag name and text.

Parameters:

name - The new Element's tag name.

text - The new Element's inner text.

attributes - A Hashtable of attributes. Attributes will be added to the tag like so: key="value".

Returns:

The new Element.

Throws:

java.lang.Exception - If there is an error with writing the Element to the file.

addElement

public org.dom4j.Element addElement(java.lang.String name,
                                    java.util.Hashtable attributes)
                             throws java.lang.Exception

Adds a new element to the root element with the given tag name and text.

Parameters:

name - The new Element's tag name.

attributes - A Hashtable of attributes. Attributes will be added to the tag like so: key="value".

Returns:

The new Element.

Throws:

java.lang.Exception - If there is an error with writing the Element to the file.

addElement

public org.dom4j.Element addElement(org.dom4j.Element elementToAppendTo,
                                    java.lang.String name)
                             throws java.lang.Exception

Adds a new element to the specified element with the given tag name and text.

Parameters:

elementToAppendTo - The element to append information to.

name - The new Element's tag name.

Returns:

The new Element.

Throws:

java.lang.Exception - If there is an error with writing the Element to the file.

addElement

public org.dom4j.Element addElement(org.dom4j.Element elementToAppendTo,
                                    java.lang.String name,
                                    java.lang.String text)
                             throws java.lang.Exception

Adds a new element to the specified element with the given tag name and text.

Parameters:

elementToAppendTo - The element to append information to.

name - The new Element's tag name.

text - The new Element's inner text.

Returns:

The new Element.

Throws:

java.lang.Exception - If there is an error with writing the Element to the file.

addElement

public org.dom4j.Element addElement(org.dom4j.Element elementToAppendTo,
                                    java.lang.String name,
                                    java.lang.String text,
                                    java.util.Hashtable attributes)
                             throws java.lang.Exception

Main entry point for adding elements. All other methods should call this method as to remain consistent.

Parameters:

elementToAppendTo - The element to add information to.

name - The new Element's tag name.

text - The new Element's inner text.

attributes - A Hashtable of attributes. Attributes will be added to the tag like so: key="value".

Returns:

The new Element.

Throws:

java.lang.Exception - If there is an error with writing the Element to the file.

addElements

public org.dom4j.Element addElements(java.lang.String name,
                                     java.util.Hashtable subElements)
                              throws java.lang.Exception

Creates a new parent Element and appends children to it. Adds the parent to the root Element.

Parameters:

name - The name of the parent element.

subElements - Hashtable of children elements. Children are added to the parent with the tag name as the key and the inner text as the value.

Returns:

The parent Element.

Throws:

java.lang.Exception - On error adding the elements

addElements

public org.dom4j.Element addElements(org.dom4j.Element elementToAppendTo,
                                     java.lang.String name,
                                     java.util.Hashtable subElements)
                              throws java.lang.Exception

Creates a new parent Element and appends children to it. Adds the parent to the Element specified.

Parameters:

elementToAppendTo - The Element to add the new parent Element to.

name - The name of the parent element.

subElements - Hashtable of children elements. Children are added to the parent with the tag name as the key and the inner text as the value.

Returns:

The parent Element.

Throws:

java.lang.Exception - On error adding the elements

addElements

public org.dom4j.Element addElements(java.lang.String name,
                                     java.lang.String text,
                                     java.util.Hashtable subElements)
                              throws java.lang.Exception

Creates a new parent Element and appends children to it. Adds the parent to the root Element.

Parameters:

name - The name of the parent element.

text - The inner text of the parent Element.

subElements - Hashtable of children elements. Children are added to the parent with the tag name as the key and the inner text as the value.

Returns:

The parent Element.

Throws:

java.lang.Exception - On error adding the elements

addElements

public org.dom4j.Element addElements(org.dom4j.Element elementToAppendTo,
                                     java.lang.String name,
                                     java.lang.String text,
                                     java.util.Hashtable subElements)
                              throws java.lang.Exception

Creates a new parent Element and appends children to it. Adds the parent to the Element specified.

Parameters:

elementToAppendTo - The Element to add the new parent Element to.

name - The name of the parent element.

text - The inner text of the parent Element.

subElements - Hashtable of children elements. Children are added to the parent with the tag name as the key and the inner text as the value.

Returns:

The parent Element.

Throws:

java.lang.Exception - On error adding the elements

addElements

public org.dom4j.Element addElements(java.lang.String name,
                                     java.lang.String text,
                                     java.util.Hashtable attributes,
                                     java.util.Hashtable subElements)
                              throws java.lang.Exception

Creates a new parent Element and appends children to it. Adds the parent to the root Element.

Parameters:

name - The name of the parent element.

text - The inner text of the parent Element.

attributes - A Hashtable of attributes. Attributes will be added to the tag like so: key="value".

subElements - Hashtable of children elements. Children are added to the parent with the tag name as the key and the inner text as the value.

Returns:

The parent Element.

Throws:

java.lang.Exception - On error adding the elements

addElements

public org.dom4j.Element addElements(org.dom4j.Element elementToAppendTo,
                                     java.lang.String name,
                                     java.lang.String text,
                                     java.util.Hashtable attributes,
                                     java.util.Hashtable subElements)
                              throws java.lang.Exception

All other addElements() methods should call this method with null as any missing values.

Parameters:

elementToAppendTo - The element to add the new parent Element to.

name - The tag name of the new parent Element.

text - The inner text of the new parent Element.

attributes - A Hashtable of attributes. Attributes will be added to the tag like so: key="value".

subElements - Hashtable of children elements. Children are added to the parent with the tag name as the key and the inner text as the value.

Returns:

The new parent Element.

Throws:

java.lang.Exception - On error adding the elements

addElements

public void addElements(java.lang.String containingTagName,
                        DataSet dataSet)
                 throws java.lang.Exception

Iterates over a DataSet object, adding all the datarecords to the xml feed.

Parameters:

containingTagName - The tag that will surround every dataRecord.

dataSet - The data set that contains datarecords that are to be written to the xml feed.

Throws:

java.lang.Exception - On error adding the elements

addElements

public void addElements(java.lang.String containingTagName,
                        java.lang.String containingTagText,
                        DataSet dataSet)
                 throws java.lang.Exception

Iterates over a DataSet object, adding all the datarecords to the xml feed.

Parameters:

containingTagName - The tag that will surround every dataRecord.

containingTagText - The inner text of the tag that surrounds every dataRecord.

dataSet - The data set that contains datarecords that are to be written to the xml feed.

Throws:

java.lang.Exception - On error adding the elements

addElements

public void addElements(java.lang.String containingTagName,
                        java.lang.String containingTagText,
                        java.util.Hashtable attributes,
                        DataSet dataSet)
                 throws java.lang.Exception

Iterates over a DataSet object, adding all the datarecords to the xml feed.

Parameters:

containingTagName - The tag that will surround every dataRecord.

containingTagText - The inner text of the tag that surrounds every dataRecord.

attributes - A Hashtable of attributes. Attributes will be added to the tag like so: key="value".

dataSet - The data set that contains datarecords that are to be written to the xml feed.

Throws:

java.lang.Exception - On error adding the elements

close

public void close()
           throws java.lang.Exception

Closes all open tags along with the file writer associated with this object.

Throws:

java.lang.Exception - On error closing the writer