|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectorg.jaxup.dom4j.Dom4JDocumentUpdater
XML document creating and updating methods for the DOM4J document object model.
| Constructor Summary | |
Dom4JDocumentUpdater()
|
|
| Method Summary | |
void |
appendChild(java.lang.Object element,
java.lang.Object child,
int position)
Inserts a node into the document by appending it to the children of the parent, or if the position parameter isn't -1, by inserting it at that position in the list of children of the parent. |
java.lang.Object |
createAttribute(java.lang.Object contextNode,
java.lang.String uri,
java.lang.String qname,
java.lang.String value)
Creates an attribute node. |
java.lang.Object |
createComment(java.lang.Object contextNode,
java.lang.String comment)
Creates a comment node with the given text as the comment. |
java.lang.Object |
createDocument()
Creates an empty XML document. |
java.lang.Object |
createElement(java.lang.Object contextNode,
java.lang.String uri,
java.lang.String qname)
Creates an element node. |
java.lang.Object |
createNamespace(java.lang.Object contextNode,
java.lang.String prefix,
java.lang.String uri)
Creates a namespace node. |
java.lang.Object |
createProcessingInstruction(java.lang.Object contextNode,
java.lang.String target,
java.lang.String data)
Creates a processing-instruction node of the given target and data. |
java.lang.Object |
createText(java.lang.Object contextNode,
java.lang.String text)
Creates a text node of the given text. |
static Navigator |
getModifiedNavigator()
|
Navigator |
getNavigator()
Returns a jaxen Navigator instance that can be used to navigate the document that is being updated by this Updater. |
void |
insertAfter(java.lang.Object refNode,
java.lang.Object node)
Inserts a node into the document after the refNode, as a sibling of the ref Node. |
void |
insertBefore(java.lang.Object refNode,
java.lang.Object node)
Inserts a node into the document before the refNode, as a sibling of the ref Node. |
void |
remove(java.lang.Object node)
Removes a node from the document that it is in. |
void |
setAttribute(java.lang.Object element,
java.lang.Object attribute)
Sets an attribute on an element node, replacing an existing attribute with the same name. |
void |
setAttributeValue(java.lang.Object attribute,
java.lang.String value)
Changes the value of an existing attribute. |
void |
setNamespace(java.lang.Object element,
java.lang.Object namespace)
Binds a namespace node to an element node. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public Dom4JDocumentUpdater()
| Method Detail |
public java.lang.Object createDocument()
throws UpdateException
Updater
createDocument in interface UpdaterUpdateException - A document could not be created.public static Navigator getModifiedNavigator()
public Navigator getNavigator()
Updater
getNavigator in interface UpdaterNavigator
public java.lang.Object createComment(java.lang.Object contextNode,
java.lang.String comment)
throws InvalidContextException
Updater
createComment in interface UpdatercontextNode - A node in the document in which the comment will be
used.comment - The text of the comment to create.
InvalidContextException - The contextNode parameter is not of a
class or interface that the document model recognizes for a node.
public java.lang.Object createText(java.lang.Object contextNode,
java.lang.String text)
throws InvalidContextException
Updater
createText in interface UpdatercontextNode - A node in the document in which the text will be used.
InvalidContextException - The contextNode parameter is not of a
class or interface that the document model recognizes for a node.
public java.lang.Object createElement(java.lang.Object contextNode,
java.lang.String uri,
java.lang.String qname)
throws InvalidContextException
Updater
createElement in interface UpdatercontextNode - A node in the document in which the element will be
used.uri - The namespace uri of the new element, or nullqname - The qualified name (prefix, semicolon, localname) of the new
element.
InvalidContextException - The contextNode parameter is not of a
class or interface that the document model recognizes for a node.
public java.lang.Object createNamespace(java.lang.Object contextNode,
java.lang.String prefix,
java.lang.String uri)
throws InvalidContextException
Updater
createNamespace in interface UpdatercontextNode - A node in the document in which the namespace will be
used.prefix - The namespace prefix that will be bound to the namespace
uri.uri - The namespace uri of the new namespace node.
InvalidContextException - The contextNode parameter is not of a
class or interface that the document model recognizes for a node.
public java.lang.Object createAttribute(java.lang.Object contextNode,
java.lang.String uri,
java.lang.String qname,
java.lang.String value)
throws InvalidContextException
Updater
createAttribute in interface UpdatercontextNode - A node in the document in which the attribute will be
used.uri - The namespace uri of the new attribute, or null
to indicate that the attribute will not be in a namespace.qname - The qualified name (prefix, semicolon, localname) of the new
attribute.value - The value of the new attribute.
InvalidContextException - The contextNode parameter is not of a
class or interface that the document model recognizes for a node.
public java.lang.Object createProcessingInstruction(java.lang.Object contextNode,
java.lang.String target,
java.lang.String data)
throws InvalidContextException
Updater
createProcessingInstruction in interface UpdatercontextNode - A node in the document in which the text will be used.target - The target for the processing instruction to create.data - The data for the processing instruction to create. The format
of the data depends on the syntax defined by the target; many targets
define a syntax simular to the attribute list of an element node.
InvalidContextException - The contextNode parameter is not of a
class or interface that the document model recognizes for a node.
public void insertBefore(java.lang.Object refNode,
java.lang.Object node)
throws UpdateException
Updater
insertBefore in interface UpdaterrefNode - The reference node, before which the new node will be
inserted as a sibling.node - The node that will be inserted.
UpdateException - Another exception occurred during update.
public void insertAfter(java.lang.Object refNode,
java.lang.Object node)
throws UpdateException
Updater
insertAfter in interface UpdaterrefNode - The reference node, after which the new node will be
inserted as a sibling.node - The node that will be inserted.
UpdateException - Another exception occurred during update.
public void appendChild(java.lang.Object element,
java.lang.Object child,
int position)
throws UpdateException
Updater
appendChild in interface Updaterelement - The parent node, which must be either a document
or element node.child - The node that will be appended / inserted.position - The position in the child list where the child node will
be inserted, or -1 to append the new child to the list of children.
UpdateException - Another exception occurred during update.
public void remove(java.lang.Object node)
throws UpdateException
Updater
remove in interface Updaternode - The node to remove.
UpdateException - Another exception occurred during update.
public void setAttribute(java.lang.Object element,
java.lang.Object attribute)
throws UpdateException
Updater
setAttribute in interface Updaterelement - The element node to set the attribute on.attribute - The attribute node to set on the element.
UpdateException - Another exception occurred during update.
public void setNamespace(java.lang.Object element,
java.lang.Object namespace)
throws UpdateException
Updater
setNamespace in interface Updaterelement - The element node to bind the namespace node to.namespace - The namespace node to bind to the element node.
UpdateException - Another exception occurred during update.
public void setAttributeValue(java.lang.Object attribute,
java.lang.String value)
throws UpdateException
Updater
setAttributeValue in interface UpdaterUpdateException
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||