KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > org > apache > xerces > internal > impl > dtd > DTDGrammarBucket


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.impl.dtd;
59
60 import com.sun.org.apache.xerces.internal.xni.grammars.XMLGrammarDescription;
61 import java.util.Hashtable JavaDoc;
62
63 /**
64 * This very simple class is the skeleton of what the DTDValidator could use
65 * to store various grammars that it gets from the GrammarPool. As in the
66 * case of XSGrammarBucket, one thinks of this object as being closely
67 * associated with its validator; when fully mature, this class will be
68 * filled from the GrammarPool when the DTDValidator is invoked on a
69 * document, and, if a new DTD grammar is parsed, the new set will be
70 * offered back to the GrammarPool for possible inclusion.
71  *
72  * @author Neil Graham, IBM
73  *
74  * @version $Id: DTDGrammarBucket.java,v 1.5 2002/06/13 23:04:14 neilg Exp $
75  */
76 public class DTDGrammarBucket {
77
78     // REVISIT: make this class smarter and *way* more complete!
79
80     //
81 // Data
82 //
83
84     /** Grammars associated with element root name. */
85     protected Hashtable JavaDoc fGrammars;
86
87     // the unique grammar from fGrammars (or that we're
88 // building) that is used in validation.
89 protected DTDGrammar fActiveGrammar;
90
91     // is the "active" grammar standalone?
92 protected boolean fIsStandalone;
93
94     //
95 // Constructors
96 //
97
98     /** Default constructor. */
99     public DTDGrammarBucket() {
100         fGrammars = new Hashtable JavaDoc();
101     } // <init>()
102
103     //
104 // Public methods
105 //
106
107     /**
108      * Puts the specified grammar into the grammar pool and associate it to
109      * a root element name (this being internal, the lack of generality is irrelevant).
110      *
111      * @param grammar The grammar.
112      */
113     public void putGrammar(DTDGrammar grammar) {
114         XMLDTDDescription desc = (XMLDTDDescription)grammar.getGrammarDescription();
115         fGrammars.put(desc, grammar);
116     } // putGrammar(DTDGrammar)
117
118     // retrieve a DTDGrammar given an XMLDTDDescription
119 public DTDGrammar getGrammar(XMLGrammarDescription desc) {
120         return (DTDGrammar)(fGrammars.get((XMLDTDDescription)desc));
121     } // putGrammar(DTDGrammar)
122
123     public void clear() {
124         fGrammars.clear();
125         fActiveGrammar = null;
126         fIsStandalone = false;
127     } // clear()
128
129     // is the active grammar standalone? This must live here because
130 // at the time the validator discovers this we don't yet know
131 // what the active grammar should be (no info about root)
132 void setStandalone(boolean standalone) {
133         fIsStandalone = standalone;
134     }
135
136     boolean getStandalone() {
137         return fIsStandalone;
138     }
139
140     // set the "active" grammar:
141 void setActiveGrammar (DTDGrammar grammar) {
142         fActiveGrammar = grammar;
143     }
144     DTDGrammar getActiveGrammar () {
145         return fActiveGrammar;
146     }
147 } // class DTDGrammarBucket
148
Popular Tags