org.xmlfield.core.api

Interface XmlFieldNodeModifier

All Known Implementing Classes:

DomNodeModifier

public interface XmlFieldNodeModifier

Modifier interface, this interface describe the diffrent operation needed to be done on an XML document.

Author:

Guillaume Mary

Method Summary

Methods

Modifier and Type	Method and Description
void	createAttribute(XmlFieldNode contextNode, String attributeName, String textContent) Create an attribute to a node
XmlFieldNode	createElement(NamespaceMap namespaces, XmlFieldNode node, String elementName) Create a new element node at the end of the root node.
XmlFieldNode	createElement(NamespaceMap namespaces, XmlFieldNode node, String elementName, String textContent) Create a new element node at the end of the root node.
XmlFieldNode	insertBefore(XmlFieldNode parentNode, XmlFieldNode newChild, XmlFieldNode refChild) Insert a node before another node.
XmlFieldNode	removeAttribute(XmlFieldNode node, String attributeName) Remove an attribute from a specified node
XmlFieldNode	removeChild(XmlFieldNode contextNode, XmlFieldNode oldChild) Remove a child node
void	removeChildren(XmlFieldNodeList nodesToRemove) Remove a node list

Method Detail

createAttribute

void createAttribute(XmlFieldNode contextNode,
                   String attributeName,
                   String textContent)

Create an attribute to a node

Parameters:

contextNode - node where the attribute will be created

attributeName - name of the attribute

textContent - text content of the attribute

createElement

XmlFieldNode createElement(NamespaceMap namespaces,
                         XmlFieldNode node,
                         String elementName)

Create a new element node at the end of the root node.

Parameters:

namespaces - document namespaces

node - context node

elementName - element name

Returns:

the created element

createElement

XmlFieldNode createElement(NamespaceMap namespaces,
                         XmlFieldNode node,
                         String elementName,
                         String textContent)

Create a new element node at the end of the root node.

Parameters:

namespaces - document namespaces

node - context node

elementName - element name

textContent - text content of the new element

Returns:

the new element

insertBefore

XmlFieldNode insertBefore(XmlFieldNode parentNode,
                        XmlFieldNode newChild,
                        XmlFieldNode refChild)

Insert a node before another node.

Parameters:

parentNode - parent node of the nodes

newChild - node to insert

refChild - reference node where the node should be inserted before

Returns:

the inserted node

removeAttribute

XmlFieldNode removeAttribute(XmlFieldNode node,
                           String attributeName)

Remove an attribute from a specified node

Parameters:

node - node

attributeName - attribute name

Returns:

the attribute node removed

removeChild

XmlFieldNode removeChild(XmlFieldNode contextNode,
                       XmlFieldNode oldChild)

Remove a child node

Parameters:

contextNode - the context node

oldChild - child to be removed

Returns:

the removed node

removeChildren

void removeChildren(XmlFieldNodeList nodesToRemove)

Remove a node list

Parameters:

contextNode - the context node

nodesToRemove - node list of children to be removed