XMLGrammarLoader


1   /*
2    * The Apache Software License, Version 1.1
3    *
4    *
5    * Copyright (c) 2000-2002 The Apache Software Foundation.  
6    * All rights 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.xni.grammars;
59  
60  import com.sun.org.apache.xerces.internal.xni.parser.XMLConfigurationException;
61  import com.sun.org.apache.xerces.internal.xni.parser.XMLErrorHandler;
62  import com.sun.org.apache.xerces.internal.xni.parser.XMLEntityResolver;
63  import com.sun.org.apache.xerces.internal.xni.parser.XMLInputSource;
64  import com.sun.org.apache.xerces.internal.xni.XNIException;
65  
66  import java.io.IOException  ;
67  import java.util.Locale  ;
68  
69  /**
70   * The intention of this interface is to provide a generic means
71   * by which Grammar objects may be created without parsing instance
72   * documents.  Implementations of this interface will know how to load
73   * specific types of grammars (e.g., DTD's or schemas); a wrapper
74   * will be provided for user applications to interact with these implementations.
75   * 
76   * @author Neil Graham, IBM
77   * @version $Id: XMLGrammarLoader.java,v 1.1 2002/05/23 16:46:01 neilg Exp $
78   */
79  
80  public interface XMLGrammarLoader {
81  
82      /**
83       * Returns a list of feature identifiers that are recognized by
84       * this XMLGrammarLoader.  This method may return null if no features
85       * are recognized.
86       */
87      public String  [] getRecognizedFeatures();
88  
89      /**
90       * Returns the state of a feature.
91       * 
92       * @param featureId The feature identifier.
93       * 
94       * @throws XMLConfigurationException Thrown on configuration error.
95       */
96      public boolean getFeature(String   featureId) 
97              throws XMLConfigurationException;
98  
99      /**
100      * Sets the state of a feature. 
101      *
102      * @param featureId The feature identifier.
103      * @param state     The state of the feature.
104      *
105      * @throws XMLConfigurationException Thrown when a feature is not
106      *                  recognized or cannot be set.
107      */
108     public void setFeature(String   featureId,
109                 boolean state) throws XMLConfigurationException;
110 
111     /**
112      * Returns a list of property identifiers that are recognized by
113      * this XMLGrammarLoader.  This method may return null if no properties
114      * are recognized.
115      */
116     public String  [] getRecognizedProperties();
117 
118     /**
119      * Returns the state of a property.
120      * 
121      * @param propertyId The property identifier.
122      * 
123      * @throws XMLConfigurationException Thrown on configuration error.
124      */
125     public Object   getProperty(String   propertyId) 
126             throws XMLConfigurationException;
127 
128     /**
129      * Sets the state of a property. 
130      * 
131      * @param propertyId The property identifier.
132      * @param state     The state of the property.
133      *
134      * @throws XMLConfigurationException Thrown when a property is not
135      *                  recognized or cannot be set.
136      */
137     public void setProperty(String   propertyId,
138                 Object   state) throws XMLConfigurationException;
139 
140     /**
141      * Set the locale to use for messages.
142      *
143      * @param locale The locale object to use for localization of messages.
144      *
145      * @exception XNIException Thrown if the parser does not support the
146      *                         specified locale.
147      */
148     public void setLocale(Locale   locale); 
149 
150     /** Return the Locale the XMLGrammarLoader is using. */
151     public Locale   getLocale();
152 
153     /**
154      * Sets the error handler.
155      *
156      * @param errorHandler The error handler.
157      */
158     public void setErrorHandler(XMLErrorHandler errorHandler);
159 
160     /** Returns the registered error handler.  */
161     public XMLErrorHandler getErrorHandler();
162 
163     /**
164      * Sets the entity resolver.
165      *
166      * @param entityResolver The new entity resolver.
167      */
168     public void setEntityResolver(XMLEntityResolver entityResolver);
169 
170     /** Returns the registered entity resolver.  */
171     public XMLEntityResolver getEntityResolver();
172 
173     /**
174      * Returns a Grammar object by parsing the contents of the
175      * entity pointed to by source.
176      *
177      * @param source        the location of the entity which forms
178      *                          the starting point of the grammar to be constructed.
179      * @throws IOException      When a problem is encountered reading the entity
180      *          XNIException    When a condition arises (such as a FatalError) that requires parsing
181      *                              of the entity be terminated.
182      */
183     public Grammar loadGrammar(XMLInputSource source)
184         throws IOException  , XNIException;
185 } // XMLGrammarLoader
186 
187
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags