com.sapportals.wcm.service.pipeline.utils
Class XMLUtils

[contained in: com.sap.netweaver.bc.rf.service.par - bc.rf.global.service.pipeline_api.jar]

java.lang.Object
  |
  +--com.sapportals.wcm.service.pipeline.utils.XMLUtils

All Implemented Interfaces:

IConst

public class XMLUtils

extends java.lang.Object

implements IConst

Congerie of static utility methods (deprecated).

Copyright 2004 SAP AG

Fields inherited from interface com.sapportals.wcm.service.pipeline.IConst

FORMATTER_DOCTYPE_PUBLIC, FORMATTER_DOCTYPE_SYSTEM, FORMATTER_ENCODING, FORMATTER_INDENT, FORMATTER_LINE_WIDTH, FORMATTER_METHOD, FORMATTER_MIME, FORMATTER_PRESERVE_SPACE, FORMATTER_XML_DECL, PROP_BROWSER, PROP_LANGUAGE, PROP_PATH, PROP_SAP, PROP_USER, PROP_WPL, PROP_XSL_DOM, PROP_XSL_PATH, PROP_XSL_PROD, TOOL_XMLPARSER, TOOL_XSLTPROC, WCM_FORMAT_PI, WCM_PROCESS_PI

Constructor Summary

XMLUtils()

Method Summary

static void	addTopLevelParam(org.w3c.dom.Document document, java.lang.String name, java.lang.String key, java.lang.String value) This method adds a top level parameter to the XML document
static java.util.Vector	getAllPIs(org.w3c.dom.Document document, java.lang.String name) This method returns a vector of PI nodes based on the PI target name.
static java.util.Vector	getAllPIs(org.w3c.dom.Document document, java.lang.String name, boolean remove) This method returns all PI nodes based on the target name.
static com.sapportals.wcm.service.pipeline.utils.ProcessingInstruction	getFirstPI(org.w3c.dom.Document document, java.lang.String name) This method returns the first PI node based on the PI target name.
static com.sapportals.wcm.service.pipeline.utils.ProcessingInstruction	getFirstPI(org.w3c.dom.Document document, java.lang.String name, boolean remove) This method returns the first PI based on the PI target name
static java.util.Hashtable	getPIPseudoAttributes(org.w3c.dom.Document document, java.lang.String name) This method returns an hashtable with all the pseudo attributes collected in the document.
static java.util.Hashtable	getPIPseudoAttributes(com.sapportals.wcm.service.pipeline.utils.ProcessingInstruction pi) This method returns the pseudo attributes found in the first PI with the given name.
static java.lang.String	getStylesheetUri(org.w3c.dom.Document document) This method extracts the stylesheet URI form a XML document

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLUtils

public XMLUtils()

Method Detail

addTopLevelParam

public static void addTopLevelParam(org.w3c.dom.Document document,
                                    java.lang.String name,
                                    java.lang.String key,
                                    java.lang.String value)

This method adds a top level parameter to the XML document

Parameters:

document - XML DOM

key - key of the top level parameter

value - value of the top level parameter

name - topLevelParam to be added

getStylesheetUri

public static final java.lang.String getStylesheetUri(org.w3c.dom.Document document)

This method extracts the stylesheet URI form a XML document

Parameters:

document - XML DOM

Returns:

stylesheet URI

getAllPIs

public static final java.util.Vector getAllPIs(org.w3c.dom.Document document,
                                               java.lang.String name)

This method returns a vector of PI nodes based on the PI target name.

Parameters:

document - XML DOM

name - target name of the PI

Returns:

allPIs

getAllPIs

public static final java.util.Vector getAllPIs(org.w3c.dom.Document document,
                                               java.lang.String name,
                                               boolean remove)

This method returns all PI nodes based on the target name.

Parameters:

document - XML DOM

name - target name of the PIs

remove - remove PIs from the DOM if the flag is true

Returns:

allPIs

getFirstPI

public static final com.sapportals.wcm.service.pipeline.utils.ProcessingInstruction getFirstPI(org.w3c.dom.Document document,
                                                                                               java.lang.String name)

This method returns the first PI node based on the PI target name. The PI is not removed from the document.

Parameters:

document - XML DOM

name - target name

Returns:

firstPI

getFirstPI

public static final com.sapportals.wcm.service.pipeline.utils.ProcessingInstruction getFirstPI(org.w3c.dom.Document document,
                                                                                               java.lang.String name,
                                                                                               boolean remove)

This method returns the first PI based on the PI target name

Parameters:

document - XML DOM

name - target name

remove - remove PI from the DOM if the flag is true

Returns:

firstPI

getPIPseudoAttributes

public static final java.util.Hashtable getPIPseudoAttributes(org.w3c.dom.Document document,
                                                              java.lang.String name)

This method returns an hashtable with all the pseudo attributes collected in the document. If more PI have the same target, the attributes are all put in the same hashtable. If there are collisions, the last attribute is insered.

Parameters:

document - TBD: Description of the incoming method parameter

name - TBD: Description of the incoming method parameter

Returns:

pIPseudoAttributes

getPIPseudoAttributes

public static final java.util.Hashtable getPIPseudoAttributes(com.sapportals.wcm.service.pipeline.utils.ProcessingInstruction pi)

This method returns the pseudo attributes found in the first PI with the given name. No validation is performed on the PI pseudo syntax

Parameters:

pi - Processing instruction

Returns:

pIPseudoAttributes