XDMModel (XML Document Model (XDM))

java.lang.Object
- org.netbeans.modules.xml.xdm.XDMModel

```
public class XDMModel
extends Object
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class XDMModel.Status
This represents the status of the XDM Model.

Nested Classes
Modifier and Type	Class and Description
`static class`	`XDMModel.Status` This represents the status of the XDM Model.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_INDENT`
`static String`	`PROP_ADDED` Indicates node added
`static String`	`PROP_DELETED` Indicates node deleted
`static String`	`PROP_MODIFIED` Indicates node modified

Constructor Summary

Constructors
Constructor and Description

XDMModel(ModelSource ms)

Constructors
Constructor and Description
`XDMModel(ModelSource ms)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<Node>`	`add(Node parent, Node node, int offset)` This api adds given node to given parent at given index.
`void`	`addPropertyChangeListener(PropertyChangeListener pcl)` This api adds a property change listener.
`void`	`addUndoableEditListener(UndoableEditListener l)` This api adds an undoable edit listener.
`List<Node>`	`append(Node parent, Node node)` This api adds given node to given parent at the end.
`List<Node>`	`delete(Node n)` This api deletes given node from a tree.
`void`	`flush()` This api flushes the changes made to the model to the underlying document.
`Document`	`getCurrentDocument()` This api returns the current document in the model, regardless of the state.
`String`	`getCurrentDocumentText()`
`Document`	`getDocument()` This api returns the latest stable document in the model.
`ElementIdentity`	`getElementIdentity()`
`String`	`getIndentation()`
`int`	`getNextNodeId()` This api keeps track of the nodes created in this model.
`Map<QName,List<QName>>`	`getQNameValuedAttributes()`
`XDMModel.Status`	`getStatus()` This returns the statuc of the model.
`List<Node>`	`insertBefore(Node parent, Node node, Node refChild)` This api adds given node to given parent before given ref node.
`void`	`mergeDiff(List<Difference> diffs)`
`List<Node>`	`modify(Node oldValue, Node newValue)` This api replaces given old node with given new node.
`void`	`prepareSync()`
`List<Node>`	`remove(Node parent, Node child)` This api deletes given node from a given parent node.
`List<Node>`	`removeAttribute(Element element, String name)` This api removes an attribute given name and value of a given element node.
`List<Node>`	`removeChildNodes(Node parent, Collection<Node> toRemove)` This api deletes given node from a given parent node.
`void`	`removePropertyChangeListener(PropertyChangeListener pcl)` This api removes a property change listener.
`void`	`removeUndoableEditListener(UndoableEditListener l)` This api removes an undoable edit listener.
`List<Node>`	`reorder(Node parent, Node n, int index)` This api changes index of the given node.
`List<Node>`	`reorderChildren(Node parent, int[] permutation)` This api changes indexes of the given node children.
`List<Node>`	`replaceChild(Node parent, Node child, Node newChild)`
`List<Node>`	`setAttribute(Element element, String name, String value)` This api sets an attribute given name and value of a given element node.
`void`	`setDocument(Document newDoc)`
`void`	`setElementIdentity(ElementIdentity eID)`
`void`	`setIndentation(String indent)`
`void`	`setPretty(boolean print)`
`void`	`setQNameValuedAttributes(Map<QName,List<QName>> attrsByElement)` Set/get mapping of QName-valued attributes by element.
`List<Node>`	`setTextValue(Node node, String value)`
`List<Node>`	`setXmlFragmentText(Element node, String value)`
`void`	`sync()` This api syncs the model with the underlying swing document.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PROP_MODIFIED
```
public static final String PROP_MODIFIED
```
    Indicates node modified
    
    See Also:
    
    Constant Field Values
  - PROP_DELETED
```
public static final String PROP_DELETED
```
    Indicates node deleted
    
    See Also:
    
    Constant Field Values
  - PROP_ADDED
```
public static final String PROP_ADDED
```
    Indicates node added
    
    See Also:
    
    Constant Field Values
  - DEFAULT_INDENT
```
public static final String DEFAULT_INDENT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - XDMModel
```
public XDMModel(ModelSource ms)
```
    Parameters:
    
    ms - requires an instance of org.netbeans.editor.BaseDocument to be available in the lookup;
- Method Detail
  - getIndentation
```
public String getIndentation()
```
  - setIndentation
```
public void setIndentation(String indent)
```
  - flush
```
public void flush()
```
    This api flushes the changes made to the model to the underlying document.
  - sync
```
public void sync()
          throws IOException
```
    This api syncs the model with the underlying swing document. If its the first time sync is called, swing document is parsed and model is initialized. Otherwise the changes made to swing document are applied to the model using DiffMerger.
    
    Throws:
    
    IOException
  - prepareSync
```
public void prepareSync()
```
  - mergeDiff
```
public void mergeDiff(List<Difference> diffs)
```
  - modify
```
public List<Node> modify(Node oldValue,
                         Node newValue)
```
    This api replaces given old node with given new node. The old node passed must be in tree, the new node must not be in tree, and new node must be clone of old node.
    
    Parameters:
    
    oldValue - The old node to be replaced.
    
    newValue - The new node.
    
    Returns:
    
    The new parent
  - add
```
public List<Node> add(Node parent,
                      Node node,
                      int offset)
```
    This api adds given node to given parent at given index. The added node will be part of childnodes of the parent, and its index will be the given index. If the given index is out of the parents childnodes range, the node will be appended.
    
    Parameters:
    
    parent - The parent node to which the node is to be added.
    
    node - The node which is to be added.
    
    offset - The index at which the node is to be added.
    
    Returns:
    
    The parent node resulted by addition of this node
  - insertBefore
```
public List<Node> insertBefore(Node parent,
                               Node node,
                               Node refChild)
```
    This api adds given node to given parent before given ref node. The inserted node will be part of childnodes of the parent, and will appear before ref node.
    
    Parameters:
    
    parent - The parent node to which the node is to be added.
    
    node - The node which is to be added.
    
    refChild - The ref node (child) of parent node, before which the node is to be added.
    
    Returns:
    
    The parent node resulted by inserion of this node.
  - append
```
public List<Node> append(Node parent,
                         Node node)
```
    This api adds given node to given parent at the end. The added node will be part of childnodes of the parent, and it will be the last node.
    
    Parameters:
    
    parent - The parent node to which the node is to be appended.
    
    node - The node which is to be appended.
    
    Returns:
    
    The parent node resulted by addition of this node
  - delete
```
public List<Node> delete(Node n)
```
    This api deletes given node from a tree.
    
    Parameters:
    
    n - The node to be deleted.
    
    Returns:
    
    The parent node resulted by deletion of this node.
  - reorder
```
public List<Node> reorder(Node parent,
                          Node n,
                          int index)
```
    This api changes index of the given node.
    
    Parameters:
    
    n - The nodes to be moved.
    
    index - the new indexe of the node.
    
    Returns:
    
    The parent node resulted by deletion of this node.
  - reorderChildren
```
public List<Node> reorderChildren(Node parent,
                                  int[] permutation)
```
    This api changes indexes of the given node children.
    
    Parameters:
    
    parent - The parent node from which the nodes is to be reordered.
    
    permutation - integer array with index represents current index and value is final index after reordered
    
    Returns:
    
    The parent node resulted by deletion of this node.
  - remove
```
public List<Node> remove(Node parent,
                         Node child)
```
    This api deletes given node from a given parent node.
    
    Parameters:
    
    parent - The parent node from which the node is to be deleted.
    
    child - The node to be deleted.
    
    Returns:
    
    The parent node resulted by deletion of this node.
  - removeChildNodes
```
public List<Node> removeChildNodes(Node parent,
                                   Collection<Node> toRemove)
```
    This api deletes given node from a given parent node.
    
    Parameters:
    
    parent - The parent node from which the node is to be deleted.
    
    toRemove - collection of node to be deleted.
    
    Returns:
    
    The parent node resulted by deletion of this node.
  - replaceChild
```
public List<Node> replaceChild(Node parent,
                               Node child,
                               Node newChild)
```
  - setAttribute
```
public List<Node> setAttribute(Element element,
                               String name,
                               String value)
```
    This api sets an attribute given name and value of a given element node. If an attribute with given name already present in element, it will only set the value. Otherwise a new attribute node, with given name and value, will be appended to the attibute list of the element node.
    
    Parameters:
    
    element - The element of which the attribute to be set.
    
    name - The name of the attribute to be set.
    
    value - The value of the attribute to be set.
    
    Returns:
    
    The element resulted by setting of attribute.
  - removeAttribute
```
public List<Node> removeAttribute(Element element,
                                  String name)
```
    This api removes an attribute given name and value of a given element node.
    
    Parameters:
    
    element - The element of which the attribute to be removed.
    
    name - The name of the attribute to be removed.
    
    Returns:
    
    The element resulted by removed of attribute.
  - setXmlFragmentText
```
public List<Node> setXmlFragmentText(Element node,
                                     String value)
                              throws IOException
```
    Throws:
    
    IOException
  - setTextValue
```
public List<Node> setTextValue(Node node,
                               String value)
```
  - getDocument
```
public Document getDocument()
```
    This api returns the latest stable document in the model. An IllegalStateException can be thrown in case the model isn't in a STABLE or PARSING state.
    
    Returns:
    
    The latest stable document in the model.
  - getCurrentDocument
```
public Document getCurrentDocument()
```
    This api returns the current document in the model, regardless of the state.
    
    Returns:
    
    The latest stable document in the model.
  - getCurrentDocumentText
```
public String getCurrentDocumentText()
```
  - setDocument
```
public void setDocument(Document newDoc)
```
  - getStatus
```
public XDMModel.Status getStatus()
```
    This returns the statuc of the model.
    
    Returns:
    
    the status.
    
    See Also:
    
    XDMModel.Status
  - addUndoableEditListener
```
public void addUndoableEditListener(UndoableEditListener l)
```
    This api adds an undoable edit listener.
    
    Parameters:
    
    l - The undoable edit listener to be added.
  - removeUndoableEditListener
```
public void removeUndoableEditListener(UndoableEditListener l)
```
    This api removes an undoable edit listener.
    
    Parameters:
    
    l - The undoable edit listener to be removed.
  - addPropertyChangeListener
```
public void addPropertyChangeListener(PropertyChangeListener pcl)
```
    This api adds a property change listener.
    
    Parameters:
    
    pcl - The property change listener to be added.
  - removePropertyChangeListener
```
public void removePropertyChangeListener(PropertyChangeListener pcl)
```
    This api removes a property change listener.
    
    Parameters:
    
    pcl - The property change listener to be removed.
  - getNextNodeId
```
public int getNextNodeId()
```
    This api keeps track of the nodes created in this model.
    
    Returns:
    
    the id of the next node to be created.
  - setPretty
```
public void setPretty(boolean print)
```
  - getElementIdentity
```
public ElementIdentity getElementIdentity()
```
  - setElementIdentity
```
public void setElementIdentity(ElementIdentity eID)
```
  - setQNameValuedAttributes
```
public void setQNameValuedAttributes(Map<QName,List<QName>> attrsByElement)
```
    Set/get mapping of QName-valued attributes by element. Key of the mapping is QName of the element. Value of the mapping is list QName's of the attributes. If the mapping is set, it will be used to identify the attribute values affected by namespace prefix refactoring during namespace consolidation. If not set, namespace consolidation would skip prefix rename refactoring case.
  - getQNameValuedAttributes
```
public Map<QName,List<QName>> getQNameValuedAttributes()
```

Class XDMModel

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROP_MODIFIED

PROP_DELETED

PROP_ADDED

DEFAULT_INDENT

Constructor Detail

XDMModel

Method Detail

getIndentation

setIndentation

flush

sync

prepareSync

mergeDiff

modify

add

insertBefore

append

delete

reorder

reorderChildren

remove

removeChildNodes

replaceChild

setAttribute

removeAttribute

setXmlFragmentText

setTextValue

getDocument

getCurrentDocument

getCurrentDocumentText

setDocument

getStatus

addUndoableEditListener

removeUndoableEditListener

addPropertyChangeListener

removePropertyChangeListener

getNextNodeId

setPretty

getElementIdentity

setElementIdentity

setQNameValuedAttributes

getQNameValuedAttributes