KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > enhydra > apache > xerces > dom > NotationImpl


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 1999 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 org.enhydra.apache.xerces.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
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     //
110 // Constructors
111 //
112
113     /** Factory constructor. */
114     public NotationImpl(CoreDocumentImpl ownerDoc, String JavaDoc name) {
115         super(ownerDoc);
116         this.name = name;
117     }
118     
119     //
120 // Node methods
121 //
122
123     /**
124      * A short integer indicating what type of node this is. The named
125      * constants for this value are defined in the org.w3c.dom.Node interface.
126      */
127     public short getNodeType() {
128         return Node.NOTATION_NODE;
129     }
130
131     /**
132      * Returns the notation name
133      */
134     public String JavaDoc getNodeName() {
135         if (needsSyncData()) {
136             synchronizeData();
137         }
138         return name;
139     }
140
141     //
142 // Notation methods
143 //
144
145     /**
146      * The Public Identifier for this Notation. If no public identifier
147      * was specified, this will be null.
148      */
149     public String JavaDoc getPublicId() {
150
151         if (needsSyncData()) {
152             synchronizeData();
153         }
154         return publicId;
155
156     } // getPublicId():String
157
158     /**
159      * The System Identifier for this Notation. If no system identifier
160      * was specified, this will be null.
161      */
162     public String JavaDoc getSystemId() {
163
164         if (needsSyncData()) {
165             synchronizeData();
166         }
167         return systemId;
168
169     } // getSystemId():String
170
171     //
172 // Public methods
173 //
174
175     /**
176      * NON-DOM: The Public Identifier for this Notation. If no public
177      * identifier was specified, this will be null.
178      */
179     public void setPublicId(String JavaDoc id) {
180
181         if (isReadOnly()) {
182             throw new DOMException JavaDoc(
183                 DOMException.NO_MODIFICATION_ALLOWED_ERR,
184             "DOM001 Modification not allowed");
185         }
186         if (needsSyncData()) {
187             synchronizeData();
188         }
189         publicId = id;
190
191     } // setPublicId(String)
192
193     /**
194      * NON-DOM: The System Identifier for this Notation. If no system
195      * identifier was specified, this will be null.
196      */
197     public void setSystemId(String JavaDoc id) {
198
199         if(isReadOnly()) {
200             throw new DOMException JavaDoc(
201                 DOMException.NO_MODIFICATION_ALLOWED_ERR,
202             "DOM001 Modification not allowed");
203         }
204         if (needsSyncData()) {
205             synchronizeData();
206         }
207         systemId = id;
208
209     } // setSystemId(String)
210
211 } // class NotationImpl
212
Popular Tags