|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Updater
XML document updating and creating functionality, with an interface based on the XPath data model. The interface is intended to be sufficiently high-level, that implementations for different concrete document object models can be implemented.
Method Summary | |
---|---|
void |
appendChild(java.lang.Object parent,
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. |
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. |
Method Detail |
---|
java.lang.Object createDocument() throws UpdateException
UpdateException
- A document could not be created.java.lang.Object createComment(java.lang.Object contextNode, java.lang.String comment) throws InvalidContextException
contextNode
- 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.java.lang.Object createText(java.lang.Object contextNode, java.lang.String text) throws InvalidContextException
contextNode
- A node in the document in which the text will be used.comment
- The text to create.
InvalidContextException
- The contextNode parameter is not of a
class or interface that the document model recognizes for a node.java.lang.Object createElement(java.lang.Object contextNode, java.lang.String uri, java.lang.String qname) throws InvalidContextException
contextNode
- A node in the document in which the element will be
used.uri
- The namespace uri of the new element, or null
qname
- 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.java.lang.Object createNamespace(java.lang.Object contextNode, java.lang.String prefix, java.lang.String uri) throws InvalidContextException
contextNode
- 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.java.lang.Object createAttribute(java.lang.Object contextNode, java.lang.String uri, java.lang.String qname, java.lang.String value) throws InvalidContextException
contextNode
- 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.java.lang.Object createProcessingInstruction(java.lang.Object contextNode, java.lang.String target, java.lang.String data) throws InvalidContextException
contextNode
- 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.void insertBefore(java.lang.Object refNode, java.lang.Object node) throws UpdateException
refNode
- The reference node, before which the new node will be
inserted as a sibling.node
- The node that will be inserted.
InvalidNodeException
- A parameter that represents a node is not
of a class or interface that the document model recognizes for the
expected type of node.
UpdateException
- Another exception occurred during update.void insertAfter(java.lang.Object refNode, java.lang.Object node) throws UpdateException
refNode
- The reference node, after which the new node will be
inserted as a sibling.node
- The node that will be inserted.
InvalidNodeException
- A parameter that represents a node is not
of a class or interface that the document model recognizes for the
expected type of node.
UpdateException
- Another exception occurred during update.void appendChild(java.lang.Object parent, java.lang.Object child, int position) throws UpdateException
parent
- 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.
InvalidNodeException
- A parameter that represents a node is not
of a class or interface that the document model recognizes for the
expected type of node.
UpdateException
- Another exception occurred during update.void remove(java.lang.Object node) throws UpdateException
node
- The node to remove.
InvalidNodeException
- A parameter that represents a node is not
of a class or interface that the document model recognizes for the
expected type of node.
UpdateException
- Another exception occurred during update.void setAttribute(java.lang.Object element, java.lang.Object attribute) throws UpdateException
element
- The element node to set the attribute on.attribute
- The attribute node to set on the element.
InvalidNodeException
- A parameter that represents a node is not
of a class or interface that the document model recognizes for the
expected type of node.
UpdateException
- Another exception occurred during update.void setAttributeValue(java.lang.Object attribute, java.lang.String value) throws UpdateException
UpdateException
void setNamespace(java.lang.Object element, java.lang.Object namespace) throws UpdateException
element
- The element node to bind the namespace node to.namespace
- The namespace node to bind to the element node.
InvalidNodeException
- A parameter that represents a node is not
of a class or interface that the document model recognizes for the
expected type of node.
UpdateException
- Another exception occurred during update.Navigator getNavigator()
Navigator
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |