lucee.runtime.util

Class XMLUtilImpl

java.lang.Object

lucee.runtime.util.XMLUtilImpl

All Implemented Interfaces:

XMLUtil

public final class XMLUtilImpl
extends Object
implements XMLUtil

Field Summary

Fields

Modifier and Type	Field and Description
static String	NON_VALIDATING_DTD_EXTERNAL
static String	NON_VALIDATING_DTD_GRAMMAR
static short	UNDEFINED_NODE
static String	VALIDATION_SCHEMA
static String	VALIDATION_SCHEMA_FULL_CHECKING

Constructor Summary

Constructors

Constructor and Description
XMLUtilImpl()

Method Summary

Modifier and Type	Method and Description
Document	createDocument(InputStream is, boolean isHTML) creates and returns a xml Document instance
Document	createDocument(Resource res, boolean isHTML) creates and returns a xml Document instance
Document	createDocument(String xml, boolean isHTML) creates and returns a xml Document instance
XMLReader	createXMLReader(String oprionalDefaultSaxParser)
String	escapeXMLString(String xmlStr)
Element[]	getChildElementsAsArray(Node node) return all Element Children of a node
Node	getChildNode(Node node, short type, String filter, int index)
ArrayList<Node>	getChildNodes(Node node, short type, String filter) return all Children of a node by a defined type as Node List
Node[]	getChildNodesAsArray(Node node, short type) return all Children of a node by a defined type as Node Array
Node[]	getChildNodesAsArray(Node node, short type, String filter)
List<Node>	getChildNodesAsList(Node node, short type, String filter)
Element	getChildWithName(String name, Element el)
Document	getDocument(Node node)
Document	getDocument(NodeList nodeList) return the Owner Document of a Node List
Element	getRootElement(Node node) return the root Element from a node
TransformerFactory	getTransformerFactory()
String	getTypeAsString(Node node, boolean cftype) returns the Node Type As String
boolean	nameEqual(Node node, String name) check if given name is equal to name of the element (with and without namespace)
Document	newDocument() returns a new Empty XMl Document
Document	parse(InputSource xml, InputSource validator, boolean isHtml) parse XML/HTML String to a XML DOM representation
void	prependChild(Element parent, Element child)
void	replaceChild(Node newChild, Node oldChild)
void	setFirst(Node parent, Node node)
InputSource	toInputSource(Object value)
InputSource	toInputSource(PageContext pc, Object value)
InputSource	toInputSource(PageContext pc, String xml)
InputSource	toInputSource(PageContext pc, String xml, boolean canBePath)
InputSource	toInputSource(Resource res, Charset cs)
Node	toNode(Object value)
String	toString(Node node, boolean omitXMLDecl, boolean indent, String publicId, String systemId, String encoding)
String	toString(NodeList nodes, boolean omitXMLDecl, boolean indent)
String	toString(Node node, String defaultValue)
String	transform(Document doc, InputSource xsl, Map<String,Object> parameters) transform a XML Document to a other format, with help of a XSL Stylesheet
String	transform(InputSource xml, InputSource xsl, Map<String,Object> parameters) transform a XML Object to a other format, with help of a XSL Stylesheet
String	unescapeXMLString(String str)
Struct	validate(InputSource xml, InputSource schema, String strSchema)
void	writeTo(Node node, Resource file) write a xml Dom to a file
void	writeTo(Node node, Result res, boolean omitXMLDecl, boolean indent, String publicId, String systemId, String encoding)

Methods inherited from class java.lang.Object

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

Field Detail

NON_VALIDATING_DTD_GRAMMAR

public static final String NON_VALIDATING_DTD_GRAMMAR

See Also:

Constant Field Values

NON_VALIDATING_DTD_EXTERNAL

public static final String NON_VALIDATING_DTD_EXTERNAL

See Also:

Constant Field Values

VALIDATION_SCHEMA

public static final String VALIDATION_SCHEMA

See Also:

Constant Field Values

VALIDATION_SCHEMA_FULL_CHECKING

public static final String VALIDATION_SCHEMA_FULL_CHECKING

See Also:

Constant Field Values

UNDEFINED_NODE

public static final short UNDEFINED_NODE

See Also:

Constant Field Values

Constructor Detail

XMLUtilImpl

public XMLUtilImpl()

Method Detail

unescapeXMLString

public String unescapeXMLString(String str)

Specified by:

unescapeXMLString in interface XMLUtil

escapeXMLString

public String escapeXMLString(String xmlStr)

Specified by:

escapeXMLString in interface XMLUtil

getTransformerFactory

public TransformerFactory getTransformerFactory()

Specified by:

getTransformerFactory in interface XMLUtil

parse

public final Document parse(InputSource xml,
                            InputSource validator,
                            boolean isHtml)
                     throws SAXException,
                            IOException

parse XML/HTML String to a XML DOM representation

Specified by:

parse in interface XMLUtil

Parameters:

xml - XML InputSource

isHtml - is a HTML or XML Object

Returns:

parsed Document

Throws:

SAXException

IOException

replaceChild

public void replaceChild(Node newChild,
                         Node oldChild)

Specified by:

replaceChild in interface XMLUtil

nameEqual

public boolean nameEqual(Node node,
                         String name)

Description copied from interface: XMLUtil

check if given name is equal to name of the element (with and without namespace)

Specified by:

nameEqual in interface XMLUtil

Parameters:

node - node to compare the name

name - name to compare

Returns:

is name of the given Node equal to the given name

getRootElement

public Element getRootElement(Node node)

Description copied from interface: XMLUtil

return the root Element from a node

Specified by:

getRootElement in interface XMLUtil

Parameters:

node - node to get root element from

Returns:

Root Element

newDocument

public Document newDocument()
                     throws ParserConfigurationException,
                            FactoryConfigurationError

Description copied from interface: XMLUtil

returns a new Empty XMl Document

Specified by:

newDocument in interface XMLUtil

Returns:

new Document

Throws:

ParserConfigurationException

FactoryConfigurationError

getDocument

public Document getDocument(NodeList nodeList)
                     throws PageException

Description copied from interface: XMLUtil

return the Owner Document of a Node List

Specified by:

getDocument in interface XMLUtil

Returns:

XML Document

Throws:

PageException

getDocument

public Document getDocument(Node node)

Specified by:

getDocument in interface XMLUtil

getChildNodes

public ArrayList<Node> getChildNodes(Node node,
                                     short type,
                                     String filter)

Description copied from interface: XMLUtil

return all Children of a node by a defined type as Node List

Specified by:

getChildNodes in interface XMLUtil

Parameters:

node - node to get children from

type - type of returned node

filter - filter to use

Returns:

all matching child node

getChildNodesAsList

public List<Node> getChildNodesAsList(Node node,
                                      short type,
                                      String filter)

getChildNode

public Node getChildNode(Node node,
                         short type,
                         String filter,
                         int index)

Specified by:

getChildNode in interface XMLUtil

getChildNodesAsArray

public Node[] getChildNodesAsArray(Node node,
                                   short type)

return all Children of a node by a defined type as Node Array

Parameters:

node - node to get children from

type - type of returned node

Returns:

all matching child node

getChildNodesAsArray

public Node[] getChildNodesAsArray(Node node,
                                   short type,
                                   String filter)

getChildElementsAsArray

public Element[] getChildElementsAsArray(Node node)

return all Element Children of a node

Parameters:

node - node to get children from

Returns:

all matching child node

transform

public String transform(InputSource xml,
                        InputSource xsl,
                        Map<String,Object> parameters)
                 throws TransformerException,
                        SAXException,
                        IOException

Description copied from interface: XMLUtil

transform a XML Object to a other format, with help of a XSL Stylesheet

Specified by:

transform in interface XMLUtil

Parameters:

xml - xml to convert

xsl - xsl used to convert

parameters - parameters used to convert

Returns:

resulting string

Throws:

TransformerException

SAXException

IOException

transform

public String transform(Document doc,
                        InputSource xsl,
                        Map<String,Object> parameters)
                 throws TransformerException

Description copied from interface: XMLUtil

transform a XML Document to a other format, with help of a XSL Stylesheet

Specified by:

transform in interface XMLUtil

Parameters:

doc - xml to convert

xsl - xsl used to convert

parameters - parameters used to convert

Returns:

resulting string

Throws:

TransformerException

getTypeAsString

public String getTypeAsString(Node node,
                              boolean cftype)

returns the Node Type As String

Parameters:

node -

cftype -

Returns:

getChildWithName

public Element getChildWithName(String name,
                                Element el)

Specified by:

getChildWithName in interface XMLUtil

toInputSource

public InputSource toInputSource(Resource res,
                                 Charset cs)
                          throws IOException

Specified by:

toInputSource in interface XMLUtil

Throws:

IOException

toInputSource

public InputSource toInputSource(PageContext pc,
                                 Object value)
                          throws IOException,
                                 PageException

Throws:

IOException

PageException

toInputSource

public InputSource toInputSource(PageContext pc,
                                 String xml)
                          throws IOException,
                                 PageException

Throws:

IOException

PageException

toInputSource

public InputSource toInputSource(PageContext pc,
                                 String xml,
                                 boolean canBePath)
                          throws IOException,
                                 PageException

Throws:

IOException

PageException

validate

public Struct validate(InputSource xml,
                       InputSource schema,
                       String strSchema)
                throws PageException

Specified by:

validate in interface XMLUtil

Throws:

PageException

prependChild

public void prependChild(Element parent,
                         Element child)

Specified by:

prependChild in interface XMLUtil

setFirst

public void setFirst(Node parent,
                     Node node)

Specified by:

setFirst in interface XMLUtil

createXMLReader

public XMLReader createXMLReader(String oprionalDefaultSaxParser)
                          throws SAXException

Throws:

SAXException

toInputSource

public InputSource toInputSource(Object value)
                          throws IOException,
                                 PageException

Specified by:

toInputSource in interface XMLUtil

Throws:

IOException

PageException

writeTo

public void writeTo(Node node,
                    Resource file)
             throws PageException

Description copied from interface: XMLUtil

write a xml Dom to a file

Specified by:

writeTo in interface XMLUtil

Throws:

PageException

writeTo

public void writeTo(Node node,
                    Result res,
                    boolean omitXMLDecl,
                    boolean indent,
                    String publicId,
                    String systemId,
                    String encoding)
             throws PageException

Specified by:

writeTo in interface XMLUtil

Throws:

PageException

toString

public String toString(Node node,
                       boolean omitXMLDecl,
                       boolean indent,
                       String publicId,
                       String systemId,
                       String encoding)
                throws PageException

Specified by:

toString in interface XMLUtil

Throws:

PageException

toString

public String toString(NodeList nodes,
                       boolean omitXMLDecl,
                       boolean indent)
                throws PageException

Specified by:

toString in interface XMLUtil

Throws:

PageException

toString

public String toString(Node node,
                       String defaultValue)

Specified by:

toString in interface XMLUtil

toNode

public Node toNode(Object value)
            throws PageException

Specified by:

toNode in interface XMLUtil

Throws:

PageException

createDocument

public Document createDocument(Resource res,
                               boolean isHTML)
                        throws PageException

Description copied from interface: XMLUtil

creates and returns a xml Document instance

Specified by:

createDocument in interface XMLUtil

Returns:

struct

Throws:

PageException

createDocument

public Document createDocument(String xml,
                               boolean isHTML)
                        throws PageException

Description copied from interface: XMLUtil

creates and returns a xml Document instance

Specified by:

createDocument in interface XMLUtil

Returns:

struct

Throws:

PageException

createDocument

public Document createDocument(InputStream is,
                               boolean isHTML)
                        throws PageException

Description copied from interface: XMLUtil

creates and returns a xml Document instance

Specified by:

createDocument in interface XMLUtil

Returns:

struct

Throws:

PageException