001: /*
002: * The Apache Software License, Version 1.1
003: *
004: *
005: * Copyright (c) 1999 The Apache Software Foundation. All rights
006: * reserved.
007: *
008: * Redistribution and use in source and binary forms, with or without
009: * modification, are permitted provided that the following conditions
010: * are met:
011: *
012: * 1. Redistributions of source code must retain the above copyright
013: * notice, this list of conditions and the following disclaimer.
014: *
015: * 2. Redistributions in binary form must reproduce the above copyright
016: * notice, this list of conditions and the following disclaimer in
017: * the documentation and/or other materials provided with the
018: * distribution.
019: *
020: * 3. The end-user documentation included with the redistribution,
021: * if any, must include the following acknowledgment:
022: * "This product includes software developed by the
023: * Apache Software Foundation (http://www.apache.org/)."
024: * Alternately, this acknowledgment may appear in the software itself,
025: * if and wherever such third-party acknowledgments normally appear.
026: *
027: * 4. The names "Xerces" and "Apache Software Foundation" must
028: * not be used to endorse or promote products derived from this
029: * software without prior written permission. For written
030: * permission, please contact apache@apache.org.
031: *
032: * 5. Products derived from this software may not be called "Apache",
033: * nor may "Apache" appear in their name, without prior written
034: * permission of the Apache Software Foundation.
035: *
036: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
037: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
038: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
039: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
040: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
041: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
042: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
043: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
044: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
045: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
046: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
047: * SUCH DAMAGE.
048: * ====================================================================
049: *
050: * This software consists of voluntary contributions made by many
051: * individuals on behalf of the Apache Software Foundation and was
052: * originally based on software copyright (c) 1999, International
053: * Business Machines, Inc., http://www.apache.org. For more
054: * information on the Apache Software Foundation, please see
055: * <http://www.apache.org/>.
056: */
057:
058: package org.apache.xerces.dom;
059:
060: import org.w3c.dom.DOMException;
061: import org.w3c.dom.Node;
062: import org.w3c.dom.Notation;
063:
064: /**
065: * Notations are how the Document Type Description (DTD) records hints
066: * about the format of an XML "unparsed entity" -- in other words,
067: * non-XML data bound to this document type, which some applications
068: * may wish to consult when manipulating the document. A Notation
069: * represents a name-value pair, with its nodeName being set to the
070: * declared name of the notation.
071: * <P>
072: * Notations are also used to formally declare the "targets" of
073: * Processing Instructions.
074: * <P>
075: * Note that the Notation's data is non-DOM information; the DOM only
076: * records what and where it is.
077: * <P>
078: * See the XML 1.0 spec, sections 4.7 and 2.6, for more info.
079: * <P>
080: * Level 1 of the DOM does not support editing Notation contents.
081: *
082: * @version
083: * @since PR-DOM-Level-1-19980818.
084: */
085: public class NotationImpl extends NodeImpl implements Notation {
086:
087: //
088: // Constants
089: //
090:
091: /** Serialization version. */
092: static final long serialVersionUID = -764632195890658402L;
093:
094: //
095: // Data
096: //
097:
098: /** Notation name. */
099: protected String name;
100:
101: /** Public identifier. */
102: protected String publicId;
103:
104: /** System identifier. */
105: protected String systemId;
106:
107: //
108: // Constructors
109: //
110:
111: /** Factory constructor. */
112: public NotationImpl(CoreDocumentImpl ownerDoc, String name) {
113: super (ownerDoc);
114: this .name = name;
115: }
116:
117: //
118: // Node methods
119: //
120:
121: /**
122: * A short integer indicating what type of node this is. The named
123: * constants for this value are defined in the org.w3c.dom.Node interface.
124: */
125: public short getNodeType() {
126: return Node.NOTATION_NODE;
127: }
128:
129: /**
130: * Returns the notation name
131: */
132: public String getNodeName() {
133: if (needsSyncData()) {
134: synchronizeData();
135: }
136: return name;
137: }
138:
139: //
140: // Notation methods
141: //
142:
143: /**
144: * The Public Identifier for this Notation. If no public identifier
145: * was specified, this will be null.
146: */
147: public String getPublicId() {
148:
149: if (needsSyncData()) {
150: synchronizeData();
151: }
152: return publicId;
153:
154: } // getPublicId():String
155:
156: /**
157: * The System Identifier for this Notation. If no system identifier
158: * was specified, this will be null.
159: */
160: public String getSystemId() {
161:
162: if (needsSyncData()) {
163: synchronizeData();
164: }
165: return systemId;
166:
167: } // getSystemId():String
168:
169: //
170: // Public methods
171: //
172:
173: /**
174: * NON-DOM: The Public Identifier for this Notation. If no public
175: * identifier was specified, this will be null.
176: */
177: public void setPublicId(String id) {
178:
179: if (isReadOnly()) {
180: throw new DOMException(
181: DOMException.NO_MODIFICATION_ALLOWED_ERR,
182: "DOM001 Modification not allowed");
183: }
184: if (needsSyncData()) {
185: synchronizeData();
186: }
187: publicId = id;
188:
189: } // setPublicId(String)
190:
191: /**
192: * NON-DOM: The System Identifier for this Notation. If no system
193: * identifier was specified, this will be null.
194: */
195: public void setSystemId(String id) {
196:
197: if (isReadOnly()) {
198: throw new DOMException(
199: DOMException.NO_MODIFICATION_ALLOWED_ERR,
200: "DOM001 Modification not allowed");
201: }
202: if (needsSyncData()) {
203: synchronizeData();
204: }
205: systemId = id;
206:
207: } // setSystemId(String)
208:
209: } // class NotationImpl
|