Class DomEntityReference

Implemented Interfaces:
Cloneable, Comparable<T>, DocumentEvent, EntityReference, EventTarget, Node, NodeList

public class DomEntityReference
extends DomNode
implements EntityReference

"EntityReference" implementation (reference to parsed entity). This is a non-core DOM class, supporting the "XML" feature. It does not represent builtin entities (such as "&amp;") or character references, which are always directly expanded in DOM trees.

Note that while the DOM specification permits these nodes to have a readonly set of children, this is not required. Similarly, it does not require a DOM to couple EntityReference nodes with any Entity nodes that have the same entity name (and equivalent children). It also effectively guarantees that references created directly or indirectly through the Document.ImportNode method will not have children. The level of functionality you may get is extremely variable.

Also significant is that even at their most functional level, the fact that EntityReference children must be readonly has caused significant problems when modifying work products held in DOM trees. Other problems include issues related to undeclared namespace prefixes (and references to the current default namespace) that may be found in the text of such parsed entities nodes. These must be contextually bound as part of DOM tree construction. When such nodes are moved, the namespace associated with a given prefix (or default) may change to be in conflict with the namespace bound to the node at creation time.

In short, avoid using this DOM functionality.

See Also:
DomDoctype, DomEntity

Fields inherited from interface org.w3c.dom.Node


Constructor Summary

DomEntityReference(DomDocument owner, String name)
Constructs an EntityReference node associated with the specified document.

Method Summary

The base URI of an entity reference is the base URI where the entity declaration occurs.
Returns the name of the referenced entity.

Methods inherited from class gnu.xml.dom.DomNode

addEventListener, appendChild, clone, cloneNode, compact, compareDocumentPosition, compareTo, createEvent, dispatchEvent, getAttributes, getBaseURI, getChildNodes, getElementsByTagName, getElementsByTagNameNS, getFeature, getFirstChild, getLastChild, getLength, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isReadonly, isSameNode, isSupported, item, list, lookupNamespaceURI, lookupPrefix, makeReadonly, nameAndTypeEquals, normalize, removeChild, removeEventListener, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData, toString, trimToSize

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details


protected DomEntityReference(DomDocument owner,
                             String name)
Constructs an EntityReference node associated with the specified document. The creator should populate this with whatever contents are appropriate, and then mark it as readonly.

This constructor should only be invoked by a Document as part of its createEntityReference functionality, or through a subclass which is similarly used in a "Sub-DOM" style layer.

Method Details


public final String getBaseURI()
The base URI of an entity reference is the base URI where the entity declaration occurs.
Specified by:
getBaseURI in interface Node
getBaseURI in interface DomNode
DOM Level 3 Core


public final String getNodeName()
Returns the name of the referenced entity.
Specified by:
getNodeName in interface Node
getNodeName in interface DomNode
DOM Level 1 Core -- Copyright (C) 1999,2000,2001,2004 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.