Package | Description |
---|---|
org.dom4j |
Defines the XML Document Object Model in Java interfaces together
with some helper classes.
|
org.dom4j.datatype |
An implementation of the dom4j API which supports the
XML Schema Data Types specification.
|
org.dom4j.io |
Provides input and output via SAX and DOM together with writing dom4j
objects to streams as XML text.
|
org.dom4j.rule | |
org.dom4j.tree |
Contains the default implementations of the dom4j Document Object Model
together with some helpful base classes for those wishing to
implement their own document object model.
|
org.dom4j.util |
A collection of utility classes for the dom4j API.
|
Modifier and Type | Method and Description |
---|---|
Element |
Element.addAttribute(QName qName,
java.lang.String value)
Adds the attribute value of the given fully qualified name.
|
Element |
Element.addAttribute(java.lang.String name,
java.lang.String value)
Adds the attribute value of the given local name.
|
Element |
Element.addCDATA(java.lang.String cdata)
Adds a new
CDATA node with the given text to this element. |
Element |
Element.addComment(java.lang.String comment)
Adds a new
Comment node with the given text to this
element. |
Element |
Branch.addElement(QName qname)
Adds a new
Element node with the given QName to
this branch and returns a reference to the new node. |
Element |
Branch.addElement(java.lang.String name)
Adds a new
Element node with the given name to this branch
and returns a reference to the new node. |
Element |
Branch.addElement(java.lang.String qualifiedName,
java.lang.String namespaceURI)
Adds a new
Element node with the given qualified name and
namespace URI to this branch and returns a reference to the new node. |
Element |
Element.addEntity(java.lang.String name,
java.lang.String text)
Adds a new
Entity node with the given name and text to
this element and returns a reference to the new node. |
Element |
Element.addNamespace(java.lang.String prefix,
java.lang.String uri)
Adds a namespace to this element for use by its child content
|
Element |
Element.addProcessingInstruction(java.lang.String target,
java.util.Map data)
Adds a processing instruction for the given target
|
Element |
Element.addProcessingInstruction(java.lang.String target,
java.lang.String text)
Adds a processing instruction for the given target
|
Element |
Element.addText(java.lang.String text)
Adds a new
Text node with the given text to this element. |
Element |
Element.createCopy()
Creates a deep copy of this element The new element is detached from its
parent, and getParent() on the clone will return null.
|
Element |
Element.createCopy(QName qName)
Creates a deep copy of this element with the given fully qualified name.
|
Element |
Element.createCopy(java.lang.String name)
Creates a deep copy of this element with the given local name The new
element is detached from its parent, and getParent() on the clone will
return null.
|
static Element |
DocumentHelper.createElement(QName qname) |
Element |
DocumentFactory.createElement(QName qname) |
static Element |
DocumentHelper.createElement(java.lang.String name) |
Element |
DocumentFactory.createElement(java.lang.String name) |
Element |
DocumentFactory.createElement(java.lang.String qualifiedName,
java.lang.String namespaceURI) |
Element |
Element.element(QName qName)
Returns the first element for the given fully qualified name.
|
Element |
Element.element(java.lang.String name)
Returns the first element for the given local name and any namespace.
|
Element |
Branch.elementByID(java.lang.String elementID)
Returns the element of the given ID attribute value.
|
Element |
ElementPath.getCurrent()
DOCUMENT ME!
|
Element |
ElementPath.getElement(int depth)
DOCUMENT ME!
|
Element |
Node.getParent()
getParent returns the parent Element if
this node supports the parent relationship or null if it is the root
element or does not support the parent relationship. |
Element |
Document.getRootElement()
Returns the root
Element for this document. |
static Element |
DocumentHelper.makeElement(Branch source,
java.lang.String path)
makeElement
|
Modifier and Type | Method and Description |
---|---|
void |
Branch.add(Element element)
Adds the given
Element to this branch. |
void |
Element.appendAttributes(Element element)
Appends the attributes of the given element to me.
|
Node |
Node.asXPathResult(Element parent)
asXPathResult returns a version of this node which is
capable of being an XPath result. |
static Attribute |
DocumentHelper.createAttribute(Element owner,
QName qname,
java.lang.String value) |
Attribute |
DocumentFactory.createAttribute(Element owner,
QName qname,
java.lang.String value) |
static Attribute |
DocumentHelper.createAttribute(Element owner,
java.lang.String name,
java.lang.String value) |
Attribute |
DocumentFactory.createAttribute(Element owner,
java.lang.String name,
java.lang.String value) |
static Document |
DocumentHelper.createDocument(Element rootElement) |
Document |
DocumentFactory.createDocument(Element rootElement) |
protected Node |
Namespace.createXPathResult(Element parent) |
java.lang.String |
Node.getPath(Element context)
Returns the relative XPath expression which will return a node set
containing the given node such as a/b/@c.
|
java.lang.String |
Namespace.getPath(Element context) |
java.lang.String |
Node.getUniquePath(Element context)
Returns the relative unique XPath expression from the given context which
will return a nodeset of one node which is the current node.
|
java.lang.String |
Namespace.getUniquePath(Element context) |
boolean |
Branch.remove(Element element)
Removes the given
Element if the node is an immediate
child of this branch. |
void |
Node.setParent(Element parent)
setParent sets the parent relationship of this node if the
parent relationship is supported or does nothing if the parent
relationship is not supported. |
void |
Document.setRootElement(Element rootElement)
Sets the root element for this document
|
void |
VisitorSupport.visit(Element node) |
void |
Visitor.visit(Element node)
Visits the given
Element |
Constructor and Description |
---|
IllegalAddException(Element parent,
Node node,
java.lang.String reason) |
Modifier and Type | Class and Description |
---|---|
class |
DatatypeElement
DatatypeElement represents an Element which supports the XML Schema Data Types
specification. |
Modifier and Type | Method and Description |
---|---|
Element |
DatatypeElement.addText(java.lang.String text) |
Element |
DatatypeElementFactory.createElement(QName qname) |
Element |
DatatypeAttribute.getParent() |
Modifier and Type | Method and Description |
---|---|
Attribute |
DatatypeElementFactory.createAttribute(Element owner,
QName qname,
java.lang.String value) |
Attribute |
DatatypeDocumentFactory.createAttribute(Element owner,
QName qname,
java.lang.String value) |
void |
DatatypeAttribute.setParent(Element parent) |
Modifier and Type | Method and Description |
---|---|
Element |
STAXEventReader.createElement(javax.xml.stream.events.StartElement startEvent)
Constructs a new DOM4J Element from the provided StartElement event.
|
Element |
ElementModifier.modifyElement(Element element)
Called by an event based processor when an elements closing tag is
encountered.
|
Element |
STAXEventReader.readElement(javax.xml.stream.XMLEventReader eventReader)
Reads a DOM4J Element from the provided event stream.
|
Modifier and Type | Method and Description |
---|---|
protected void |
SAXContentHandler.addAttributes(Element element,
org.xml.sax.Attributes attributes)
Add all the attributes to the given elements
|
protected void |
SAXContentHandler.addDeclaredNamespaces(Element element)
Add all namespaces declared before the startElement() SAX event to the
current element so that they are available to child elements and
attributes
|
protected void |
DOMWriter.appendDOMTree(org.w3c.dom.Document domDocument,
org.w3c.dom.Node domCurrent,
Element element) |
Attribute |
STAXEventReader.createAttribute(Element elem,
javax.xml.stream.events.Attribute attr)
Constructs a new DOM4J Attribute from the provided StAX Attribute event.
|
protected org.xml.sax.Attributes |
SAXWriter.createAttributes(Element element,
org.xml.sax.Attributes namespaceAttributes) |
javax.xml.stream.events.EndElement |
STAXEventWriter.createEndElement(Element elem)
Constructs a STAX
EndElement event from a DOM4J Element . |
javax.xml.stream.events.StartElement |
STAXEventWriter.createStartElement(Element elem)
Constructs a STAX
StartElement event from a DOM4J Element . |
protected void |
SAXWriter.endElement(Element element) |
protected boolean |
XMLWriter.isElementSpacePreserved(Element element)
Determines if element is a special case of XML elements where it contains
an xml:space attribute of "preserve".
|
Element |
ElementModifier.modifyElement(Element element)
Called by an event based processor when an elements closing tag is
encountered.
|
protected void |
SAXWriter.startElement(Element element,
org.xml.sax.helpers.AttributesImpl namespaceAttributes) |
protected org.xml.sax.helpers.AttributesImpl |
SAXWriter.startPrefixMapping(Element element,
org.dom4j.tree.NamespaceStack namespaceStack)
Fires a SAX startPrefixMapping event for all the namespaceStack which
have just come into scope
|
void |
XMLWriter.write(Element element)
|
void |
SAXWriter.write(Element element)
Generates SAX events for the given Element and all its content
|
protected void |
SAXWriter.write(Element element,
org.dom4j.tree.NamespaceStack namespaceStack) |
protected void |
XMLWriter.writeAttributes(Element element)
Writes the attributes of the given element
|
void |
XMLWriter.writeClose(Element element)
Writes the closing tag of an
Element |
void |
SAXWriter.writeClose(Element element)
Writes the closing tag of an
Element |
protected void |
XMLWriter.writeElement(Element element) |
protected void |
HTMLWriter.writeElement(Element element)
This override handles any elements that should not remove whitespace,
such as <PRE>, <SCRIPT>, <STYLE>, and <TEXTAREA>.
|
void |
STAXEventWriter.writeElement(Element elem)
Writes a DOM4J
Element node and its children to the stream. |
protected void |
XMLWriter.writeElementContent(Element element)
Outputs the content of the given element.
|
void |
XMLWriter.writeOpen(Element element)
|
void |
SAXWriter.writeOpen(Element element)
|
Modifier and Type | Method and Description |
---|---|
void |
Mode.applyTemplates(Element element) |
Modifier and Type | Class and Description |
---|---|
class |
org.dom4j.tree.AbstractElement
AbstractElement is an abstract base class for tree
implementors to use for implementation inheritence. |
class |
org.dom4j.tree.BaseElement
BaseElement is a useful base class for implemementation
inheritence of an XML element. |
class |
org.dom4j.tree.DefaultElement
DefaultElement is the default DOM4J default implementation of
an XML element. |
Modifier and Type | Class and Description |
---|---|
class |
IndexedElement
IndexedElement is an implementation of Element which
maintains an index of the attributes and elements it contains to optimise
lookups via name. |
class |
NonLazyElement
NonLazyElement is the default DOM4J default implementation of
an XML element. |
class |
UserDataElement
UserDataElement support the adornment of a user data object on
an Element or Attribute instance such that the methods
UserDataElement.setData(Object) will get and set the values of a user data object. |
Modifier and Type | Method and Description |
---|---|
protected Element |
IndexedElement.asElement(java.lang.Object object) |
Element |
NonLazyDocumentFactory.createElement(QName qname) |
Element |
ProxyDocumentFactory.createElement(QName qname) |
Element |
IndexedDocumentFactory.createElement(QName qname) |
protected Element |
UserDataElement.createElement(QName qName) |
Element |
UserDataDocumentFactory.createElement(QName qname) |
Element |
IndexedDocumentFactory.createElement(QName qname,
int attributeCount) |
Element |
ProxyDocumentFactory.createElement(java.lang.String name) |
protected Element |
UserDataElement.createElement(java.lang.String name) |
Element |
IndexedElement.element(QName qName) |
Element |
IndexedElement.element(java.lang.String name) |
Element |
XMLErrorHandler.getErrors() |
Modifier and Type | Method and Description |
---|---|
protected void |
XMLErrorHandler.addException(Element element,
org.xml.sax.SAXParseException e)
Adds the given parse exception information to the given element instance
|
protected void |
IndexedElement.addToElementIndex(Element element) |
protected void |
IndexedElement.addToElementIndex(java.lang.Object key,
Element value) |
static boolean |
AttributeHelper.booleanValue(Element element,
QName attributeQName) |
static boolean |
AttributeHelper.booleanValue(Element element,
java.lang.String attributeName) |
int |
NodeComparator.compare(Element n1,
Element n2) |
Attribute |
ProxyDocumentFactory.createAttribute(Element owner,
QName qname,
java.lang.String value) |
Attribute |
UserDataDocumentFactory.createAttribute(Element owner,
QName qname,
java.lang.String value) |
Attribute |
ProxyDocumentFactory.createAttribute(Element owner,
java.lang.String name,
java.lang.String value) |
Document |
ProxyDocumentFactory.createDocument(Element rootElement) |
protected void |
IndexedElement.removeFromElementIndex(Element element) |
protected void |
IndexedElement.removeFromElementIndex(java.lang.Object key,
Element value) |
void |
XMLErrorHandler.setErrors(Element errors) |
Constructor and Description |
---|
XMLErrorHandler(Element errors) |
Copyright ? 2005 MetaStuff Ltd. All Rights Reserved. Hosted by