org.dom4j
public final class DocumentHelper extends Object
DocumentHelper
is a collection of helper methods for using
DOM4J.
Version: $Revision: 1.26 $
Method Summary | |
---|---|
static Attribute | createAttribute(Element owner, QName qname, String value) |
static Attribute | createAttribute(Element owner, String name, String value) |
static CDATA | createCDATA(String text) |
static Comment | createComment(String text) |
static Document | createDocument() |
static Document | createDocument(Element rootElement) |
static Element | createElement(QName qname) |
static Element | createElement(String name) |
static Entity | createEntity(String name, String text) |
static Namespace | createNamespace(String prefix, String uri) |
static Pattern | createPattern(String xpathPattern)
|
static ProcessingInstruction | createProcessingInstruction(String pi, String d) |
static ProcessingInstruction | createProcessingInstruction(String pi, Map data) |
static QName | createQName(String localName, Namespace namespace) |
static QName | createQName(String localName) |
static Text | createText(String text) |
static XPath | createXPath(String xpathExpression)
|
static XPath | createXPath(String xpathExpression, VariableContext context)
|
static NodeFilter | createXPathFilter(String xpathFilterExpression)
|
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. |
static Document | parseText(String text)
|
static List | selectNodes(String xpathFilterExpression, List nodes)
|
static List | selectNodes(String xpathFilterExpression, Node node)
|
static void | sort(List list, String xpathExpression)
|
static void | sort(List list, String expression, boolean distinct)
|
createPattern
parses the given XPath expression to create
an XSLT style Patterninstance which can then be used in an XSLT
processing model.
Parameters: xpathPattern is the XPath pattern expression to create
Returns: a new Pattern
instance
createXPath
parses an XPath expression and creates a new
XPath XPath
instance using the singleton DocumentFactory.
Parameters: xpathExpression is the XPath expression to create
Returns: a new XPath
instance
Throws: InvalidXPathException if the XPath expression is invalid
createXPath
parses an XPath expression and creates a new
XPath XPath
instance using the singleton DocumentFactory.
Parameters: xpathExpression is the XPath expression to create context is the variable context to use when evaluating the XPath
Returns: a new XPath
instance
Throws: InvalidXPathException if the XPath expression is invalid
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 is the XPath filter expression to create
Returns: a new NodeFilter
instance
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 patha/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 is the Element or Document to start navigating from path is a simple path expression, seperated by '/' which denotes the path from the source to the resulting element such as a/b/c
Returns: the first Element on the given path which either already existed on the path or were created by this method.
parseText
parses the given text as an XML document and
returns the newly created Document.
Parameters: text the XML text to be parsed
Returns: a newly parsed Document
Throws: DocumentException if the document could not be parsed
selectNodes
performs the given XPath expression on the
Listof Nodeinstances appending all the results together
into a single list.
Parameters: xpathFilterExpression is the XPath filter expression to evaluate nodes is the list of nodes on which to evalute the XPath
Returns: the results of all the XPath evaluations as a single list
selectNodes
performs the given XPath expression on the
Listof Nodeinstances appending all the results together
into a single list.
Parameters: xpathFilterExpression is the XPath filter expression to evaluate node is the Node on which to evalute the XPath
Returns: the results of all the XPath evaluations as a single list
sort
sorts the given List of Nodes using an XPath
expression as a java.util.Comparator.
Parameters: list is the list of Nodes to sort xpathExpression is the XPath expression used for comparison
sort
sorts the given List of Nodes using an XPath
expression as a java.util.Comparatorand optionally removing
duplicates.
Parameters: list is the list of Nodes to sort expression is the XPath expression used for comparison distinct if true then duplicate values (using the sortXPath for comparisions) will be removed from the List