dom4j 2.1.4 · org.dom4j.DocumentHelper

Access	Constructor and Description
private	DocumentHelper()

Method Summary

Modifier and Type	Method and Description
public static Attribute	createAttribute(Element owner, QName qname, String value)
public static Attribute	createAttribute(Element owner, String name, String value)
public static CDATA	createCDATA(String text)
public static Comment	createComment(String text)
public static Document	createDocument()
public static Document	createDocument(Element rootElement)
public static Element	createElement(QName qname)
public static Element	createElement(String name)
public static Entity	createEntity(String name, String text)
public static Namespace	createNamespace(String prefix, String uri)
public static Pattern	Returns: a new `Pattern` instance createPattern(String is the XPath pattern expression to create xpathPattern) `createPattern` parses the given XPath expression to create an XSLT style `Pattern`instance which can then be used in an XSLT processing model.
public static ProcessingInstruction	createProcessingInstruction(String pi, String d)
public static ProcessingInstruction	createProcessingInstruction(String pi, Map<String, String> data)
public static QName	createQName(String localName, Namespace namespace)
public static QName	createQName(String localName)
public static Text	createText(String text)
public static XPath	Returns: a new `XPath` instance createXPath(String is the XPath expression to create xpathExpression) `createXPath` parses an XPath expression and creates a new XPath `XPath` instance using the singleton `DocumentFactory`.
public static XPath	Returns: a new `XPath` instance createXPath(String is the XPath expression to create xpathExpression, VariableContext is the variable context to use when evaluating the XPath context) `createXPath` parses an XPath expression and creates a new XPath `XPath` instance using the singleton `DocumentFactory`.
public static NodeFilter	Returns: a new `NodeFilter` instance createXPathFilter(String is the XPath filter expression to create xpathFilterExpression) `createXPathFilter` parses a NodeFilter from the given XPath filter expression using the singleton `DocumentFactory`.
private static DocumentFactory	getDocumentFactory()
private static String	getEncoding(String text)
public static Element	Returns: the first Element on the given path which either already existed on the path or were created by this method. makeElement(Branch is the Element or Document to start navigating from source, String is a simple path expression, seperated by '/' which denotes the path from the source to the resulting element such as a/b/c path) makeElement a helper method which navigates from the given Document or Element node to some Element using the path expression, creating any necessary elements along the way.
public static Document	Returns: a newly parsed Document parseText(String the XML text to be parsed text) `parseText` parses the given text as an XML document and returns the newly created Document.
public static List<Node>	Returns: the results of all the XPath evaluations as a single list selectNodes(String is the XPath filter expression to evaluate xpathFilterExpression, List<Node> is the list of nodes on which to evalute the XPath nodes) `selectNodes` performs the given XPath expression on the `List`of `Node`instances appending all the results together into a single list.
public static List<Node>	Returns: the results of all the XPath evaluations as a single list selectNodes(String is the XPath filter expression to evaluate xpathFilterExpression, Node is the Node on which to evalute the XPath node) `selectNodes` performs the given XPath expression on the `List`of `Node`instances appending all the results together into a single list.
public static void	sort(List<Node> is the list of Nodes to sort list, String is the XPath expression used for comparison xpathExpression) `sort` sorts the given List of Nodes using an XPath expression as a `java.util.Comparator`.
public static void	sort(List<Node> is the list of Nodes to sort list, String is the XPath expression used for comparison expression, boolean if true then duplicate values (using the sortXPath for comparisions) will be removed from the List distinct) `sort` sorts the given List of Nodes using an XPath expression as a `java.util.Comparator`and optionally removing duplicates.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

DocumentHelper	back to summary
private DocumentHelper()

Method Detail

createAttribute	back to summary
public static Attribute createAttribute(Element owner, QName qname, String value)

createAttribute	back to summary
public static Attribute createAttribute(Element owner, String name, String value)

createCDATA	back to summary
public static CDATA createCDATA(String text)

createComment	back to summary
public static Comment createComment(String text)

createDocument	back to summary
public static Document createDocument()

createDocument	back to summary
public static Document createDocument(Element rootElement)

createElement	back to summary
public static Element createElement(QName qname)

createElement	back to summary
public static Element createElement(String name)

createEntity	back to summary
public static Entity createEntity(String name, String text)

createNamespace	back to summary
public static Namespace createNamespace(String prefix, String uri)

createPattern back to summary

createPattern	back to summary
public static Pattern createPattern(String xpathPattern) `createPattern` parses the given XPath expression to create an XSLT style `Pattern`instance which can then be used in an XSLT processing model. Parameters xpathPattern:String is the XPath pattern expression to create Returns:Pattern a new `Pattern` instance

public static Pattern createPattern(String xpathPattern)

createPattern parses the given XPath expression to create an XSLT style Patterninstance which can then be used in an XSLT processing model.

Parameters

xpathPattern:String: is the XPath pattern expression to create

Returns:Pattern

a new Pattern instance

createProcessingInstruction	back to summary
public static ProcessingInstruction createProcessingInstruction(String pi, String d)

createProcessingInstruction	back to summary
public static ProcessingInstruction createProcessingInstruction(String pi, Map<String, String> data)

createQName	back to summary
public static QName createQName(String localName, Namespace namespace)

createQName	back to summary
public static QName createQName(String localName)

createText	back to summary
public static Text createText(String text)

createXPath back to summary

createXPath	back to summary
public static XPath createXPath(String xpathExpression) throws InvalidXPathException `createXPath` parses an XPath expression and creates a new XPath `XPath` instance using the singleton `DocumentFactory`. Parameters xpathExpression:String is the XPath expression to create Returns:XPath a new `XPath` instance Exceptions InvalidXPathException: if the XPath expression is invalid

public static XPath createXPath(String xpathExpression) throws InvalidXPathException

createXPath parses an XPath expression and creates a new XPath XPath instance using the singleton DocumentFactory.

Parameters

xpathExpression:String: is the XPath expression to create

Returns:XPath

a new XPath instance

Exceptions

InvalidXPathException:: if the XPath expression is invalid

createXPath back to summary

createXPath	back to summary
public static XPath createXPath(String xpathExpression, VariableContext context) throws InvalidXPathException `createXPath` parses an XPath expression and creates a new XPath `XPath` instance using the singleton `DocumentFactory`. Parameters xpathExpression:String is the XPath expression to create context:VariableContext is the variable context to use when evaluating the XPath Returns:XPath a new `XPath` instance Exceptions InvalidXPathException: if the XPath expression is invalid

public static XPath createXPath(String xpathExpression, VariableContext context) throws InvalidXPathException

createXPath parses an XPath expression and creates a new XPath XPath instance using the singleton DocumentFactory.

Parameters

xpathExpression:String: is the XPath expression to create
context:VariableContext: is the variable context to use when evaluating the XPath

Returns:XPath

a new XPath instance

Exceptions

InvalidXPathException:: if the XPath expression is invalid

createXPathFilter back to summary

createXPathFilter	back to summary
public static NodeFilter createXPathFilter(String xpathFilterExpression) `createXPathFilter` parses a NodeFilter from the given XPath filter expression using the singleton `DocumentFactory`. XPath filter expressions occur within XPath expressions such as `self::node()[ filterExpression ]` Parameters xpathFilterExpression:String is the XPath filter expression to create Returns:NodeFilter a new `NodeFilter` instance

public static NodeFilter createXPathFilter(String xpathFilterExpression)

createXPathFilter parses a NodeFilter from the given XPath filter expression using the singleton DocumentFactory. XPath filter expressions occur within XPath expressions such as self::node()[ filterExpression ]

Parameters

xpathFilterExpression:String: is the XPath filter expression to create

Returns:NodeFilter

a new NodeFilter instance

getDocumentFactory	back to summary
private static DocumentFactory getDocumentFactory()

getEncoding	back to summary
private static String getEncoding(String text)

makeElement back to summary

makeElement	back to summary
public static Element makeElement(Branch source, String path) makeElement a helper method which navigates from the given Document or Element node to some Element using the path expression, creating any necessary elements along the way. For example the path `a/b/c` would get the first child <a> element, which would be created if it did not exist, then the next child <b> and so on until finally a <c> element is returned. Parameters source:Branch is the Element or Document to start navigating from path:String is a simple path expression, seperated by '/' which denotes the path from the source to the resulting element such as a/b/c Returns:Element the first Element on the given path which either already existed on the path or were created by this method.

public static Element makeElement(Branch source, String path)

makeElement

a helper method which navigates from the given Document or Element node to some Element using the path expression, creating any necessary elements along the way. For example the path a/b/c would get the first child <a> element, which would be created if it did not exist, then the next child <b> and so on until finally a <c> element is returned.

Parameters

source:Branch: is the Element or Document to start navigating from
path:String: is a simple path expression, seperated by '/' which denotes the path from the source to the resulting element such as a/b/c

Returns:Element

the first Element on the given path which either already existed on the path or were created by this method.

parseText back to summary

parseText	back to summary
public static Document parseText(String text) throws DocumentException `parseText` parses the given text as an XML document and returns the newly created Document. Loading external DTD and entities is disabled (if it is possible) for security reasons. Parameters text:String the XML text to be parsed Returns:Document a newly parsed Document Exceptions DocumentException: if the document could not be parsed

public static Document parseText(String text) throws DocumentException

parseText parses the given text as an XML document and returns the newly created Document.

Loading external DTD and entities is disabled (if it is possible) for security reasons.

Parameters

text:String: the XML text to be parsed

Returns:Document

a newly parsed Document

Exceptions

DocumentException:: if the document could not be parsed

selectNodes back to summary

selectNodes	back to summary
public static List<Node> selectNodes(String xpathFilterExpression, List<Node> nodes) `selectNodes` performs the given XPath expression on the `List`of `Node`instances appending all the results together into a single list. Parameters xpathFilterExpression:String is the XPath filter expression to evaluate nodes:List<Node> is the list of nodes on which to evalute the XPath Returns:List<Node> the results of all the XPath evaluations as a single list

public static List<Node> selectNodes(String xpathFilterExpression, List<Node> nodes)

selectNodes performs the given XPath expression on the Listof Nodeinstances appending all the results together into a single list.

Parameters

xpathFilterExpression:String: is the XPath filter expression to evaluate
nodes:List<Node>: is the list of nodes on which to evalute the XPath

Returns:List<Node>

the results of all the XPath evaluations as a single list

selectNodes back to summary

selectNodes	back to summary
public static List<Node> selectNodes(String xpathFilterExpression, Node node) `selectNodes` performs the given XPath expression on the `List`of `Node`instances appending all the results together into a single list. Parameters xpathFilterExpression:String is the XPath filter expression to evaluate node:Node is the Node on which to evalute the XPath Returns:List<Node> the results of all the XPath evaluations as a single list

public static List<Node> selectNodes(String xpathFilterExpression, Node node)

selectNodes performs the given XPath expression on the Listof Nodeinstances appending all the results together into a single list.

Parameters

xpathFilterExpression:String: is the XPath filter expression to evaluate
node:Node: is the Node on which to evalute the XPath

Returns:List<Node>

the results of all the XPath evaluations as a single list

sort back to summary

sort	back to summary
public static void sort(List<Node> list, String xpathExpression) `sort` sorts the given List of Nodes using an XPath expression as a `java.util.Comparator`. Parameters list:List<Node> is the list of Nodes to sort xpathExpression:String is the XPath expression used for comparison

public static void sort(List<Node> list, String xpathExpression)

sort sorts the given List of Nodes using an XPath expression as a java.util.Comparator.

Parameters

list:List<Node>: is the list of Nodes to sort
xpathExpression:String: is the XPath expression used for comparison

sort back to summary

sort	back to summary
public static void sort(List<Node> list, String expression, boolean distinct) `sort` sorts the given List of Nodes using an XPath expression as a `java.util.Comparator`and optionally removing duplicates. Parameters list:List<Node> is the list of Nodes to sort expression:String is the XPath expression used for comparison distinct:boolean if true then duplicate values (using the sortXPath for comparisions) will be removed from the List

public static void sort(List<Node> list, String expression, boolean distinct)

sort sorts the given List of Nodes using an XPath expression as a java.util.Comparatorand optionally removing duplicates.

Parameters

list:List<Node>: is the list of Nodes to sort
expression:String: is the XPath expression used for comparison
distinct:boolean: if true then duplicate values (using the sortXPath for comparisions) will be removed from the List

public final Class DocumentHelper

Constructor Summary

Method Summary

Constructor Detail

Method Detail