Source for gnu.xml.dom.DomNotation

   1: /* DomNotation.java --
   2:    Copyright (C) 1999,2000,2001,2004 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: package gnu.xml.dom;
  39: 
  40: import org.w3c.dom.Notation;
  41: 
  42: /**
  43:  * <p> "Notation" implementation.  This is a non-core DOM class, supporting
  44:  * the "XML" feature. </p>
  45:  *
  46:  * <p> Although unparsed entities using this notation can be detected using
  47:  * DOM, neither NOTATIONS nor ENTITY/ENTITIES attributes can be so detected.
  48:  * More, there is no portable way to construct a Notation node, so there's
  49:  * no way that vendor-neutral DOM construction APIs could even report a
  50:  * NOTATION used to identify the intended meaning of a ProcessingInstruction.
  51:  * </p>
  52:  *
  53:  * <p> In short, <em>avoid using this DOM functionality</em>.
  54:  *
  55:  * @see DomDoctype
  56:  * @see DomEntity
  57:  * @see DomPI
  58:  *
  59:  * @author David Brownell
  60:  * @author <a href='mailto:dog@gnu.org'>Chris Burdess</a>
  61:  */
  62: public class DomNotation
  63:   extends DomExtern
  64:   implements Notation
  65: {
  66: 
  67:   /**
  68:    * Constructs a Notation node associated with the specified document,
  69:    * with the specified descriptive data.  Note that at least one of
  70:    * the PUBLIC and SYSTEM identifiers must be provided; unlike other
  71:    * external objects in XML, notations may have only a PUBLIC identifier.
  72:    *
  73:    * <p>This constructor should only be invoked by a DomDoctype object
  74:    * as part of its declareNotation functionality, or through a subclass
  75:    * which is similarly used in a "Sub-DOM" style layer.
  76:    *
  77:    * @param owner The document with which this notation is associated
  78:    * @param name Name of this notation
  79:    * @param publicId If non-null, provides the notation's PUBLIC identifier
  80:    * @param systemId If non-null, rovides the notation's SYSTEM identifier
  81:    */
  82:   protected DomNotation(DomDocument owner,
  83:                         String name,
  84:                         String publicId,
  85:                         String systemId)
  86:   {
  87:     super(NOTATION_NODE, owner, name, publicId, systemId);
  88:     makeReadonly();
  89:   }
  90: 
  91:   /**
  92:    * The base URI of an external entity is its system ID.
  93:    * The base URI of an internal entity is the parent document's base URI.
  94:    * @since DOM Level 3 Core
  95:    */
  96:   public String getBaseURI()
  97:   {
  98:     String systemId = getSystemId();
  99:     return (systemId == null) ? owner.getBaseURI() : systemId;
 100:   }
 101: 
 102: }