KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > org > apache > xerces > internal > dom > NotationImpl


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 1999-2002 The Apache Software Foundation. All rights
6  * reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Apache Software Foundation (http://www.apache.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Xerces" and "Apache Software Foundation" must
28  * not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact apache@apache.org.
31  *
32  * 5. Products derived from this software may not be called "Apache",
33  * nor may "Apache" appear in their name, without prior written
34  * permission of the Apache Software Foundation.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This software consists of voluntary contributions made by many
51  * individuals on behalf of the Apache Software Foundation and was
52  * originally based on software copyright (c) 1999, International
53  * Business Machines, Inc., http://www.apache.org. For more
54  * information on the Apache Software Foundation, please see
55  * <http://www.apache.org/>.
56  */
57
58 package com.sun.org.apache.xerces.internal.dom;
59
60 import org.w3c.dom.DOMException JavaDoc;
61 import org.w3c.dom.Node JavaDoc;
62 import org.w3c.dom.Notation JavaDoc;
63
64 /**
65  * Notations are how the Document Type Description (DTD) records hints
66  * about the format of an XML "unparsed entity" -- in other words,
67  * non-XML data bound to this document type, which some applications
68  * may wish to consult when manipulating the document. A Notation
69  * represents a name-value pair, with its nodeName being set to the
70  * declared name of the notation.
71  * <P>
72  * Notations are also used to formally declare the "targets" of
73  * Processing Instructions.
74  * <P>
75  * Note that the Notation's data is non-DOM information; the DOM only
76  * records what and where it is.
77  * <P>
78  * See the XML 1.0 spec, sections 4.7 and 2.6, for more info.
79  * <P>
80  * Level 1 of the DOM does not support editing Notation contents.
81  *
82  * @version $Id: NotationImpl.java,v 1.16 2002/08/24 20:39:22 lmartin Exp $
83  * @since PR-DOM-Level-1-19980818.
84  */
85 public class NotationImpl
86     extends NodeImpl
87     implements Notation JavaDoc {
88
89     //
90 // Constants
91 //
92
93     /** Serialization version. */
94     static final long serialVersionUID = -764632195890658402L;
95     
96     //
97 // Data
98 //
99
100     /** Notation name. */
101     protected String JavaDoc name;
102
103     /** Public identifier. */
104     protected String JavaDoc publicId;
105
106     /** System identifier. */
107     protected String JavaDoc systemId;
108
109     /** Base URI*/
110     protected String JavaDoc baseURI;
111
112     //
113 // Constructors
114 //
115
116     /** Factory constructor. */
117     public NotationImpl(CoreDocumentImpl ownerDoc, String JavaDoc name) {
118         super(ownerDoc);
119         this.name = name;
120     }
121     
122     //
123 // Node methods
124 //
125
126     /**
127      * A short integer indicating what type of node this is. The named
128      * constants for this value are defined in the org.w3c.dom.Node interface.
129      */
130     public short getNodeType() {
131         return Node.NOTATION_NODE;
132     }
133
134     /**
135      * Returns the notation name
136      */
137     public String JavaDoc getNodeName() {
138         if (needsSyncData()) {
139             synchronizeData();
140         }
141         return name;
142     }
143
144     //
145 // Notation methods
146 //
147
148     /**
149      * The Public Identifier for this Notation. If no public identifier
150      * was specified, this will be null.
151      */
152     public String JavaDoc getPublicId() {
153
154         if (needsSyncData()) {
155             synchronizeData();
156         }
157         return publicId;
158
159     } // getPublicId():String
160
161     /**
162      * The System Identifier for this Notation. If no system identifier
163      * was specified, this will be null.
164      */
165     public String JavaDoc getSystemId() {
166
167         if (needsSyncData()) {
168             synchronizeData();
169         }
170         return systemId;
171
172     } // getSystemId():String
173
174     //
175 // Public methods
176 //
177
178     /**
179      * NON-DOM: The Public Identifier for this Notation. If no public
180      * identifier was specified, this will be null.
181      */
182     public void setPublicId(String JavaDoc id) {
183
184         if (isReadOnly()) {
185             throw new DOMException JavaDoc(
186             DOMException.NO_MODIFICATION_ALLOWED_ERR,
187                 DOMMessageFormatter.formatMessage(DOMMessageFormatter.DOM_DOMAIN, "NO_MODIFICATION_ALLOWED_ERR", null));
188         }
189         if (needsSyncData()) {
190             synchronizeData();
191         }
192         publicId = id;
193
194     } // setPublicId(String)
195
196     /**
197      * NON-DOM: The System Identifier for this Notation. If no system
198      * identifier was specified, this will be null.
199      */
200     public void setSystemId(String JavaDoc id) {
201
202         if(isReadOnly()) {
203             throw new DOMException JavaDoc(
204             DOMException.NO_MODIFICATION_ALLOWED_ERR,
205                 DOMMessageFormatter.formatMessage(DOMMessageFormatter.DOM_DOMAIN, "NO_MODIFICATION_ALLOWED_ERR", null));
206         }
207         if (needsSyncData()) {
208             synchronizeData();
209         }
210         systemId = id;
211
212     } // setSystemId(String)
213
214
215     /**
216      * DOM Level 3 WD - Experimental.
217      * Retrieve baseURI
218      */
219     public String JavaDoc getBaseURI() {
220         if (needsSyncData()) {
221             synchronizeData();
222         }
223         return baseURI;
224     }
225
226     /** NON-DOM: set base uri*/
227     public void setBaseURI(String JavaDoc uri){
228         if (needsSyncData()) {
229             synchronizeData();
230         }
231         baseURI = uri;
232     }
233
234 } // class NotationImpl
235
Popular Tags