com.sun.msv.reader.util
Class GrammarLoader

java.lang.Object
  extended bycom.sun.msv.reader.util.GrammarLoader

public class GrammarLoader
extends java.lang.Object

loads any supported grammar (except XML DTD) by automatically detecting the schema language.

The static version of loadVGM/loadSchema methods provides simple ways to load a grammar.

Another way to use GrammarLoader is

  1. To instanciate an object of GrammarLoader
  2. call setXXX methods to configure the parameters
  3. call loadSchema/loadVGM methods (possibly multiple times) to load grammars.
This approach will give you finer control.

Author:
Kohsuke KAWAGUCHI

Constructor Summary
GrammarLoader()
           
 
Method Summary
 Controller getController()
           
 ExpressionPool getPool()
           
 javax.xml.parsers.SAXParserFactory getSAXParserFactory()
           
 boolean getStrictCheck()
           
static Grammar loadSchema(org.xml.sax.InputSource source)
           
static Grammar loadSchema(org.xml.sax.InputSource source, GrammarReaderController controller)
          returns a thread-safe AGM object, depending on the language used.
static Grammar loadSchema(org.xml.sax.InputSource source, GrammarReaderController controller, javax.xml.parsers.SAXParserFactory factory)
           
static Grammar loadSchema(java.lang.String url)
          parses the specified schema and returns the result as a Grammar object.
static Grammar loadSchema(java.lang.String source, GrammarReaderController controller)
          returns a thread-safe AGM object, depending on the language used.
static Grammar loadSchema(java.lang.String url, GrammarReaderController controller, javax.xml.parsers.SAXParserFactory factory)
          parses the specified schema and returns the result as a Grammar object.
static REDocumentDeclaration loadVGM(org.xml.sax.InputSource source)
           
static REDocumentDeclaration loadVGM(org.xml.sax.InputSource source, GrammarReaderController controller, javax.xml.parsers.SAXParserFactory factory)
           
static REDocumentDeclaration loadVGM(java.lang.String url)
          parses the specified schema and returns the result as a VGM.
static REDocumentDeclaration loadVGM(java.lang.String url, GrammarReaderController controller, javax.xml.parsers.SAXParserFactory factory)
          parses the specified schema and returns the result as a VGM.
 Grammar parse(org.xml.sax.InputSource source)
           
 Grammar parse(java.lang.String url)
           
 REDocumentDeclaration parseVGM(org.xml.sax.InputSource source)
           
 REDocumentDeclaration parseVGM(java.lang.String url)
           
 void setController(GrammarReaderController controller)
          sets the GrammarReaderController object that will control various aspects of the parsing.
 void setPool(ExpressionPool pool)
          Sets the ExpressionPool object that will be used during the loading process.
 void setSAXParserFactory(javax.xml.parsers.SAXParserFactory factory)
          sets the factory object which is used to create XML parsers to parse schema files.
 void setStrictCheck(boolean value)
          Sets the strict check flag.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GrammarLoader

public GrammarLoader()
Method Detail

getController

public Controller getController()

getPool

public ExpressionPool getPool()

getSAXParserFactory

public javax.xml.parsers.SAXParserFactory getSAXParserFactory()

getStrictCheck

public boolean getStrictCheck()

loadSchema

public static Grammar loadSchema(org.xml.sax.InputSource source)
                          throws org.xml.sax.SAXException,
                                 javax.xml.parsers.ParserConfigurationException,
                                 java.io.IOException
Throws:
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException
java.io.IOException

loadSchema

public static Grammar loadSchema(org.xml.sax.InputSource source,
                                 GrammarReaderController controller)
                          throws org.xml.sax.SAXException,
                                 javax.xml.parsers.ParserConfigurationException,
                                 java.io.IOException
returns a thread-safe AGM object, depending on the language used.

Throws:
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException
java.io.IOException

loadSchema

public static Grammar loadSchema(org.xml.sax.InputSource source,
                                 GrammarReaderController controller,
                                 javax.xml.parsers.SAXParserFactory factory)
                          throws org.xml.sax.SAXException,
                                 javax.xml.parsers.ParserConfigurationException,
                                 java.io.IOException
Throws:
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException
java.io.IOException

loadSchema

public static Grammar loadSchema(java.lang.String url)
                          throws org.xml.sax.SAXException,
                                 javax.xml.parsers.ParserConfigurationException,
                                 java.io.IOException
parses the specified schema and returns the result as a Grammar object. This method uses the default SAX parser and throws an exception if there is an error in the schema.

Returns:
a non-null valid Grammar.
Throws:
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException
java.io.IOException

loadSchema

public static Grammar loadSchema(java.lang.String source,
                                 GrammarReaderController controller)
                          throws org.xml.sax.SAXException,
                                 javax.xml.parsers.ParserConfigurationException,
                                 java.io.IOException
returns a thread-safe AGM object, depending on the language used.

Throws:
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException
java.io.IOException

loadSchema

public static Grammar loadSchema(java.lang.String url,
                                 GrammarReaderController controller,
                                 javax.xml.parsers.SAXParserFactory factory)
                          throws org.xml.sax.SAXException,
                                 javax.xml.parsers.ParserConfigurationException,
                                 java.io.IOException
parses the specified schema and returns the result as a Grammar object.

Returns:
null if there was an error in the grammar.
Throws:
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException
java.io.IOException

loadVGM

public static REDocumentDeclaration loadVGM(org.xml.sax.InputSource source)
                                     throws org.xml.sax.SAXException,
                                            javax.xml.parsers.ParserConfigurationException,
                                            java.io.IOException
Throws:
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException
java.io.IOException

loadVGM

public static REDocumentDeclaration loadVGM(org.xml.sax.InputSource source,
                                            GrammarReaderController controller,
                                            javax.xml.parsers.SAXParserFactory factory)
                                     throws org.xml.sax.SAXException,
                                            javax.xml.parsers.ParserConfigurationException,
                                            java.io.IOException
Throws:
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException
java.io.IOException

loadVGM

public static REDocumentDeclaration loadVGM(java.lang.String url)
                                     throws org.xml.sax.SAXException,
                                            javax.xml.parsers.ParserConfigurationException,
                                            java.io.IOException
parses the specified schema and returns the result as a VGM. This method uses the default SAX parser and throws an exception if there is an error in the schema.

Returns:
non-null valid VGM object.
Throws:
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException
java.io.IOException

loadVGM

public static REDocumentDeclaration loadVGM(java.lang.String url,
                                            GrammarReaderController controller,
                                            javax.xml.parsers.SAXParserFactory factory)
                                     throws org.xml.sax.SAXException,
                                            javax.xml.parsers.ParserConfigurationException,
                                            java.io.IOException
parses the specified schema and returns the result as a VGM. This method is an utility method for those applications which don't need AGM (e.g., a single thread application).

Returns:
null if there was an error in the grammar.
Throws:
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException
java.io.IOException

parse

public Grammar parse(org.xml.sax.InputSource source)
              throws org.xml.sax.SAXException,
                     javax.xml.parsers.ParserConfigurationException,
                     java.io.IOException
Throws:
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException
java.io.IOException

parse

public Grammar parse(java.lang.String url)
              throws org.xml.sax.SAXException,
                     javax.xml.parsers.ParserConfigurationException,
                     java.io.IOException
Throws:
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException
java.io.IOException

parseVGM

public REDocumentDeclaration parseVGM(org.xml.sax.InputSource source)
                               throws org.xml.sax.SAXException,
                                      javax.xml.parsers.ParserConfigurationException,
                                      java.io.IOException
Throws:
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException
java.io.IOException

parseVGM

public REDocumentDeclaration parseVGM(java.lang.String url)
                               throws org.xml.sax.SAXException,
                                      javax.xml.parsers.ParserConfigurationException,
                                      java.io.IOException
Throws:
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException
java.io.IOException

setController

public void setController(GrammarReaderController controller)
sets the GrammarReaderController object that will control various aspects of the parsing. If not set, no error report will be done.


setPool

public void setPool(ExpressionPool pool)
Sets the ExpressionPool object that will be used during the loading process. If not set, a fresh one is used for each time the loadXXX method is called.


setSAXParserFactory

public void setSAXParserFactory(javax.xml.parsers.SAXParserFactory factory)
sets the factory object which is used to create XML parsers to parse schema files. The factory must be configured to namespace aware.

If no SAXParserFactory is set, then the default parser is used. (The parser that can be obtained by SAXParserFactory.newInstance()).


setStrictCheck

public void setStrictCheck(boolean value)
Sets the strict check flag. If set to true, schema readers will apply stricter checks so that it can find errors in the schema. If set to false, readers will skip some of the checks.

When this flag is set to false, which is the default, the reader may accept incorrect schemas.



Copyright © 2001-2003 Sun Microsystems, Inc. Documenation generated April 26 2005.