org.netbeans.modules.xml.xam.dom
Class ReadOnlyAccess

java.lang.Object
  org.netbeans.modules.xml.xam.ModelAccess
      org.netbeans.modules.xml.xam.dom.DocumentModelAccess
          org.netbeans.modules.xml.xam.dom.ReadOnlyAccess

public class ReadOnlyAccess
extends DocumentModelAccess

Default document model access with limited support for read-only operations.

Nested Class Summary

static class

ReadOnlyAccess.Provider

Nested classes/interfaces inherited from class org.netbeans.modules.xml.xam.dom.DocumentModelAccess

DocumentModelAccess.NodeUpdater

Constructor Summary

ReadOnlyAccess(AbstractDocumentModel model)
Creates a new instance of PlainDOMAccess

Method Summary

void	addMergeEventHandler(PropertyChangeListener l) Add/remove merge property change listener.
void	addUndoableEditListener(UndoableEditListener listener)
void	appendChild(Node node, Node newChild, DocumentModelAccess.NodeUpdater updater)
boolean	areSameNodes(Node n1, Node n2)
Element	duplicate(Element element)
protected Element	findElement(int position, String buf, Element base, int basePos)
Node	findNode(Document root, String xpath) Returns node from given xpath expression
List<Node>	findNodes(Document root, String xpath) Returns nodes from given xpath expression
int	findPosition(Node node)
void	finishUndoRedo()
void	flush()
Map<QName,String>	getAttributeMap(Element element) Returns map of attribute names and string values.
Element	getContainingElement(int position)
Document	getDocumentRoot()
ElementIdentity	getElementIdentity() Returns element identity helper.
int	getElementIndexOf(Node parent, Element child)
AbstractDocumentModel	getModel() Returns the associated document model.
Node	getNewEventNode(PropertyChangeEvent evt)
Node	getNewEventParentNode(PropertyChangeEvent evt)
Node	getOldEventNode(PropertyChangeEvent evt)
Node	getOldEventParentNode(PropertyChangeEvent evt)
List<Element>	getPathFromRoot(Document root, Element node) Returns path from given element to given root; or null if the node is not in tree.
String	getXmlFragment(Element element)
String	getXPath(Document root, Element node) Returns xpath expression of given element.
void	insertBefore(Node node, Node newChild, Node refChild, DocumentModelAccess.NodeUpdater updater)
static boolean	isXmlnsAttribute(Attr attr)
String	normalizeUndefinedAttributeValue(String value) Provide a uniform return value for undefined attribute values.
void	prepareForUndoRedo()
void	removeAttribute(Element element, String name, DocumentModelAccess.NodeUpdater updater)
void	removeChild(Node node, Node child, DocumentModelAccess.NodeUpdater updater)
void	removeMergeEventHandler(PropertyChangeListener l)
void	removeUndoableEditListener(UndoableEditListener listener)
void	replaceChild(Node node, Node child, Node newChild, DocumentModelAccess.NodeUpdater updater)
void	setAttribute(Element element, String name, String value, DocumentModelAccess.NodeUpdater updater)
void	setPrefix(Element node, String prefix)
void	setText(Element element, String val, DocumentModelAccess.NodeUpdater updater)
void	setXmlFragment(Element element, String text, DocumentModelAccess.NodeUpdater updater) Sets the XML fragment text for given element content.
Model.State	sync()

Methods inherited from class org.netbeans.modules.xml.xam.dom.DocumentModelAccess

addQNameValuedAttributes, dirtyIntervalMillis, getCurrentDocumentText, getXmlFragmentInclusive, lookupNamespaceURI, removeChildren, reorderChildren, setDirty, unsetDirty

Methods inherited from class org.netbeans.modules.xml.xam.ModelAccess

isAutoSync, prepareSync, setAutoSync

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReadOnlyAccess

public ReadOnlyAccess(AbstractDocumentModel model)

Creates a new instance of PlainDOMAccess

Method Detail

getModel

public AbstractDocumentModel getModel()

Description copied from class: DocumentModelAccess

Returns the associated document model. Subclass should override.

Overrides:

getModel in class DocumentModelAccess

setPrefix

public void setPrefix(Element node,
                      String prefix)

Specified by:

setPrefix in class DocumentModelAccess

getPathFromRoot

public List<Element> getPathFromRoot(Document root,
                                     Element node)

Description copied from class: DocumentModelAccess

Returns path from given element to given root; or null if the node is not in tree.

Specified by:

getPathFromRoot in class DocumentModelAccess

getXPath

public String getXPath(Document root,
                       Element node)

Description copied from class: DocumentModelAccess

Returns xpath expression of given element.

Specified by:

getXPath in class DocumentModelAccess

getAttributeMap

public Map<QName,String> getAttributeMap(Element element)

Description copied from class: DocumentModelAccess

Returns map of attribute names and string values.

Specified by:

getAttributeMap in class DocumentModelAccess

isXmlnsAttribute

public static boolean isXmlnsAttribute(Attr attr)

duplicate

public Element duplicate(Element element)

Specified by:

duplicate in class DocumentModelAccess

getXmlFragment

public String getXmlFragment(Element element)

Specified by:

getXmlFragment in class DocumentModelAccess

Returns:

XML fragment text of the given element content.

setXmlFragment

public void setXmlFragment(Element element,
                           String text,
                           DocumentModelAccess.NodeUpdater updater)
                    throws IOException

Description copied from class: DocumentModelAccess

Sets the XML fragment text for given element content. The XML fragment will be parsed and the resulting nodes will replace the current children of this documentation element.

Specified by:

setXmlFragment in class DocumentModelAccess

Parameters:

element - element to set content to.

text - XML fragment text.

Throws:

IOException - if the fragment text is not well-form.

setText

public void setText(Element element,
                    String val,
                    DocumentModelAccess.NodeUpdater updater)

Specified by:

setText in class DocumentModelAccess

removeAttribute

public void removeAttribute(Element element,
                            String name,
                            DocumentModelAccess.NodeUpdater updater)

Specified by:

removeAttribute in class DocumentModelAccess

setAttribute

public void setAttribute(Element element,
                         String name,
                         String value,
                         DocumentModelAccess.NodeUpdater updater)

Specified by:

setAttribute in class DocumentModelAccess

findPosition

public int findPosition(Node node)

Specified by:

findPosition in class DocumentModelAccess

getElementIndexOf

public int getElementIndexOf(Node parent,
                             Element child)

Specified by:

getElementIndexOf in class DocumentModelAccess

Returns:

child element index in the children list of given parent.

findNodes

public List<Node> findNodes(Document root,
                            String xpath)

Description copied from class: DocumentModelAccess

Returns nodes from given xpath expression

Specified by:

findNodes in class DocumentModelAccess

findNode

public Node findNode(Document root,
                     String xpath)

Description copied from class: DocumentModelAccess

Returns node from given xpath expression

Specified by:

findNode in class DocumentModelAccess

getContainingElement

public Element getContainingElement(int position)

Specified by:

getContainingElement in class DocumentModelAccess

findElement

protected Element findElement(int position,
                              String buf,
                              Element base,
                              int basePos)

addUndoableEditListener

public void addUndoableEditListener(UndoableEditListener listener)

Specified by:

addUndoableEditListener in class ModelAccess

removeUndoableEditListener

public void removeUndoableEditListener(UndoableEditListener listener)

Specified by:

removeUndoableEditListener in class ModelAccess

appendChild

public void appendChild(Node node,
                        Node newChild,
                        DocumentModelAccess.NodeUpdater updater)

Specified by:

appendChild in class DocumentModelAccess

insertBefore

public void insertBefore(Node node,
                         Node newChild,
                         Node refChild,
                         DocumentModelAccess.NodeUpdater updater)

Specified by:

insertBefore in class DocumentModelAccess

removeChild

public void removeChild(Node node,
                        Node child,
                        DocumentModelAccess.NodeUpdater updater)

Specified by:

removeChild in class DocumentModelAccess

replaceChild

public void replaceChild(Node node,
                         Node child,
                         Node newChild,
                         DocumentModelAccess.NodeUpdater updater)

Specified by:

replaceChild in class DocumentModelAccess

sync

public Model.State sync()
                 throws IOException

Specified by:

sync in class ModelAccess

Throws:

IOException

getElementIdentity

public ElementIdentity getElementIdentity()

Description copied from class: DocumentModelAccess

Returns element identity helper.

Specified by:

getElementIdentity in class DocumentModelAccess

getDocumentRoot

public Document getDocumentRoot()

Specified by:

getDocumentRoot in class DocumentModelAccess

flush

public void flush()

Specified by:

flush in class ModelAccess

finishUndoRedo

public void finishUndoRedo()

Specified by:

finishUndoRedo in class ModelAccess

areSameNodes

public boolean areSameNodes(Node n1,
                            Node n2)

Specified by:

areSameNodes in class DocumentModelAccess

prepareForUndoRedo

public void prepareForUndoRedo()

Specified by:

prepareForUndoRedo in class ModelAccess

addMergeEventHandler

public void addMergeEventHandler(PropertyChangeListener l)

Description copied from class: DocumentModelAccess

Add/remove merge property change listener.

Specified by:

addMergeEventHandler in class DocumentModelAccess

removeMergeEventHandler

public void removeMergeEventHandler(PropertyChangeListener l)

Specified by:

removeMergeEventHandler in class DocumentModelAccess

getOldEventParentNode

public Node getOldEventParentNode(PropertyChangeEvent evt)

Specified by:

getOldEventParentNode in class DocumentModelAccess

getOldEventNode

public Node getOldEventNode(PropertyChangeEvent evt)

Specified by:

getOldEventNode in class DocumentModelAccess

getNewEventParentNode

public Node getNewEventParentNode(PropertyChangeEvent evt)

Specified by:

getNewEventParentNode in class DocumentModelAccess

getNewEventNode

public Node getNewEventNode(PropertyChangeEvent evt)

Specified by:

getNewEventNode in class DocumentModelAccess

normalizeUndefinedAttributeValue

public String normalizeUndefinedAttributeValue(String value)

Description copied from class: DocumentModelAccess

Provide a uniform return value for undefined attribute values. XDM supports full fidelty so this deviates slightly from the DOM specification in that the return value for an undefined attribute is null instead of "". This method normalizes the return value for an undefined element to null.

Overrides:

normalizeUndefinedAttributeValue in class DocumentModelAccess