XML for Java Compatibility API 2.0.15

com.ibm.xml.parser
Class TXNotation

java.lang.Object
  |
  +--com.ibm.xml.parser.Child
        |
        +--com.ibm.xml.parser.TXNotation
Direct Known Subclasses:
TreeFactory.TreeNotation

public class TXNotation
extends Child

The TXNotation class represents the definition of a notation within a DTD. Notations identify by name the format of external binary entities, or the application to which a processing instruction is addressed.

TXNotation isn't an implement class of org.w3c.dom.Notation.

Version:
Revision: 06 1.5 src/com/ibm/xml/parser/TXNotation.java, parser, xml4j2, xml4j2_0_15
See Also:
Notation, Serialized Form

Fields inherited from class com.ibm.xml.parser.Child
ATTDEF, ATTLIST, ELEMENT_DECL, NAME_ATTDEF, NAME_ATTLIST, NAME_CDATA, NAME_COMMENT, NAME_DOCFRAGMENT, NAME_DOCUMENT, NAME_ELEMENT_DECL, NAME_PSEUDONODE, NAME_TEXT, PSEUDONODE
 
Constructor Summary
TXNotation(java.lang.String name, ExternalID externalID)
          Constructor.
 
Method Summary
 void acceptPost(Visitor visitor)
          Implements the accept operation of the visitor design pattern when the end of a TXNotation Node is recognized when traversing the document object tree.
 void acceptPre(Visitor visitor)
          Implements the accept operation of the visitor design pattern when the start of a TXNotation Node is recognized when traversing the document object tree.
 java.lang.Object clone()
          Clone this Notation Node using the appropriate factory.
 boolean equals(org.w3c.dom.Node arg, boolean deep)
           
 ExternalID getExternalID()
          Returns the external ID associated with this Notation Node.
 java.lang.String getName()
          Deprecated. Use getNodeName().
 java.lang.String getNodeName()
          Returns the name of the Notation.
 short getNodeType()
          Returns that this object is a Notation Node.
protected  org.w3c.dom.Notation getNotationImpl()
          Wrapper for DOM.
 java.lang.String getPublicId()
          Returns the public identifier of the Notation.
 java.lang.String getSystemId()
          Returns the system identifier of the Notation.
 void setName(java.lang.String name)
          Deprecated.  
 
Methods inherited from class com.ibm.xml.parser.Child
appendChild, clearDigest, cloneNode, getAttributes, getChildNodes, getDigest, getFactory, getFirstChild, getFirstWithoutReference, getLastChild, getLastWithoutReference, getNextSibling, getNextWithoutReference, getNodeValue, getOwnerDocument, getParentNode, getParentWithoutReference, getPreviousSibling, getPreviousWithoutReference, getText, getUserData, hasChildNodes, insertBefore, makeXPointer, print, print, removeChild, replaceChild, searchAncestors, searchAncestors, setFactory, setNodeValue, setUserData, toXMLString, toXMLString
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TXNotation

public TXNotation(java.lang.String name,
                  ExternalID externalID)
Constructor.
Parameters:
name - The name of the Notation.
externalID - The public or system identifier which defines the DTD's notation.
Method Detail

clone

public java.lang.Object clone()
Clone this Notation Node using the appropriate factory.

This method is defined by Child.

Returns:
Cloned Notation Node.
Overrides:
clone in class Child
See Also:
Child.clone()

equals

public boolean equals(org.w3c.dom.Node arg,
                      boolean deep)
Parameters:
deep - Ignored.
Overrides:
equals in class Child

getNodeType

public short getNodeType()
Returns that this object is a Notation Node.
Returns:
Node indicator.

getNodeName

public java.lang.String getNodeName()
Returns the name of the Notation.

getName

public java.lang.String getName()
Deprecated. Use getNodeName().
Returns the name of the Notation.
Returns:
The name of the Notation, or null if no name.
See Also:
setName(java.lang.String)

setName

public void setName(java.lang.String name)
Deprecated.  
Sets the name of the Notation.
Parameters:
name - The name of the Notation.
See Also:
getName()

getSystemId

public java.lang.String getSystemId()
Returns the system identifier of the Notation. A system identifier is a URI, which may be used to retrieve an external entity's content.
Returns:
The system identifier, or null if the identifier is not defined.
See Also:
ExternalID.getSystemLiteral()

getPublicId

public java.lang.String getPublicId()
Returns the public identifier of the Notation. This value is only valid if the identifier is defined as public (as opposed to system). Public identifiers may be used to try to generate an alternative URI in order to retrieve the an external entities content. If retrieval fails using the public identifier, an attempt must be made to retrieve content using the system identifier.
Returns:
The public identifier, or null if the identifier is not defined.
See Also:
ExternalID

getExternalID

public ExternalID getExternalID()
Returns the external ID associated with this Notation Node. An external ID contains system, and optionally, public identifiers.
Returns:
The external ID associated with this Notation Node.
See Also:
ExternalID

acceptPre

public void acceptPre(Visitor visitor)
               throws java.lang.Exception
Implements the accept operation of the visitor design pattern when the start of a TXNotation Node is recognized when traversing the document object tree.
Parameters:
visitor - The implemention of the Visitor operation (toXMLString, digest, ...)
Throws:
java.lang.Exception - Thrown if this Node can not be visitted, or traversal modification is requested.
See Also:
Visitor, TreeTraversal, NonRecursivePreorderTreeTraversal, TreeTraversalException

acceptPost

public void acceptPost(Visitor visitor)
                throws java.lang.Exception
Implements the accept operation of the visitor design pattern when the end of a TXNotation Node is recognized when traversing the document object tree.
Parameters:
visitor - The implemention of the Visitor operation (toXMLString, digest, ...)
Throws:
java.lang.Exception - Thrown if this Node can not be visitted, or traversal modification is requested.
See Also:
Visitor, TreeTraversal, NonRecursivePreorderTreeTraversal, TreeTraversalException

getNotationImpl

protected org.w3c.dom.Notation getNotationImpl()
Wrapper for DOM.

XML for Java Compatibility API 2.0.15