com.sankhya.util

Class XMLUtils

java.lang.Object

com.sankhya.util.XMLUtils

public class XMLUtils
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	XMLUtils.ChildIterator
static interface	XMLUtils.RowBuilder
static class	XMLUtils.SimpleXPath Executa buscas XPath ignorando os Namespaces do documento de entrada.

Constructor Summary

Constructors

Constructor and Description
XMLUtils()

Method Summary

Modifier and Type	Method and Description
static void	addAttributeElement(org.jdom.Element elem, java.lang.String name, java.lang.Object value)
static void	addAttributeElement(org.jdom.Element elem, java.lang.String name, java.sql.ResultSet rs)
static void	addCDATAContentElement(org.jdom.Element parent, java.lang.String name, java.lang.Object value)
static void	addCDATAContentElement(org.jdom.Element parent, java.lang.String name, java.lang.String value)
static void	addCDATAContentElementIfNotEmpty(org.jdom.Element parent, java.lang.String name, java.lang.Object value)
static void	addContentElement(org.jdom.Element parent, java.lang.String name, java.lang.Object value)
static void	addContentElement(org.jdom.Element parent, java.lang.String name, java.lang.Object value, org.jdom.Attribute[] attributes)
static void	addContentElement(org.jdom.Element parent, java.lang.String name, java.lang.Object value, org.jdom.Attribute[] attributes, org.jdom.Namespace namespace)
static void	addContentElement(org.jdom.Element parent, java.lang.String name, java.lang.Object value, org.jdom.Namespace namespace)
static void	addContentElement(org.jdom.Element parent, java.lang.String name, java.sql.ResultSet rs)
static void	addFormatedContentElement(org.jdom.Element parent, java.lang.String name, java.lang.Object value, boolean useCDATA)
static org.jdom.Element	buildCDATAElement(java.lang.String name, java.lang.String value)
static org.jdom.Document	buildDocumentFromStream(java.io.InputStream is)
static org.jdom.Document	buildDocumentFromString(java.lang.String source)
static org.jdom.Document	buildDocumentFromString(java.lang.String source, boolean processInvalidLiterals)
static org.jdom.Element	buildXMLElementFromObject(java.lang.Object obj, java.lang.String rootName)
static org.jdom.Element	buildXMLElementFromObject(java.lang.Object obj, java.lang.String rootName, java.util.Map elementNameByObjProperty)
static org.jdom.Element	buildXMLFromMap(java.util.Map<java.lang.String,java.lang.Object> map)
static org.jdom.Element	buildXMLFromMap(java.util.Map<java.lang.String,java.lang.Object> map, java.lang.String rootElemName, boolean propertyAsAttribute)
static org.jdom.Element	buildXMLFromResultSet(java.lang.String parentName, java.lang.String childName, java.sql.ResultSet rset)
static org.jdom.Element	buildXMLFromResultSet(java.lang.String parentName, java.lang.String childName, java.sql.ResultSet rset, XMLUtils.RowBuilder rowBuilder)
static void	cleanDocument(org.jdom.Document doc)
static void	cleanElement(org.jdom.Element el)
static java.lang.String	documentToString(org.jdom.Document doc)
static java.lang.String	documentToString(org.jdom.Document doc, java.lang.String charset)
static java.lang.String	elementToString(org.jdom.Element element)
static java.lang.String	elementToString(org.jdom.Element element, java.lang.String charset)
static java.math.BigDecimal	getAttributeAsBigDecimal(org.jdom.Element elem, java.lang.String attName)
static java.math.BigDecimal	getAttributeAsBigDecimalOrZero(org.jdom.Element elem, java.lang.String attName)
static boolean	getAttributeAsBoolean(org.jdom.Element elem, java.lang.String attName)
static <T extends java.lang.Enum<T>> T	getAttributeAsEnum(org.jdom.Element elem, java.lang.String attName, java.lang.Class<T> enumType)
static java.lang.String	getAttributeAsString(org.jdom.Element elem, java.lang.String attName)
static java.lang.String	getAttributeAsString(org.jdom.Element elem, java.lang.String attName, boolean asIs)
static java.sql.Timestamp	getAttributeAsTimestamp(org.jdom.Element elem, java.lang.String attName)
static org.jdom.Element	getChild(org.jdom.Element source, java.lang.String elementName)
static org.jdom.Element	getChild(org.jdom.Element source, java.lang.String elementName, java.lang.String nameSpace)
static java.util.Collection<java.math.BigDecimal>	getChildrenContentAsBigDecimalCollection(org.jdom.Element root, java.lang.String elementName)
static java.util.Collection<java.math.BigDecimal>	getChildrenContentAsBigDecimalCollection(org.jdom.Element root, java.lang.String elementName, java.lang.String attributeName)
static java.util.Collection<java.lang.String>	getChildrenContentAsStringCollection(org.jdom.Element root, java.lang.String elementName)
static java.util.Collection<java.lang.String>	getChildrenContentAsStringCollection(org.jdom.Element root, java.lang.String elementName, java.lang.String attributeName)
static java.math.BigDecimal	getContentAsBigDecimal(org.jdom.Element sourceElement)
static java.lang.Boolean	getContentAsBoolean(org.jdom.Element sourceElement)
static <T extends java.lang.Enum<T>> T	getContentAsEnum(org.jdom.Element sourceElement, java.lang.Class<T> enumType)
static java.lang.String	getContentAsString(org.jdom.Element sourceElement)
static java.sql.Timestamp	getContentAsTimeStamp(org.jdom.Element sourceElement)
static java.math.BigDecimal	getContentChildAsBigDecimal(org.jdom.Element source, java.lang.String elementName)
static java.lang.Boolean	getContentChildAsBoolean(org.jdom.Element source, java.lang.String elementName)
static <T extends java.lang.Enum<T>> T	getContentChildAsEnum(org.jdom.Element source, java.lang.String elementName, java.lang.Class<T> enumType)
static java.lang.String	getContentChildAsString(org.jdom.Element source, java.lang.String elementName)
static java.sql.Timestamp	getContentChildAsTimeStamp(org.jdom.Element source, java.lang.String elementName)
static java.math.BigDecimal	getRequiredAttributeAsBigDecimal(org.jdom.Element elem, java.lang.String attName)
static <T extends java.lang.Enum<T>> T	getRequiredAttributeAsEnum(org.jdom.Element elem, java.lang.String attName, java.lang.Class<T> enumType)
static java.lang.String	getRequiredAttributeAsString(org.jdom.Element elem, java.lang.String attName)
static java.sql.Timestamp	getRequiredAttributeAsTimestamp(org.jdom.Element elem, java.lang.String attName)
static org.jdom.Element	getRequiredChild(org.jdom.Element source, java.lang.String elementName)
static org.jdom.Element	getRequiredChild(org.jdom.Element source, java.lang.String elementName, java.lang.String nameSpace)
static java.math.BigDecimal	getRequiredContentAsBigDecimal(org.jdom.Element sourceElement)
static java.lang.String	getRequiredContentAsString(org.jdom.Element sourceElement)
static java.sql.Timestamp	getRequiredContentAsTimestamp(org.jdom.Element sourceElement)
static java.math.BigDecimal	getRequiredContentChildAsBigDecimal(org.jdom.Element source, java.lang.String elementName)
static java.lang.String	getRequiredContentChildAsString(org.jdom.Element source, java.lang.String elementName)
static java.sql.Timestamp	getRequiredContentChildAsTimeStamp(org.jdom.Element source, java.lang.String elementName)
static java.lang.String	getStringOrEmpty(java.lang.Object obj)
static java.lang.String	getXMLString(org.jdom.Element element, java.lang.String encode)
static boolean	isXMLValid(java.lang.String test)
static void	iterateOnChildren(java.lang.String childName, org.jdom.Element base, XMLUtils.ChildIterator cite) Faz a iteração nos filhos do elemento por nome childName A utilidade deste método se torna clara quando usamos um documento XML que possui Namespace, pois ele ignora estes Namespaces e testa somente o nome do elemento, o q é o desejável na maioria dos casos.
static java.lang.String	keepingValidXMLChars(java.lang.String in)
static void	printFromDebug(org.jdom.Element el)
static org.jdom.Element	removeChildIgnoringNameSpace(org.jdom.Element base, java.lang.String childName)
static void	setAttibuteIfNotEmpty(org.jdom.Element elem, java.lang.String name, java.lang.String value)
static void	setAttibuteValue(org.jdom.Element elem, java.lang.String name, java.lang.Object value)
static void	setAttibuteValueIfNotEmpty(org.jdom.Element elem, java.lang.String name, java.lang.Object value)
static void	setNamespaceRecursively(org.jdom.Element rootElement, org.jdom.Namespace namespace)
static void	setText(org.jdom.Element elem, java.lang.Object value)
static org.jdom.Element	stringToElement(java.lang.String elementString)
static void	writeToStream(org.jdom.Document doc, java.io.OutputStream out)
static void	writeToStream(org.jdom.Document doc, java.io.OutputStream out, java.lang.String charset)
static void	writeToStream(org.jdom.Element element, java.io.OutputStream out)
static void	writeToStream(org.jdom.Element element, java.io.OutputStream out, java.lang.String charset)

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLUtils

public XMLUtils()

Method Detail

addAttributeElement

public static void addAttributeElement(org.jdom.Element elem,
                                       java.lang.String name,
                                       java.lang.Object value)

addAttributeElement

public static void addAttributeElement(org.jdom.Element elem,
                                       java.lang.String name,
                                       java.sql.ResultSet rs)
                                throws java.lang.Exception

Throws:

java.lang.Exception

addContentElement

public static void addContentElement(org.jdom.Element parent,
                                     java.lang.String name,
                                     java.sql.ResultSet rs)
                              throws java.lang.Exception

Throws:

java.lang.Exception

addContentElement

public static void addContentElement(org.jdom.Element parent,
                                     java.lang.String name,
                                     java.lang.Object value)

addContentElement

public static void addContentElement(org.jdom.Element parent,
                                     java.lang.String name,
                                     java.lang.Object value,
                                     org.jdom.Namespace namespace)
                              throws java.lang.Exception

Throws:

java.lang.Exception

addContentElement

public static void addContentElement(org.jdom.Element parent,
                                     java.lang.String name,
                                     java.lang.Object value,
                                     org.jdom.Attribute[] attributes)
                              throws java.lang.Exception

Throws:

java.lang.Exception

addContentElement

public static void addContentElement(org.jdom.Element parent,
                                     java.lang.String name,
                                     java.lang.Object value,
                                     org.jdom.Attribute[] attributes,
                                     org.jdom.Namespace namespace)

buildCDATAElement

public static org.jdom.Element buildCDATAElement(java.lang.String name,
                                                 java.lang.String value)

addFormatedContentElement

public static void addFormatedContentElement(org.jdom.Element parent,
                                             java.lang.String name,
                                             java.lang.Object value,
                                             boolean useCDATA)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

addCDATAContentElement

public static void addCDATAContentElement(org.jdom.Element parent,
                                          java.lang.String name,
                                          java.lang.Object value)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

addCDATAContentElement

public static void addCDATAContentElement(org.jdom.Element parent,
                                          java.lang.String name,
                                          java.lang.String value)

addCDATAContentElementIfNotEmpty

public static void addCDATAContentElementIfNotEmpty(org.jdom.Element parent,
                                                    java.lang.String name,
                                                    java.lang.Object value)

buildDocumentFromStream

public static org.jdom.Document buildDocumentFromStream(java.io.InputStream is)
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

buildDocumentFromString

public static org.jdom.Document buildDocumentFromString(java.lang.String source)
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

buildDocumentFromString

public static org.jdom.Document buildDocumentFromString(java.lang.String source,
                                                        boolean processInvalidLiterals)
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

buildXMLElementFromObject

public static org.jdom.Element buildXMLElementFromObject(java.lang.Object obj,
                                                         java.lang.String rootName,
                                                         java.util.Map elementNameByObjProperty)
                                                  throws java.lang.Exception

Throws:

java.lang.Exception

buildXMLElementFromObject

public static org.jdom.Element buildXMLElementFromObject(java.lang.Object obj,
                                                         java.lang.String rootName)
                                                  throws java.lang.Exception

Throws:

java.lang.Exception

buildXMLFromResultSet

public static org.jdom.Element buildXMLFromResultSet(java.lang.String parentName,
                                                     java.lang.String childName,
                                                     java.sql.ResultSet rset,
                                                     XMLUtils.RowBuilder rowBuilder)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

buildXMLFromResultSet

public static org.jdom.Element buildXMLFromResultSet(java.lang.String parentName,
                                                     java.lang.String childName,
                                                     java.sql.ResultSet rset)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

buildXMLFromMap

public static org.jdom.Element buildXMLFromMap(java.util.Map<java.lang.String,java.lang.Object> map)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

buildXMLFromMap

public static org.jdom.Element buildXMLFromMap(java.util.Map<java.lang.String,java.lang.Object> map,
                                               java.lang.String rootElemName,
                                               boolean propertyAsAttribute)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

cleanDocument

public static void cleanDocument(org.jdom.Document doc)
                          throws java.lang.Exception

Throws:

java.lang.Exception

cleanElement

public static void cleanElement(org.jdom.Element el)
                         throws java.lang.Exception

Throws:

java.lang.Exception

documentToString

public static java.lang.String documentToString(org.jdom.Document doc)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

documentToString

public static java.lang.String documentToString(org.jdom.Document doc,
                                                java.lang.String charset)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

elementToString

public static java.lang.String elementToString(org.jdom.Element element)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

elementToString

public static java.lang.String elementToString(org.jdom.Element element,
                                               java.lang.String charset)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getAttributeAsBigDecimal

public static java.math.BigDecimal getAttributeAsBigDecimal(org.jdom.Element elem,
                                                            java.lang.String attName)

getAttributeAsBigDecimalOrZero

public static java.math.BigDecimal getAttributeAsBigDecimalOrZero(org.jdom.Element elem,
                                                                  java.lang.String attName)

getAttributeAsBoolean

public static boolean getAttributeAsBoolean(org.jdom.Element elem,
                                            java.lang.String attName)

getAttributeAsString

public static java.lang.String getAttributeAsString(org.jdom.Element elem,
                                                    java.lang.String attName)

getAttributeAsString

public static java.lang.String getAttributeAsString(org.jdom.Element elem,
                                                    java.lang.String attName,
                                                    boolean asIs)

getAttributeAsTimestamp

public static java.sql.Timestamp getAttributeAsTimestamp(org.jdom.Element elem,
                                                         java.lang.String attName)

getAttributeAsEnum

public static <T extends java.lang.Enum<T>> T getAttributeAsEnum(org.jdom.Element elem,
                                                                 java.lang.String attName,
                                                                 java.lang.Class<T> enumType)

getContentAsBigDecimal

public static java.math.BigDecimal getContentAsBigDecimal(org.jdom.Element sourceElement)

getContentAsBoolean

public static java.lang.Boolean getContentAsBoolean(org.jdom.Element sourceElement)

getContentAsString

public static java.lang.String getContentAsString(org.jdom.Element sourceElement)

getContentAsTimeStamp

public static java.sql.Timestamp getContentAsTimeStamp(org.jdom.Element sourceElement)

getContentAsEnum

public static <T extends java.lang.Enum<T>> T getContentAsEnum(org.jdom.Element sourceElement,
                                                               java.lang.Class<T> enumType)

getContentChildAsBigDecimal

public static java.math.BigDecimal getContentChildAsBigDecimal(org.jdom.Element source,
                                                               java.lang.String elementName)

getContentChildAsBoolean

public static java.lang.Boolean getContentChildAsBoolean(org.jdom.Element source,
                                                         java.lang.String elementName)

getContentChildAsString

public static java.lang.String getContentChildAsString(org.jdom.Element source,
                                                       java.lang.String elementName)

getContentChildAsTimeStamp

public static java.sql.Timestamp getContentChildAsTimeStamp(org.jdom.Element source,
                                                            java.lang.String elementName)

getContentChildAsEnum

public static <T extends java.lang.Enum<T>> T getContentChildAsEnum(org.jdom.Element source,
                                                                    java.lang.String elementName,
                                                                    java.lang.Class<T> enumType)

getRequiredAttributeAsBigDecimal

public static java.math.BigDecimal getRequiredAttributeAsBigDecimal(org.jdom.Element elem,
                                                                    java.lang.String attName)
                                                             throws java.lang.Exception

Throws:

java.lang.Exception

getRequiredAttributeAsString

public static java.lang.String getRequiredAttributeAsString(org.jdom.Element elem,
                                                            java.lang.String attName)
                                                     throws java.lang.Exception

Throws:

java.lang.Exception

getRequiredAttributeAsTimestamp

public static java.sql.Timestamp getRequiredAttributeAsTimestamp(org.jdom.Element elem,
                                                                 java.lang.String attName)
                                                          throws java.lang.Exception

Throws:

java.lang.Exception

getRequiredAttributeAsEnum

public static <T extends java.lang.Enum<T>> T getRequiredAttributeAsEnum(org.jdom.Element elem,
                                                                         java.lang.String attName,
                                                                         java.lang.Class<T> enumType)

getChild

public static org.jdom.Element getChild(org.jdom.Element source,
                                        java.lang.String elementName,
                                        java.lang.String nameSpace)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getChild

public static org.jdom.Element getChild(org.jdom.Element source,
                                        java.lang.String elementName)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getRequiredChild

public static org.jdom.Element getRequiredChild(org.jdom.Element source,
                                                java.lang.String elementName,
                                                java.lang.String nameSpace)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getRequiredChild

public static org.jdom.Element getRequiredChild(org.jdom.Element source,
                                                java.lang.String elementName)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getRequiredContentAsBigDecimal

public static java.math.BigDecimal getRequiredContentAsBigDecimal(org.jdom.Element sourceElement)

getRequiredContentAsString

public static java.lang.String getRequiredContentAsString(org.jdom.Element sourceElement)

getRequiredContentAsTimestamp

public static java.sql.Timestamp getRequiredContentAsTimestamp(org.jdom.Element sourceElement)

getRequiredContentChildAsBigDecimal

public static java.math.BigDecimal getRequiredContentChildAsBigDecimal(org.jdom.Element source,
                                                                       java.lang.String elementName)

getRequiredContentChildAsString

public static java.lang.String getRequiredContentChildAsString(org.jdom.Element source,
                                                               java.lang.String elementName)

getRequiredContentChildAsTimeStamp

public static java.sql.Timestamp getRequiredContentChildAsTimeStamp(org.jdom.Element source,
                                                                    java.lang.String elementName)

getStringOrEmpty

public static java.lang.String getStringOrEmpty(java.lang.Object obj)

iterateOnChildren

public static void iterateOnChildren(java.lang.String childName,
                                     org.jdom.Element base,
                                     XMLUtils.ChildIterator cite)
                              throws java.lang.Exception

Faz a iteração nos filhos do elemento por nome childName A utilidade deste método se torna clara quando usamos um documento XML que possui Namespace, pois ele ignora estes Namespaces e testa somente o nome do elemento, o q é o desejável na maioria dos casos. Os métodos nativos do JDom consideram o Namespace, dificultando a busca.

Parameters:

childName -

base -

cite -

Throws:

java.lang.Exception

printFromDebug

public static void printFromDebug(org.jdom.Element el)

removeChildIgnoringNameSpace

public static org.jdom.Element removeChildIgnoringNameSpace(org.jdom.Element base,
                                                            java.lang.String childName)

setAttibuteIfNotEmpty

public static void setAttibuteIfNotEmpty(org.jdom.Element elem,
                                         java.lang.String name,
                                         java.lang.String value)

setAttibuteValueIfNotEmpty

public static void setAttibuteValueIfNotEmpty(org.jdom.Element elem,
                                              java.lang.String name,
                                              java.lang.Object value)

setAttibuteValue

public static void setAttibuteValue(org.jdom.Element elem,
                                    java.lang.String name,
                                    java.lang.Object value)

setText

public static void setText(org.jdom.Element elem,
                           java.lang.Object value)

writeToStream

public static void writeToStream(org.jdom.Document doc,
                                 java.io.OutputStream out)
                          throws java.lang.Exception

Throws:

java.lang.Exception

writeToStream

public static void writeToStream(org.jdom.Document doc,
                                 java.io.OutputStream out,
                                 java.lang.String charset)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getXMLString

public static java.lang.String getXMLString(org.jdom.Element element,
                                            java.lang.String encode)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

writeToStream

public static void writeToStream(org.jdom.Element element,
                                 java.io.OutputStream out)
                          throws java.lang.Exception

Throws:

java.lang.Exception

writeToStream

public static void writeToStream(org.jdom.Element element,
                                 java.io.OutputStream out,
                                 java.lang.String charset)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getChildrenContentAsBigDecimalCollection

public static java.util.Collection<java.math.BigDecimal> getChildrenContentAsBigDecimalCollection(org.jdom.Element root,
                                                                                                  java.lang.String elementName)

getChildrenContentAsBigDecimalCollection

public static java.util.Collection<java.math.BigDecimal> getChildrenContentAsBigDecimalCollection(org.jdom.Element root,
                                                                                                  java.lang.String elementName,
                                                                                                  java.lang.String attributeName)

setNamespaceRecursively

public static void setNamespaceRecursively(org.jdom.Element rootElement,
                                           org.jdom.Namespace namespace)

stringToElement

public static org.jdom.Element stringToElement(java.lang.String elementString)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getChildrenContentAsStringCollection

public static java.util.Collection<java.lang.String> getChildrenContentAsStringCollection(org.jdom.Element root,
                                                                                          java.lang.String elementName)

getChildrenContentAsStringCollection

public static java.util.Collection<java.lang.String> getChildrenContentAsStringCollection(org.jdom.Element root,
                                                                                          java.lang.String elementName,
                                                                                          java.lang.String attributeName)

keepingValidXMLChars

public static java.lang.String keepingValidXMLChars(java.lang.String in)

isXMLValid

public static boolean isXMLValid(java.lang.String test)