com.partnersoft.formats.xml

Class JDOMXmlParser

java.lang.Object

com.partnersoft.formats.xml.JDOMXmlParser

public class JDOMXmlParser
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
JDOMXmlParser()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<java.util.Map>	fieldValuesWithAttributeFor(org.jdom.Element current, java.lang.String tag, java.lang.String attributeName) The assumes a somevalue format.
java.util.List<java.util.Map>	fieldValuesWithAttributeFor(java.lang.String tag) The assumes a somevalue format.
java.util.List<java.util.Map>	fieldValuesWithAttributeFor(java.lang.String tag, java.lang.String attributeName) The assumes a somevalue format.
java.util.List<org.jdom.Attribute>	getAllAttributes(org.jdom.Element element) Given an Element returns a list of Attributes for the given element.
java.lang.String	getAttributeValue(org.jdom.Element element, java.lang.String attribute) Given an Element and the attribute name, returns the String value of that attribute.
org.jdom.Element	getChildElement(org.jdom.Element current, java.lang.String childTag) Given current element/node and tag name of the child element returns the child element.
java.util.List<org.jdom.Element>	getChildrenList(org.jdom.Element current, java.lang.String tag) Given the current Element and the tag name of the child/children element(s) returns a list of children elements.
org.jdom.Document	getDocuemnt() Returns the Document object.
java.util.List<org.jdom.Element>	getElementsByTagName(java.lang.String tag) Given tag name, returns a list of children elements to the root element.
org.jdom.Element	getRootElement() Returns the root element.
java.lang.String	getValue(org.jdom.Element element) Given an Element returns String value of that element.
java.util.List<java.lang.String>	getValues(org.jdom.Element parent, java.lang.String childTag) Given any Element and tag name of the child element returns an arraylist of values of the child element.
void	parse(java.io.File file) give java "File" object reads and parses the xml file and builds Document object
void	parse(java.lang.String path) Given String path to the xml file, builds Document object by parsing the xml file.
void	parse(VfsFile file) Given VfsFile file, builds Document object by parsing the xml file.

Methods inherited from class java.lang.Object

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

Constructor Detail

JDOMXmlParser

public JDOMXmlParser()

Method Detail

parse

public void parse(java.lang.String path)

Given String path to the xml file, builds Document object by parsing the xml file.

Parameters:

path -

parse

public void parse(VfsFile file)

Given VfsFile file, builds Document object by parsing the xml file.

Parameters:

path -

parse

public void parse(java.io.File file)

give java "File" object reads and parses the xml file and builds Document object

Parameters:

file -

getChildElement

public org.jdom.Element getChildElement(org.jdom.Element current,
                               java.lang.String childTag)

Given current element/node and tag name of the child element returns the child element. Null check is a must because this method return null.

Parameters:

current -

childTag -

Returns:

Element

getElementsByTagName

public java.util.List<org.jdom.Element> getElementsByTagName(java.lang.String tag)

Given tag name, returns a list of children elements to the root element. The assumption is the given tag name is child of the root level. Returns empty list in case of null.

Parameters:

tag -

Returns:

List

getValues

public java.util.List<java.lang.String> getValues(org.jdom.Element parent,
                                         java.lang.String childTag)

Given any Element and tag name of the child element returns an arraylist of values of the child element. Assumption is the child element(s) contains values. It will not work if child element contains other elements. The child element MUST be the last on in the xml data structure.

Parameters:

parent -

childTag -

Returns:

List

getValue

public java.lang.String getValue(org.jdom.Element element)

Given an Element returns String value of that element. The assumption is the element is the last one in the xml data structure (contains value). It will not work if this element contains other elements. Must check for null.

Parameters:

element -

Returns:

String

getChildrenList

public java.util.List<org.jdom.Element> getChildrenList(org.jdom.Element current,
                                               java.lang.String tag)

Given the current Element and the tag name of the child/children element(s) returns a list of children elements.

Parameters:

current -

tag -

Returns:

List

getAttributeValue

public java.lang.String getAttributeValue(org.jdom.Element element,
                                 java.lang.String attribute)

Given an Element and the attribute name, returns the String value of that attribute. Must check for null.

Parameters:

element -

attribute -

Returns:

String

getAllAttributes

public java.util.List<org.jdom.Attribute> getAllAttributes(org.jdom.Element element)

Given an Element returns a list of Attributes for the given element. Must check for null.

Parameters:

element -

Returns:

List

fieldValuesWithAttributeFor

public java.util.List<java.util.Map> fieldValuesWithAttributeFor(java.lang.String tag)

The assumes a somevalue format. Given the tag name of the current element, it returns a list of java Map objects containing values of "name" attribute in "field" tag as the key and the value of the "value" tag as the value. MUST assume that the element is location right underneath the root level.

Parameters:

tag -

Returns:

List

fieldValuesWithAttributeFor

public java.util.List<java.util.Map> fieldValuesWithAttributeFor(java.lang.String tag,
                                                        java.lang.String attributeName)

The assumes a somevalue format. Given the tag name of the current element and string name of the attribute it returns a list of java Map objects containing values of the given attribute in "field" tag as the key and the value of the "value" tag as the value. MUST assume that the element is location right underneath the root level.

Parameters:

tag -

attributeName -

Returns:

List

fieldValuesWithAttributeFor

public java.util.List<java.util.Map> fieldValuesWithAttributeFor(org.jdom.Element current,
                                                        java.lang.String tag,
                                                        java.lang.String attributeName)

The assumes a somevalue format. Given any element, the tag name of the child/children element(s) and string name of the attribute, it returns a list of java Map objects containing values of the given attribute in "field" tag as the key and the value of the "value" tag as the value. MUST assume that the element is location right underneath the root level.

Parameters:

tag -

attributeName -

Returns:

List

getRootElement

public org.jdom.Element getRootElement()

Returns the root element. Must use parse(File file) first before using this method. MUST check for null.

Returns:

Element

getDocuemnt

public org.jdom.Document getDocuemnt()

Returns the Document object. Must use parse(File file) first before using this method. MUST check for null.

Returns:

Element