public class DocumentHelper extends Object
DocumentHelper
is a collection of helper methods
for using DOM4J.
Constructor and Description |
---|
DocumentHelper() |
Modifier and Type | Method and Description |
---|---|
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)
createPattern parses the given
XPath expression to create an XSLT style Pattern instance
which can then be used in an XSLT processing model. |
static ProcessingInstruction |
createProcessingInstruction(String target,
Map data) |
static ProcessingInstruction |
createProcessingInstruction(String target,
String data) |
static QName |
createQName(String localName) |
static QName |
createQName(String localName,
Namespace namespace) |
static Text |
createText(String text) |
static XPath |
createXPath(String xpathExpression)
createXPath parses an XPath expression
and creates a new XPath XPath instance
using the singleton DocumentFactory . |
static XPath |
createXPath(String xpathExpression,
org.jaxen.VariableContext variableContext)
createXPath parses an XPath expression
and creates a new XPath XPath instance
using the singleton DocumentFactory . |
static NodeFilter |
createXPathFilter(String xpathFilterExpression)
createXPathFilter parses a NodeFilter
from the given XPath filter expression using the singleton
DocumentFactory . |
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)
parseText parses the given text as an XML document
and returns the newly created Document. |
static List |
selectNodes(String xpathFilterExpression,
List nodes)
|
static List |
selectNodes(String xpathFilterExpression,
Node node)
|
static void |
sort(List list,
String xpathExpression)
sort sorts the given List of Nodes
using an XPath expression as a Comparator . |
static void |
sort(List list,
String xpathExpression,
boolean distinct)
sort sorts the given List of Nodes
using an XPath expression as a Comparator
and optionally removing duplicates. |
public DocumentHelper()
public static Document createDocument()
public static Document createDocument(Element rootElement)
public static Element createElement(QName qname)
public static Element createElement(String name)
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 Text createText(String text)
public static Entity createEntity(String name, String text)
public static Namespace createNamespace(String prefix, String uri)
public static ProcessingInstruction createProcessingInstruction(String target, String data)
public static ProcessingInstruction createProcessingInstruction(String target, Map data)
public static QName createQName(String localName, Namespace namespace)
public static QName createQName(String localName)
public static XPath createXPath(String xpathExpression) throws InvalidXPathException
createXPath
parses an XPath expression
and creates a new XPath XPath
instance
using the singleton DocumentFactory
.
xpathExpression
- is the XPath expression to createXPath
instanceInvalidXPathException
- if the XPath expression is invalidpublic static XPath createXPath(String xpathExpression, org.jaxen.VariableContext variableContext) throws InvalidXPathException
createXPath
parses an XPath expression
and creates a new XPath XPath
instance
using the singleton DocumentFactory
.
xpathExpression
- is the XPath expression to createvariableContext
- is the variable context to use when evaluating the XPathXPath
instanceInvalidXPathException
- if the XPath expression is invalidpublic 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 ]
xpathFilterExpression
- is the XPath filter expression
to createNodeFilter
instancepublic 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.
xpathPattern
- is the XPath pattern expression
to createPattern
instancepublic static List selectNodes(String xpathFilterExpression, List nodes)
selectNodes
performs the given XPath
expression on the List
of Node
instances appending
all the results together into a single list.
xpathFilterExpression
- is the XPath filter expression
to evaluatenodes
- is the list of nodes on which to evalute the XPathpublic static List 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.
xpathFilterExpression
- is the XPath filter expression
to evaluatenode
- is the Node on which to evalute the XPathpublic static void sort(List list, String xpathExpression)
sort
sorts the given List of Nodes
using an XPath expression as a Comparator
.
list
- is the list of Nodes to sortxpathExpression
- is the XPath expression used for comparisonpublic static void sort(List list, String xpathExpression, boolean distinct)
sort
sorts the given List of Nodes
using an XPath expression as a Comparator
and optionally removing duplicates.
list
- is the list of Nodes to sortxpathExpression
- is the XPath expression used for comparisondistinct
- if true then duplicate values (using the sortXPath for
comparisions) will be removed from the Listpublic static Document parseText(String text) throws DocumentException
parseText
parses the given text as an XML document
and returns the newly created Document.
text
- is the XML text to be parsedDocumentException
- if the document could not be parsedpublic 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 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.source
- is the Element or Document to start navigating fromis
- a simple path expression, seperated by '/' which denotes
the path from the source to the resulting element such as a/b/cWebARTS Library Licensed Under the GNU - General Public License. Other Libraries licensed under their respective Open Source Licenses