KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > enhydra > apache > xerces > validators > common > GrammarResolver


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 2000 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.validators.common;
59 import java.util.Enumeration JavaDoc;
60
61 import org.enhydra.apache.xerces.validators.datatype.DatatypeValidatorFactory;
62
63 /**
64  * This class embodies the representation of a Grammar
65  * pool Resolver.
66  * This class is called from the validator.
67  *
68  *
69  * @author Jeffrey Rodriguez
70  */
71
72 public interface GrammarResolver {
73     /**
74      * initializeGrammarRegistry - Gets call to register initial
75      * grammars such as DTD - Schema
76      */
77
78     /**
79      *
80      * @param nameSpaceKey
81      * Namespace key into Grammar pool
82      * @return Grammar abstraction associated
83      * with NameSpace key.
84      */
85     public Grammar getGrammar( String JavaDoc nameSpaceKey );
86
87     public DatatypeValidatorFactory getDatatypeRegistry();
88
89     /**
90      *
91      * @return Enumeration of String key name spaces in Grammar pool
92      */
93
94     public Enumeration JavaDoc nameSpaceKeys();
95
96     /**
97      *
98      * @param nameSpaceKey
99      * Key to associate with Grammar
100      * abstraction
101      * @param grammar Grammar abstraction
102      * used by validator.
103      */
104     public void putGrammar( String JavaDoc nameSpaceKey, Grammar grammar );
105
106     /**
107      * Removes association of Namespace key and Grammar from
108      * Grammar pool
109      *
110      * @param nameSpaceKey
111      * Name space key
112      */
113     public Grammar removeGrammar( String JavaDoc nameSpaceKey );
114
115
116
117     /**
118      * Is Grammar abstraction in Grammar pool?
119      *
120      * @param grammar Grammar Abstraction
121      * @return true - Yes there is at least one instance
122      * false - No
123      */
124     public boolean contains( Grammar grammar );
125
126     /**
127      * Is Namespace key in Grammar pool
128      *
129      * @param nameSpaceKey
130      * Namespace key
131      * @return Boolean- true - Namespace key association
132      * is in grammar pool.
133      */
134     public boolean containsNameSpace( String JavaDoc nameSpaceKey );
135
136     /**
137      * Reset internal Namespace/Grammar registry.
138      */
139     public void clearGrammarResolver();
140
141     /**
142      *
143      * @return Length of grammar pool. Number of associations.
144      */
145     public int size();
146
147 }
148
149
150
151
Popular Tags