AbstractDocumentComponent (Extensible Abstract Model (XAM))

java.lang.Object
- org.netbeans.modules.xml.xam.AbstractComponent<C>
- - org.netbeans.modules.xml.xam.dom.AbstractDocumentComponent<C>

All Implemented Interfaces:

Component<C>, DocumentComponent<C>, DocumentComponent2<C>, DocumentModelAccess.NodeUpdater
```
public abstract class AbstractDocumentComponent<C extends DocumentComponent<C>>
extends AbstractComponent<C>
implements DocumentComponent2<C>, DocumentModelAccess.NodeUpdater
```
An abstract implementation of the Component with support of underlaying DOM model.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AbstractDocumentComponent.PrefixAttribute

Nested Classes
Modifier and Type	Class and Description
`static class`	`AbstractDocumentComponent.PrefixAttribute`

Field Summary
- Fields inherited from interface org.netbeans.modules.xml.xam.dom.DocumentComponent
  TEXT_CONTENT_PROPERTY

Constructor Summary

Constructors
Constructor and Description

AbstractDocumentComponent(AbstractDocumentModel model, Element e)

Constructors
Constructor and Description
`AbstractDocumentComponent(AbstractDocumentModel model, Element e)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPrefix(String prefix, String namespace)` Declare prefix for given namespace (without any refactoring action).
`protected void`	`appendChildQuietly(C component, List<C> children)`
`DocumentComponent`	`copy(C parent)` Returns a copy of this component for adding into the given parent component.
`protected Attribute`	`createPrefixAttribute(String prefix)`
`protected String`	`ensureUnique(String prefix, String namespace)` Returns a unique prefix for the given namespace by appending number from 1 to 100.
`protected void`	`ensureValueNamespaceDeclared(String newNamespace, String oldNamespace, String preferredPrefix)`
`int`	`findAttributePosition(String attributeName)` Returns position of the attribute by the given name, or -1 if not found.
`C`	`findChildComponent(Element e)` Returns child component backed by given element node.
`C`	`findChildComponentByIdentity(Element e)`
`protected int`	`findDomainIndex(Element e)`
`int`	`findEndPosition()`
`int`	`findPosition()` Returns the position of this component in the schema document, expressed as an offset from the start of the document.
`protected void`	`fireChildAdded()`
`protected void`	`fireChildRemoved()`
`protected void`	`firePropertyChange(String propName, Object oldValue, Object newValue)`
`protected void`	`fireValueChanged()`
`protected DocumentModelAccess`	`getAccess()`
`String`	`getAnyAttribute(QName attr)` Returns string value of the attribute from different namespace or null if the attribute is currently undefined.
`String`	`getAttribute(Attribute attr)`
`Map<QName,String>`	`getAttributeMap()`
`protected abstract Object`	`getAttributeValueOf(Attribute attr, String stringValue)`
`protected Element`	`getChildElement(QName qname)`
`protected String`	`getChildElementText(QName qname)` Returns value of all text nodes from the child element with given QName.
`protected AbstractDocumentComponent`	`getEffectiveParent()`
`protected String`	`getLeadingText(C child)` Returns leading text for the child component of the given index.
`AbstractDocumentModel`	`getModel()`
`protected String`	`getNamespaceURI()`
`protected int`	`getNodeIndexOf(Node parent, Node child)`
`Element`	`getPeer()` Returns the DOM element corresponding to this component.
`protected String`	`getPrefixedName(QName q, boolean declarePrefix)`
`protected String`	`getPrefixedName(String namespace, String localName)`
`protected String`	`getPrefixedName(String namespace, String name, String prefix, boolean declarePrefix)`
`Map<String,String>`	`getPrefixes()`
`QName`	`getQName()` Returns QName of the component.
`static QName`	`getQName(Node n)`
`protected String`	`getText()` Return text value of this component.
`protected String`	`getText(C child, boolean leading, boolean includeComments)`
`static String`	`getText(Element e)`
`protected String`	`getTrailingText(C child)` Returns trailing text for the child component of the given index.
`protected String`	`getXmlFragment()` Get the XML fragment text that make up the children the component peer node.
`String`	`getXmlFragmentInclusive()` Get the XML fragment text that make up the peer node.
`protected void`	`insertAtIndexQuietly(C newComponent, List<C> children, int index)`
`boolean`	`isInDocumentModel()` Returns true if the component is part of the document model.
`String`	`lookupNamespaceURI(String prefix)`
`String`	`lookupNamespaceURI(String prefix, boolean optimized)` Returns namespace for the given prefix.
`String`	`lookupPrefix(String namespace)`
`protected abstract void`	`populateChildren(List<C> children)`
`boolean`	`referencesSameNode(Node n)` Returns true if the node referenced by this component is n.
`protected void`	`removeAttributeQuietly(Element element, String name)`
`protected void`	`removeChildQuietly(C component, List<C> children)`
`void`	`removePrefix(String prefix)` Remove declared prefix (without refactoring).
`protected ModelSource`	`resolveModel(String hint)` Resolves reference to external models using location hint.
`void`	`setAnyAttribute(QName attr, String value)` Set string value of the attribute identified by given QName.
`void`	`setAttribute(String eventPropertyName, Attribute attr, Object value)` Sets the component attribute String value and fire property change event with the given property name.
`protected void`	`setAttributeQuietly(Attribute type, Object newVal)`
`protected void`	`setChildElementText(String propertyName, String text, QName qname)` Set the value of the text node from the child element with given QName.
`protected void`	`setLeadingText(String propName, String text, C child)` Set leading text for the child component which position is the given index.
`protected void`	`setQNameAttribute(String propertyName, QName attr, String value)`
`protected void`	`setText(String propertyName, String text)` Set text value of the component.
`protected void`	`setText(String propName, String value, C child, boolean leading, boolean includeComments)`
`protected void`	`setTrailingText(String propName, String text, C child)` Set trailing text for the child component which position is the given index.
`protected void`	`setXmlFragment(String propertyName, String text)` Set text as XML fragment children the component peer node.
`protected void`	`updatePeer(String propertyName, Element newPeer)` Shared utility for implementation to replace the current peer and ensure the document tree also get update properly.
`void`	`updateReference(Element element)`
`protected <N extends Node> void`	`updateReference(Element peer, List<N> updatingPath)` Updates peer node with given peer and the path for context of the update.
`<N extends Node> void`	`updateReference(List<N> pathToRoot)` Update all parents with fresh nodes.
`protected void`	`verifyWrite()` This method ensures that a transaction is currently in progress and that the current thread is able to write the model.

Methods inherited from class org.netbeans.modules.xml.xam.AbstractComponent
addAfter, addBefore, addPropertyChangeListener, appendChild, canPaste, checkChildrenPopulated, checkNullOrDuplicateChild, getChild, getChildren, getChildren, getChildren, getChildrenCount, getParent, insertAtIndex, insertAtIndex, isChildrenInitialized, removeChild, removeComponentListener, removePropertyChangeListener, setChild, setChild, setChildAfter, setChildBefore, setModel, setParent

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

Methods inherited from interface org.netbeans.modules.xml.xam.Component
canPaste, getChildren, getChildren, getChildren, getParent

- Constructor Detail
  - AbstractDocumentComponent
```
public AbstractDocumentComponent(AbstractDocumentModel model,
                                 Element e)
```
- Method Detail
  - populateChildren
```
protected abstract void populateChildren(List<C> children)
```
    Specified by:
    
    populateChildren in class AbstractComponent<C extends DocumentComponent<C>>
  - getPeer
```
public Element getPeer()
```
    Description copied from interface: DocumentComponent
    
    Returns the DOM element corresponding to this component.
    
    Specified by:
    
    getPeer in interface DocumentComponent<C extends DocumentComponent>
  - getAttribute
```
public String getAttribute(Attribute attr)
```
    Specified by:
    
    getAttribute in interface DocumentComponent<C extends DocumentComponent>
    
    Returns:
    
    attribute value or null if the attribute is currently undefined
  - setAttribute
```
public void setAttribute(String eventPropertyName,
                         Attribute attr,
                         Object value)
```
    Sets the component attribute String value and fire property change event with the given property name.
    
    Specified by:
    
    setAttribute in interface DocumentComponent<C extends DocumentComponent>
    
    Parameters:
    
    eventPropertyName - property name to be used in firing property change event.
    
    attr - attribute name
    
    value - for the attribute.
  - getAttributeValueOf
```
protected abstract Object getAttributeValueOf(Attribute attr,
                                              String stringValue)
```
  - getAnyAttribute
```
public String getAnyAttribute(QName attr)
```
    Returns string value of the attribute from different namespace or null if the attribute is currently undefined. If given QName has prefix, it will be ignored.
    
    Parameters:
    
    attr - non-null QName represents the attribute name.
    
    Returns:
    
    attribute value
  - setAnyAttribute
```
public void setAnyAttribute(QName attr,
                            String value)
```
    Set string value of the attribute identified by given QName. This will fire property change event using attribute local name.
    
    Parameters:
    
    attr - non-null QName represents the attribute name.
    
    value - string value for the attribute.
  - setQNameAttribute
```
protected void setQNameAttribute(String propertyName,
                                 QName attr,
                                 String value)
```
  - getPrefixedName
```
protected String getPrefixedName(QName q,
                                 boolean declarePrefix)
```
  - getPrefixedName
```
protected String getPrefixedName(String namespace,
                                 String localName)
```
  - getPrefixedName
```
protected String getPrefixedName(String namespace,
                                 String name,
                                 String prefix,
                                 boolean declarePrefix)
```
  - ensureUnique
```
protected String ensureUnique(String prefix,
                              String namespace)
```
    Returns a unique prefix for the given namespace by appending number from 1 to 100.
  - setAttributeQuietly
```
protected void setAttributeQuietly(Attribute type,
                                   Object newVal)
```
  - removeAttributeQuietly
```
protected void removeAttributeQuietly(Element element,
                                      String name)
```
  - appendChildQuietly
```
protected void appendChildQuietly(C component,
                                  List<C> children)
```
    Specified by:
    
    appendChildQuietly in class AbstractComponent<C extends DocumentComponent<C>>
  - insertAtIndexQuietly
```
protected void insertAtIndexQuietly(C newComponent,
                                    List<C> children,
                                    int index)
```
    Specified by:
    
    insertAtIndexQuietly in class AbstractComponent<C extends DocumentComponent<C>>
  - removeChildQuietly
```
protected void removeChildQuietly(C component,
                                  List<C> children)
```
    Specified by:
    
    removeChildQuietly in class AbstractComponent<C extends DocumentComponent<C>>
  - getNamespaceURI
```
protected String getNamespaceURI()
```
  - lookupNamespaceURI
```
public String lookupNamespaceURI(String prefix,
                                 boolean optimized)
```
    Returns namespace for the given prefix. If optimized is specified, lookup will use component tree hierarchy instead of the underlying DOM tree hiearchy.
  - lookupNamespaceURI
```
public String lookupNamespaceURI(String prefix)
```
  - lookupPrefix
```
public String lookupPrefix(String namespace)
```
  - getXmlFragment
```
protected String getXmlFragment()
```
    Get the XML fragment text that make up the children the component peer node.
  - getXmlFragmentInclusive
```
public String getXmlFragmentInclusive()
```
    Get the XML fragment text that make up the peer node.
  - setXmlFragment
```
protected void setXmlFragment(String propertyName,
                              String text)
                       throws IOException
```
    Set text as XML fragment children the component peer node. The children of peer node will be replaced with nodes resulted from parsing given text. This method will not fire child component added or removed events. This method should only be exposed on leaf component.
    
    Parameters:
    
    propertyName - name of property event to fire
    
    text - text value to set to.
    
    Throws:
    
    IOException - if text is not well-formed.
  - setText
```
protected void setText(String propertyName,
                       String text)
```
    Set text value of the component. This is for pure text-usage by documentation components. The children of peer node will be replaced with single text node having given text.
    
    Parameters:
    
    propertyName - name of property event to fire
    
    text - text value to set to.
  - getText
```
protected String getText()
```
    Return text value of this component. This is for text-usage by doucmentation components. Non-text children node are ignored.
    
    Returns:
    
    aggregated text string of all child text nodes.
  - getText
```
public static String getText(Element e)
```
  - getModel
```
public AbstractDocumentModel getModel()
```
    Specified by:
    
    getModel in interface Component<C extends DocumentComponent<C>>
    
    Overrides:
    
    getModel in class AbstractComponent<C extends DocumentComponent<C>>
    
    Returns:
    
    the model where this element is being used or null if not currently part of a model.
  - referencesSameNode
```
public boolean referencesSameNode(Node n)
```
    Description copied from interface: DocumentComponent
    
    Returns true if the node referenced by this component is n.
    
    Specified by:
    
    referencesSameNode in interface DocumentComponent<C extends DocumentComponent>
  - updateReference
```
public void updateReference(Element element)
```
    Specified by:
    
    updateReference in interface DocumentModelAccess.NodeUpdater
  - updateReference
```
public <N extends Node> void updateReference(List<N> pathToRoot)
```
    Update all parents with fresh nodes. This implemenation assume optimal case where the length of pathToRootNode is same as or longer than path to root component. The update will skip uncorrelated nodes in pathToRootNode. Individual will need to override this implementation if it has special needs.
    
    Specified by:
    
    updateReference in interface DocumentModelAccess.NodeUpdater
  - updateReference
```
protected <N extends Node> void updateReference(Element peer,
                                                List<N> updatingPath)
```
    Updates peer node with given peer and the path for context of the update. The default behavior just call #updateReference(Element peer). Subclass with special need for auxiliary update needs to override.
    
    Parameters:
    
    peer - the peer node to update with
    
    updatingPath - full path for context of the update
  - getAccess
```
protected DocumentModelAccess getAccess()
```
  - findPosition
```
public int findPosition()
```
    Description copied from interface: DocumentComponent
    
    Returns the position of this component in the schema document, expressed as an offset from the start of the document.
    
    Specified by:
    
    findPosition in interface DocumentComponent<C extends DocumentComponent>
    
    Returns:
    
    the position of this component in the document
  - findEndPosition
```
public int findEndPosition()
```
    Specified by:
    
    findEndPosition in interface DocumentComponent2<C extends DocumentComponent<C>>
    
    Returns:
    
    Since:
    
    1.22
  - updatePeer
```
protected void updatePeer(String propertyName,
                          Element newPeer)
```
    Shared utility for implementation to replace the current peer and ensure the document tree also get update properly.
  - createPrefixAttribute
```
protected Attribute createPrefixAttribute(String prefix)
```
  - addPrefix
```
public void addPrefix(String prefix,
                      String namespace)
```
    Declare prefix for given namespace (without any refactoring action).
  - removePrefix
```
public void removePrefix(String prefix)
```
    Remove declared prefix (without refactoring).
  - getPrefixes
```
public Map<String,String> getPrefixes()
```
    Returns:
    
    mapping from prefix to namespace.
  - ensureValueNamespaceDeclared
```
protected void ensureValueNamespaceDeclared(String newNamespace,
                                            String oldNamespace,
                                            String preferredPrefix)
```
  - findChildComponent
```
public C findChildComponent(Element e)
```
    Description copied from interface: DocumentComponent
    
    Returns child component backed by given element node.
    
    Specified by:
    
    findChildComponent in interface DocumentComponent<C extends DocumentComponent>
  - findChildComponentByIdentity
```
public C findChildComponentByIdentity(Element e)
```
  - copy
```
public DocumentComponent copy(C parent)
```
    Description copied from interface: Component
    
    Returns a copy of this component for adding into the given parent component.
    
    Specified by:
    
    copy in interface Component<C extends DocumentComponent<C>>
  - verifyWrite
```
protected void verifyWrite()
```
    Description copied from class: AbstractComponent
    
    This method ensures that a transaction is currently in progress and that the current thread is able to write the model.
    
    Overrides:
    
    verifyWrite in class AbstractComponent<C extends DocumentComponent<C>>
  - firePropertyChange
```
protected void firePropertyChange(String propName,
                                  Object oldValue,
                                  Object newValue)
```
    Overrides:
    
    firePropertyChange in class AbstractComponent<C extends DocumentComponent<C>>
  - fireValueChanged
```
protected void fireValueChanged()
```
    Overrides:
    
    fireValueChanged in class AbstractComponent<C extends DocumentComponent<C>>
  - fireChildRemoved
```
protected void fireChildRemoved()
```
    Overrides:
    
    fireChildRemoved in class AbstractComponent<C extends DocumentComponent<C>>
  - fireChildAdded
```
protected void fireChildAdded()
```
    Overrides:
    
    fireChildAdded in class AbstractComponent<C extends DocumentComponent<C>>
  - isInDocumentModel
```
public boolean isInDocumentModel()
```
    Returns true if the component is part of the document model.
    
    Specified by:
    
    isInDocumentModel in interface DocumentComponent<C extends DocumentComponent>
  - findAttributePosition
```
public int findAttributePosition(String attributeName)
```
    Description copied from interface: DocumentComponent
    
    Returns position of the attribute by the given name, or -1 if not found.
    
    Specified by:
    
    findAttributePosition in interface DocumentComponent<C extends DocumentComponent>
  - getQName
```
public QName getQName()
```
    Returns QName of the component.
  - getQName
```
public static QName getQName(Node n)
```
  - resolveModel
```
protected ModelSource resolveModel(String hint)
                            throws CatalogModelException
```
    Resolves reference to external models using location hint.
    
    Parameters:
    
    hint - on location of where external model reference could reside.
    
    Returns:
    
    the model source of the referenced model if found.
    
    Throws:
    
    CatalogModelException - if the model cannot be located or the hint is not well-formed URI
  - getAttributeMap
```
public Map<QName,String> getAttributeMap()
```
  - findDomainIndex
```
protected int findDomainIndex(Element e)
```
  - getEffectiveParent
```
protected AbstractDocumentComponent getEffectiveParent()
```
  - getChildElement
```
protected Element getChildElement(QName qname)
```
  - getChildElementText
```
protected String getChildElementText(QName qname)
```
    Returns value of all text nodes from the child element with given QName. This method is use to implement mapping of "property" as component attribute.
    
    Parameters:
    
    qname - QName of the child element to get text from.
  - setChildElementText
```
protected void setChildElementText(String propertyName,
                                   String text,
                                   QName qname)
```
    Set the value of the text node from the child element with given QName. This method is use to implement mapping of "property" as component attribute.
    
    Parameters:
    
    propertyName - property change event name
    
    text - the string to set value of the child element text node.
    
    qname - QName of the child element to get text from.
  - getLeadingText
```
protected String getLeadingText(C child)
```
    Returns leading text for the child component of the given index.
    
    Parameters:
    
    child - the child to get associated text from
    
    Returns:
    
    value of the leading text node, or null the indexed component peer does not have leading text nodes.
  - setLeadingText
```
protected void setLeadingText(String propName,
                              String text,
                              C child)
```
    Set leading text for the child component which position is the given index.
    
    Parameters:
    
    child - the child to set associated text
    
    text - value of the leading text node, or null to remove the leading text node.
  - getTrailingText
```
protected String getTrailingText(C child)
```
    Returns trailing text for the child component of the given index.
    
    Parameters:
    
    child - the child to get associated text from
    
    Returns:
    
    value of the leading text node, or null the indexed component peer does not have trailing text nodes.
  - setTrailingText
```
protected void setTrailingText(String propName,
                               String text,
                               C child)
```
    Set trailing text for the child component which position is the given index.
    
    Parameters:
    
    child - the child to get associated text from
    
    text - value of the trailing text node, or null to remove the trailing text node.
  - getText
```
protected String getText(C child,
                         boolean leading,
                         boolean includeComments)
```
  - setText
```
protected void setText(String propName,
                       String value,
                       C child,
                       boolean leading,
                       boolean includeComments)
```
  - getNodeIndexOf
```
protected int getNodeIndexOf(Node parent,
                             Node child)
```

Class AbstractDocumentComponent<C extends DocumentComponent<C>>

Nested Class Summary

Field Summary

Fields inherited from interface org.netbeans.modules.xml.xam.dom.DocumentComponent

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.netbeans.modules.xml.xam.Component

Constructor Detail

AbstractDocumentComponent

Method Detail

populateChildren

getPeer

getAttribute

setAttribute

getAttributeValueOf

getAnyAttribute

setAnyAttribute

setQNameAttribute

getPrefixedName

getPrefixedName

getPrefixedName

ensureUnique

setAttributeQuietly

removeAttributeQuietly

appendChildQuietly

insertAtIndexQuietly

removeChildQuietly

getNamespaceURI

lookupNamespaceURI

lookupNamespaceURI

lookupPrefix

getXmlFragment

getXmlFragmentInclusive

setXmlFragment

setText

getText

getText

getModel

referencesSameNode

updateReference

updateReference

updateReference

getAccess

findPosition

findEndPosition

updatePeer

createPrefixAttribute

addPrefix

removePrefix

getPrefixes

ensureValueNamespaceDeclared

findChildComponent

findChildComponentByIdentity

copy

verifyWrite

firePropertyChange

fireValueChanged

fireChildRemoved

fireChildAdded

isInDocumentModel

findAttributePosition

getQName

getQName

resolveModel

getAttributeMap

findDomainIndex

getEffectiveParent

getChildElement

getChildElementText

setChildElementText

getLeadingText

setLeadingText

getTrailingText

setTrailingText

getText

setText

getNodeIndexOf