org.apache.xerces.dom
Class NotationImpl

java.lang.Object
  |
  +--org.apache.xerces.dom.NodeImpl
        |
        +--org.apache.xerces.dom.NotationImpl
Direct Known Subclasses:
DeferredNotationImpl

public class NotationImpl
extends NodeImpl
implements Notation

Notations are how the Document Type Description (DTD) records hints about the format of an XML "unparsed entity" -- in other words, non-XML data bound to this document type, which some applications may wish to consult when manipulating the document. A Notation represents a name-value pair, with its nodeName being set to the declared name of the notation.

Notations are also used to formally declare the "targets" of Processing Instructions.

Note that the Notation's data is non-DOM information; the DOM only records what and where it is.

See the XML 1.0 spec, sections 4.7 and 2.6, for more info.

Level 1 of the DOM does not support editing Notation contents.

Since:
PR-DOM-Level-1-19980818.
Version:
 
See Also:
Serialized Form

Field Summary
protected  java.lang.String publicId
          Public identifier.
protected  java.lang.String systemId
          System identifier.
 
Fields inherited from class org.apache.xerces.dom.NodeImpl
ELEMENT_DEFINITION_NODE, fInternalSetNodeValue, MUTATION_AGGREGATE, MUTATION_ALL, MUTATION_LOCAL, MUTATION_NONE, MUTATIONEVENTS, name, nextSibling, ownerDocument, parentNode, previousSibling, readOnly, syncData, userData, value
 
Fields inherited from interface org.w3c.dom.Node
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
 
Constructor Summary
NotationImpl(DocumentImpl ownerDoc, java.lang.String name)
          Factory constructor.
 
Method Summary
 short getNodeType()
          A short integer indicating what type of node this is.
 java.lang.String getPublicId()
          The Public Identifier for this Notation.
 java.lang.String getSystemId()
          The System Identifier for this Notation.
 void setNodeValue(java.lang.String value)
          Notations never have a nodeValue.
 void setPublicId(java.lang.String id)
          NON-DOM: The Public Identifier for this Notation.
 void setSystemId(java.lang.String id)
          NON-DOM: The System Identifier for this Notation.
 
Methods inherited from class org.apache.xerces.dom.NodeImpl
addEventListener, appendChild, changed, cloneNode, dispatchEvent, finalize, getAttributes, getChildNodes, getFirstChild, getLastChild, getLength, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getReadOnly, getUserData, hasChildNodes, insertBefore, item, normalize, removeChild, removeEventListener, replaceChild, setPrefix, setReadOnly, setUserData, supports, synchronizeData, toString
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

publicId

protected java.lang.String publicId
Public identifier.

systemId

protected java.lang.String systemId
System identifier.
Constructor Detail

NotationImpl

public NotationImpl(DocumentImpl ownerDoc,
                    java.lang.String name)
Factory constructor.
Method Detail

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.
Overrides:
getNodeType in class NodeImpl

setNodeValue

public void setNodeValue(java.lang.String value)
                  throws DOMException
Notations never have a nodeValue.
Overrides:
setNodeValue in class NodeImpl
Throws:
DOMException(NO_MODIFICATION_ALLOWED_ERR) -  

getPublicId

public java.lang.String getPublicId()
The Public Identifier for this Notation. If no public identifier was specified, this will be null.
Specified by:
getPublicId in interface Notation

getSystemId

public java.lang.String getSystemId()
The System Identifier for this Notation. If no system identifier was specified, this will be null.
Specified by:
getSystemId in interface Notation

setPublicId

public void setPublicId(java.lang.String id)
NON-DOM: The Public Identifier for this Notation. If no public identifier was specified, this will be null.

setSystemId

public void setSystemId(java.lang.String id)
NON-DOM: The System Identifier for this Notation. If no system identifier was specified, this will be null.


Copyright © 1999 Apache XML Project. All Rights Reserved.