Package org.cyclos.server.utils

Class XmlHelper

java.lang.Object

org.cyclos.server.utils.XmlHelper

public class XmlHelper
extends Object

Contains helper methods for handling XML

Constructor Summary

Constructors

Constructor	Description
XmlHelper()

Method Summary

Modifier and Type	Method	Description
static Element	createChild(Element element, String tag, String contents)	Creates a sub-element on the given element.
static String	export(Node node)	Exports the given node and his sub-elements as String
static void	export(Node node, Writer out)	Exports the given node and his sub-elements into the given output stream
static boolean	fillAttributes(Element element, Object bean, String... properties)	Fills the given element's attributes by getting the value for each specified bean property, returning whether there was at least one non-empty attribute.
static boolean	fillPropertiesWithAttributes(Object bean, Element element, String... properties)	Fills the given beans's specified properties by getting the value for each property as attributes of the given root element.
static boolean	fillPropertiesWithSubElements(Object bean, Element element, String... properties)	Fills the given beans's specified properties by getting the value for each property as sub element's of the given root element.
static boolean	fillSubElements(Element element, Object bean, String... properties)	Adds several sub-elements whose texts are retrieved from each bean property element.
static Element	getFirst(Element element, String subElementTag)	Returns the first child element with the given tag name
static String	getText(Element element)	Returns the text inside an element
static String	getText(Element element, String subElementTag)	Returns the text inside the first element's children with the given tag name
static NodeListElementIterator	iterate(Element root)	Iterates over the child elements on the given root element
static NodeListElementIterator	iterate(Element root, String tagName)	Iterates over the child elements with the given tag name, on the given root element
static NodeListIterator	iterateChildren(Element root)	Iterates over the child nodes with the given tag name, on the given root element
static Document	newDocument()	Builds a new document
static Document	parse(InputStream in)	Parses a document input stream
static Document	parse(InputStream in, EntityResolver entityResolver)	Parses a document input stream
static Document	parse(String xml)	Parses a document string
static Document	parse(String xml, EntityResolver entityResolver)	Parses a document string
static void	parse(DefaultHandler saxHandler, InputStream in)	Parses a xml using SAX, with the given content handler
static void	parse(DefaultHandler saxHandler, String xml)	Parses a xml using SAX, with the given content handler
static void	parse(DefaultHandler saxHandler, InputSource source)	Parses a xml using SAX, with the given content handler
static String	propertyToTag(String property)	Transforms the given property name into something suitable for tag or attribute name.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlHelper

public XmlHelper()

Method Detail

createChild

public static Element createChild(Element element,
                                  String tag,
                                  String contents)

Creates a sub-element on the given element. The new sub-element will contain the given string as text, and will be returned. The contents will be trimmed.

export

public static String export(Node node)

Exports the given node and his sub-elements as String

export

public static void export(Node node,
                          Writer out)

Exports the given node and his sub-elements into the given output stream

fillAttributes

public static boolean fillAttributes(Element element,
                                     Object bean,
                                     String... properties)

Fills the given element's attributes by getting the value for each specified bean property, returning whether there was at least one non-empty attribute. Attribute names are transformed from property names using propertyToTag(String).

fillPropertiesWithAttributes

public static boolean fillPropertiesWithAttributes(Object bean,
                                                   Element element,
                                                   String... properties)

Fills the given beans's specified properties by getting the value for each property as attributes of the given root element.

fillPropertiesWithSubElements

public static boolean fillPropertiesWithSubElements(Object bean,
                                                    Element element,
                                                    String... properties)

Fills the given beans's specified properties by getting the value for each property as sub element's of the given root element. Tag names are transformed from property names using propertyToTag(String).

See Also:

getText(Element, String)

fillSubElements

public static boolean fillSubElements(Element element,
                                      Object bean,
                                      String... properties)

Adds several sub-elements whose texts are retrieved from each bean property element. Tag names are transformed from property names using propertyToTag(String).

getFirst

public static Element getFirst(Element element,
                               String subElementTag)

Returns the first child element with the given tag name

getText

public static String getText(Element element)

Returns the text inside an element

getText

public static String getText(Element element,
                             String subElementTag)

Returns the text inside the first element's children with the given tag name

iterate

public static NodeListElementIterator iterate(Element root)

Iterates over the child elements on the given root element

iterate

public static NodeListElementIterator iterate(Element root,
                                              String tagName)

Iterates over the child elements with the given tag name, on the given root element

iterateChildren

public static NodeListIterator iterateChildren(Element root)

Iterates over the child nodes with the given tag name, on the given root element

newDocument

public static Document newDocument()

Builds a new document

parse

public static void parse(DefaultHandler saxHandler,
                         InputSource source)
                  throws SAXException,
                         IOException

Parses a xml using SAX, with the given content handler

Throws:

SAXException

IOException

parse

public static void parse(DefaultHandler saxHandler,
                         InputStream in)
                  throws SAXException,
                         IOException

Parses a xml using SAX, with the given content handler

Throws:

SAXException

IOException

parse

public static void parse(DefaultHandler saxHandler,
                         String xml)
                  throws SAXException,
                         IOException

Parses a xml using SAX, with the given content handler

Throws:

SAXException

IOException

parse

public static Document parse(InputStream in)
                      throws SAXException,
                             IOException

Parses a document input stream

Throws:

SAXException

IOException

parse

public static Document parse(InputStream in,
                             EntityResolver entityResolver)
                      throws SAXException,
                             IOException

Parses a document input stream

Throws:

SAXException

IOException

parse

public static Document parse(String xml)
                      throws SAXException,
                             IOException

Parses a document string

Throws:

SAXException

IOException

parse

public static Document parse(String xml,
                             EntityResolver entityResolver)
                      throws SAXException,
                             IOException

Parses a document string

Throws:

SAXException

IOException

propertyToTag

public static String propertyToTag(String property)

Transforms the given property name into something suitable for tag or attribute name. For example, 'propertyName' becomes 'property-name'