Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-release > by-pkgid > c9ab6176cdb3bd12c388e27bee18050a > files > 156

xml-commons-jaxp-1.3-apis-manual-1.3.04-0.0.1mdv2008.1.x86_64.rpm

<?xml version="1.0" encoding="UTF-8"?>
<interface name="Entity" inherits="Node" id="ID-527DCFF2">
  <descr><p>This interface represents an entity, either parsed or
      unparsed, in an XML document. Note that this models the entity
      itself <emph>not</emph> the entity declaration. <code>Entity</code>
      declaration modeling has been left for a later Level of the DOM
      specification.</p> 
    <p>The <code>nodeName</code> attribute that is inherited from
      <code>Node</code> contains the name of the entity.</p> 
    <p>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 <code>EntityReference</code> nodes in the document tree.</p>
    <p>XML does not mandate that a non-validating XML processor read
      and process entity declarations made in the external subset or
      declared in external parameter entities. This means
      that parsed entities declared in the external subset
      need not be expanded by some classes of applications, and that
      the replacement value of the entity may not be available. When the
      replacement value is available, the corresponding 
      <code>Entity</code> node's child list represents the structure of
      that replacement text. Otherwise, the child list is empty.</p>
    <p>The DOM Level 2 does not support editing <code>Entity</code>
      nodes; if a user wants to make changes to the contents of an
      <code>Entity</code>, every related <code>EntityReference</code> node
      has to be replaced in the structure model by a clone of the
      <code>Entity</code>'s contents, and then the desired changes must be made
      to each of those clones instead. <code>Entity</code> nodes and all their
      <termref def="dt-descendant">descendants</termref> are <termref def="dt-readonly-node">readonly</termref>.</p>
    <p>An <code>Entity</code> node does not have any parent.</p>
    <note><p>If the entity contains an unbound <termref
       def='dt-namespaceprefix'>namespace prefix</termref>, the
       <code>namespaceURI</code> of the corresponding node in the
       <code>Entity</code> node subtree is <code>null</code>. The same is
       true for <code>EntityReference</code> nodes that refer to this entity,
       when they are created using the <code>createEntityReference</code>
       method of the <code>Document</code> interface. The DOM Level 2 does not
       support any mechanism to resolve namespace prefixes.</p></note>
  </descr>
  <attribute readonly="yes" name="publicId" type="DOMString" id="ID-D7303025">
    <descr><p>The public identifier associated with the entity, if
	specified. If the public identifier was not specified, this
	is <code>null</code>.</p>
    </descr>
  </attribute>
  <attribute readonly="yes" name="systemId" type="DOMString" id="ID-D7C29F3E">
    <descr><p>The system identifier associated with the entity, if
	specified. If the system identifier was not specified, this
	is <code>null</code>.</p>
    </descr>
  </attribute>
  <attribute readonly="yes" name="notationName" type="DOMString" id="ID-6ABAEB38">
    <descr><p>For unparsed entities, the name of the notation for the
	entity. For parsed entities, this is <code>null</code>. </p>
    </descr> 
  </attribute>
</interface>