Class EntityImpl
- All Implemented Interfaces:
Cloneable
,Entity
,EventTarget
,Node
,NodeList
Note that this object models the actual entity, _not_ the entity declaration or the entity reference.
An XML processor may choose to completely expand entities before the structure model is passed to the DOM; in this case, there will be no EntityReferences in the DOM tree.
Quoting the 10/01 DOM Proposal,
"The DOM Level 1 does not support editing Entity nodes; if a user wants to make changes to the contents of an Entity, every related EntityReference node has to be replaced in the structure model by a clone of the Entity's contents, and then the desired changes must be made to each of those clones instead. All the descendants of an Entity node are readonly."I'm interpreting this as: It is the parser's responsibilty to call the non-DOM operation setReadOnly(true,true) after it constructs the Entity. Since the DOM explicitly decided not to deal with this, _any_ answer will involve a non-DOM operation, and this is the simplest solution.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
base uriprivate String
Encodingprivate String
Input Encodingprivate final String
Entity name.private String
Notation name.private String
Public identifier.private String
System identifier.private String
VersionFields inherited from class org.htmlunit.cyberneko.xerces.dom.ParentNode
firstChild, fNodeListCache, ownerDocument
Fields inherited from class org.htmlunit.cyberneko.xerces.dom.ChildNode
nextSibling_, previousSibling_
Fields inherited from class org.htmlunit.cyberneko.xerces.dom.NodeImpl
DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_IS_CONTAINED, DOCUMENT_POSITION_PRECEDING, FIRSTCHILD, HASSTRING, ID, NORMALIZED, OWNED, ownerNode_, READONLY, SPECIFIED, SYNCCHILDREN
Fields inherited from interface org.w3c.dom.Node
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncloneNode
(boolean deep) Returns a duplicate of a given node.The absolute base URI of this node ornull
if undefined.An attribute specifying the encoding used for this entity at the tiome of parsing, when it is an external parsed entity.the name of this node.short
A short integer indicating what type of node this is.Unparsed entities -- which contain non-XML data -- have a "notation name" which tells applications how to deal with them.The public identifier associated with the entity.The system identifier associated with the entity.DOM Level 3 WD - experimental the encoding of this entity, when it is an external parsed entity.DOM Level 3 WD - experimental the version number of this entity, when it is an external parsed entity.void
setBaseURI
(String uri) void
setInputEncoding
(String inputEncoding) void
setNotationName
(String name) DOM Level 2: Unparsed entities -- which contain non-XML data -- have a "notation name" which tells applications how to deal with them.void
setPublicId
(String id) DOM Level 2: The public identifier associated with the entity.void
setSystemId
(String id) DOM Level 2: The system identifier associated with the entity.void
setXmlEncoding
(String value) NON-DOM encoding - An attribute specifying, as part of the text declaration, the encoding of this entity, when it is an external parsed entity.void
setXmlVersion
(String value) Methods inherited from class org.htmlunit.cyberneko.xerces.dom.ParentNode
checkNormalizationAfterInsert, checkNormalizationAfterRemove, getChildNodes, getChildNodesUnoptimized, getFirstChild, getLastChild, getLength, getOwnerDocument, getTextContent, getTextContent, hasChildNodes, hasTextContent, insertBefore, internalInsertBefore, internalRemoveChild, isEqualNode, item, lastChild, nodeListGetLength, nodeListItem, ownerDocument, removeChild, replaceChild, setOwnerDocument, setTextContent, synchronizeChildren
Methods inherited from class org.htmlunit.cyberneko.xerces.dom.ChildNode
getNextSibling, getParentNode, getPreviousSibling, parentNode, previousSibling
Methods inherited from class org.htmlunit.cyberneko.xerces.dom.NodeImpl
addEventListener, appendChild, changed, changes, compareDocumentPosition, dispatchEvent, getAttributes, getElementAncestor, getFeature, getLocalName, getNamespaceURI, getNodeNumber, getNodeValue, getPrefix, getUserData, hasAttributes, hasStringValue, hasStringValue, isDefaultNamespace, isFirstChild, isFirstChild, isIdAttribute, isIdAttribute, isNormalized, isNormalized, isOwned, isOwned, isSameNode, isSpecified, isSpecified, isSupported, lookupNamespacePrefix, lookupNamespaceURI, lookupPrefix, needsSyncChildren, needsSyncChildren, normalize, removeEventListener, setNodeValue, setPrefix, setUserData, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.w3c.dom.Node
appendChild, compareDocumentPosition, getAttributes, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData
-
Field Details
-
name_
Entity name. -
publicId_
Public identifier. -
systemId_
System identifier. -
encoding_
Encoding -
inputEncoding_
Input Encoding -
version_
Version -
notationName_
Notation name. -
baseURI_
base uri
-
-
Constructor Details
-
EntityImpl
-
-
Method Details
-
getNodeType
public short getNodeType()A short integer indicating what type of node this is. The named constants for this value are defined in the org.w3c.dom.Node interface. A short integer indicating what type of node this is. The named constants for this value are defined in the org.w3c.dom.Node interface.- Specified by:
getNodeType
in interfaceNode
- Specified by:
getNodeType
in classNodeImpl
-
getNodeName
the name of this node. Returns the entity name- Specified by:
getNodeName
in interfaceNode
- Specified by:
getNodeName
in classNodeImpl
-
cloneNode
Returns a duplicate of a given node. You can consider this a generic "copy constructor" for nodes. The newly returned object should be completely independent of the source object's subtree, so changes in one after the clone has been made will not affect the other.Note: since we never have any children deep is meaningless here, ParentNode overrides this behavior. Returns a duplicate of a given node. You can consider this a generic "copy constructor" for nodes. The newly returned object should be completely independent of the source object's subtree, so changes in one after the clone has been made will not affect the other.
Note: since we never have any children deep is meaningless here, ParentNode overrides this behavior. Returns a duplicate of a given node. You can consider this a generic "copy constructor" for nodes. The newly returned object should be completely independent of the source object's subtree, so changes in one after the clone has been made will not affect the other.
Example: Cloning a Text node will copy both the node and the text it contains.
Example: Cloning something that has children -- Element or Attr, for example -- will _not_ clone those children unless a "deep clone" has been requested. A shallow clone of an Attr node will yield an empty Attr of the same name.
NOTE: Clones will always be read/write, even if the node being cloned is read-only, to permit applications using only the DOM API to obtain editable copies of locked portions of the tree. Clone node.
- Specified by:
cloneNode
in interfaceNode
- Overrides:
cloneNode
in classParentNode
- See Also:
-
getPublicId
The public identifier associated with the entity. If not specified, this will be null.- Specified by:
getPublicId
in interfaceEntity
-
getSystemId
The system identifier associated with the entity. If not specified, this will be null.- Specified by:
getSystemId
in interfaceEntity
-
getXmlVersion
DOM Level 3 WD - experimental the version number of this entity, when it is an external parsed entity.- Specified by:
getXmlVersion
in interfaceEntity
-
getXmlEncoding
DOM Level 3 WD - experimental the encoding of this entity, when it is an external parsed entity.- Specified by:
getXmlEncoding
in interfaceEntity
-
getNotationName
Unparsed entities -- which contain non-XML data -- have a "notation name" which tells applications how to deal with them. Parsed entities, which are in XML format, don't need this and set it to null.- Specified by:
getNotationName
in interfaceEntity
-
setPublicId
DOM Level 2: The public identifier associated with the entity. If not specified, this will be null.- Parameters:
id
- the id
-
setXmlEncoding
NON-DOM encoding - An attribute specifying, as part of the text declaration, the encoding of this entity, when it is an external parsed entity. This is null otherwise -
getInputEncoding
An attribute specifying the encoding used for this entity at the tiome of parsing, when it is an external parsed entity. This isnull
if it an entity from the internal subset or if it is not known..- Specified by:
getInputEncoding
in interfaceEntity
-
setInputEncoding
-
setXmlVersion
-
setSystemId
DOM Level 2: The system identifier associated with the entity. If not specified, this will be null.- Parameters:
id
- the id
-
setNotationName
DOM Level 2: Unparsed entities -- which contain non-XML data -- have a "notation name" which tells applications how to deal with them. Parsed entities, which are in XML format, don't need this and set it to null.- Parameters:
name
- the name
-
getBaseURI
The absolute base URI of this node ornull
if undefined. This value is computed according to . However, when theDocument
supports the feature "HTML" , the base URI is computed using first the value of the href attribute of the HTML BASE element if any, and the value of thedocumentURI
attribute from theDocument
interface otherwise.
When the node is anElement
, aDocument
or a aProcessingInstruction
, this attribute represents the properties [base URI] defined in . When the node is aNotation
, anEntity
, or anEntityReference
, this attribute represents the properties [declaration base URI] in the . How will this be affected by resolution of relative namespace URIs issue?It's not.Should this only be on Document, Element, ProcessingInstruction, Entity, and Notation nodes, according to the infoset? If not, what is it equal to on other nodes? Null? An empty string? I think it should be the parent's.No.Should this be read-only and computed or and actual read-write attribute?Read-only and computed (F2F 19 Jun 2000 and teleconference 30 May 2001).If the base HTML element is not yet attached to a document, does the insert change the Document.baseURI? Yes. (F2F 26 Sep 2001) Returns the absolute base URI of this node or null if the implementation wasn't able to obtain an absolute URI. Note: If the URI is malformed, a null is returned.- Specified by:
getBaseURI
in interfaceNode
- Overrides:
getBaseURI
in classNodeImpl
- Returns:
- The absolute base URI of this node or null.
-
setBaseURI
-