Modifier and Type	Class and Description
private static class	GrammarLoader.GrammarLoaderException wrapper exception so that we can throw it from the GrammarReaderController.
private static class	GrammarLoader.ThrowController

Modifier and Type	Field and Description
private Controller	controller
private SAXParserFactory	factory
private ExpressionPool	pool
private boolean	strictCheck

Access	Constructor and Description
public	GrammarLoader()

Method Summary

Modifier and Type	Method and Description
private Grammar	_loadSchema(Object source) Actual "meat" of parsing schema.
public Controller	getController()
public ExpressionPool	getPool()
public SAXParserFactory	getSAXParserFactory()
public boolean	getStrictCheck()
private boolean	hasDTDextension(String name) Checks if the specified name has ".dtd" extension.
public static Grammar	Returns: null if there was an error in the grammar. loadSchema(String url, GrammarReaderController controller, SAXParserFactory factory) parses the specified schema and returns the result as a Grammar object.
public static Grammar	loadSchema(InputSource source, GrammarReaderController controller, SAXParserFactory factory)
public static Grammar	loadSchema(String source, GrammarReaderController controller) returns a thread-safe AGM object, depending on the language used.
public static Grammar	loadSchema(InputSource source, GrammarReaderController controller) returns a thread-safe AGM object, depending on the language used.
public static Grammar	Returns: a non-null valid Grammar. loadSchema(String url) parses the specified schema and returns the result as a Grammar object.
public static Grammar	loadSchema(InputSource source)
public static REDocumentDeclaration	Returns: null if there was an error in the grammar. loadVGM(String url, GrammarReaderController controller, SAXParserFactory factory) parses the specified schema and returns the result as a VGM.
public static REDocumentDeclaration	loadVGM(InputSource source, GrammarReaderController controller, SAXParserFactory factory)
public static REDocumentDeclaration	Returns: non-null valid VGM object. loadVGM(String url) parses the specified schema and returns the result as a VGM.
public static REDocumentDeclaration	loadVGM(InputSource source)
public Grammar	parse(InputSource source)
public Grammar	parse(String url)
public REDocumentDeclaration	parseVGM(String url)
public REDocumentDeclaration	parseVGM(InputSource source)
public void	setController(GrammarReaderController controller) sets the GrammarReaderController object that will control various aspects of the parsing.
public void	setPool(ExpressionPool pool) Sets the ExpressionPool object that will be used during the loading process.
public void	setSAXParserFactory(SAXParserFactory factory) sets the factory object which is used to create XML parsers to parse schema files.
public void	setStrictCheck(boolean value) Sets the strict check flag.
private static REDocumentDeclaration	wrapByVGM(Grammar g)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

controller	back to summary
private Controller controller

factory	back to summary
private SAXParserFactory factory

pool	back to summary
private ExpressionPool pool

strictCheck	back to summary
private boolean strictCheck

Constructor Detail

GrammarLoader	back to summary
public GrammarLoader()

Method Detail

_loadSchema	back to summary
private Grammar _loadSchema(Object source) throws SAXException, ParserConfigurationException, IOException Actual "meat" of parsing schema. All other methods will ultimately come down to this method.

getController	back to summary
public Controller getController()

getPool	back to summary
public ExpressionPool getPool()

getSAXParserFactory	back to summary
public SAXParserFactory getSAXParserFactory()

getStrictCheck	back to summary
public boolean getStrictCheck()

hasDTDextension	back to summary
private boolean hasDTDextension(String name) Checks if the specified name has ".dtd" extension.

loadSchema	back to summary
public static Grammar loadSchema(String url, GrammarReaderController controller, SAXParserFactory factory) throws SAXException, ParserConfigurationException, IOException parses the specified schema and returns the result as a Grammar object. Returns:Grammar null if there was an error in the grammar.

loadSchema

back to summary

public static Grammar loadSchema(String url, GrammarReaderController controller, SAXParserFactory factory) throws SAXException, ParserConfigurationException, IOException

parses the specified schema and returns the result as a Grammar object.

Returns:Grammar: null if there was an error in the grammar.

loadSchema	back to summary
public static Grammar loadSchema(InputSource source, GrammarReaderController controller, SAXParserFactory factory) throws SAXException, ParserConfigurationException, IOException

loadSchema	back to summary
public static Grammar loadSchema(String source, GrammarReaderController controller) throws SAXException, ParserConfigurationException, IOException returns a thread-safe AGM object, depending on the language used.

loadSchema	back to summary
public static Grammar loadSchema(InputSource source, GrammarReaderController controller) throws SAXException, ParserConfigurationException, IOException returns a thread-safe AGM object, depending on the language used.

loadSchema	back to summary
public static Grammar loadSchema(String url) throws SAXException, ParserConfigurationException, 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:Grammar a non-null valid Grammar.

loadSchema

back to summary

public static Grammar loadSchema(String url) throws SAXException, ParserConfigurationException, 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:Grammar: a non-null valid Grammar.

loadSchema	back to summary
public static Grammar loadSchema(InputSource source) throws SAXException, ParserConfigurationException, IOException

loadVGM	back to summary
public static REDocumentDeclaration loadVGM(String url, GrammarReaderController controller, SAXParserFactory factory) throws SAXException, ParserConfigurationException, 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:REDocumentDeclaration null if there was an error in the grammar.

loadVGM

back to summary

public static REDocumentDeclaration loadVGM(String url, GrammarReaderController controller, SAXParserFactory factory) throws SAXException, ParserConfigurationException, 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:REDocumentDeclaration: null if there was an error in the grammar.

loadVGM	back to summary
public static REDocumentDeclaration loadVGM(InputSource source, GrammarReaderController controller, SAXParserFactory factory) throws SAXException, ParserConfigurationException, IOException

loadVGM	back to summary
public static REDocumentDeclaration loadVGM(String url) throws SAXException, ParserConfigurationException, 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:REDocumentDeclaration non-null valid VGM object.

loadVGM

back to summary

public static REDocumentDeclaration loadVGM(String url) throws SAXException, ParserConfigurationException, 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:REDocumentDeclaration: non-null valid VGM object.

loadVGM	back to summary
public static REDocumentDeclaration loadVGM(InputSource source) throws SAXException, ParserConfigurationException, IOException

parse	back to summary
public Grammar parse(InputSource source) throws SAXException, ParserConfigurationException, IOException

parse	back to summary
public Grammar parse(String url) throws SAXException, ParserConfigurationException, IOException

parseVGM	back to summary
public REDocumentDeclaration parseVGM(String url) throws SAXException, ParserConfigurationException, IOException

parseVGM	back to summary
public REDocumentDeclaration parseVGM(InputSource source) throws SAXException, ParserConfigurationException, IOException

setController	back to summary
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	back to summary
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	back to summary
public void setSAXParserFactory(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()).

setSAXParserFactory

back to summary

public void setSAXParserFactory(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	back to summary
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.

setStrictCheck

back to summary

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.

wrapByVGM	back to summary
private static REDocumentDeclaration wrapByVGM(Grammar g)

com.sun.msv.reader.util back to summary

private Class GrammarLoader.GrammarLoaderException

Class Inheritance

extends RuntimeException

java.lang.Object
java.lang.Throwable
java.lang.Exception
java.lang.RuntimeException
com.sun.msv.reader.util.GrammarLoader.GrammarLoaderException

Annotations

@SuppressWarnings:serial

wrapper exception so that we can throw it from the GrammarReaderController.

Field Summary

Modifier and Type	Field and Description
public final SAXException	e

Constructor Summary

Access	Constructor and Description
pack-priv	GrammarLoaderException(SAXException e)

Field Detail

e	back to summary
public final SAXException e

Constructor Detail

GrammarLoaderException	back to summary
pack-priv GrammarLoaderException(SAXException e)

com.sun.msv.reader.util back to summary

private Class GrammarLoader.ThrowController

Class Inheritance

extends Object
implements GrammarReaderController

java.lang.Object
com.sun.msv.reader.util.GrammarLoader.ThrowController

All Implemented Interfaces

com.sun.msv.reader.GrammarReaderController, org.xml.sax.EntityResolver

Constructor Summary

Access	Constructor and Description
private	ThrowController()

Method Summary

Modifier and Type	Method and Description
public void	error(Locator[] locs, String errorMessage, Exception nestedException) Implements com.sun.msv.reader.GrammarReaderController.error.
public InputSource	resolveEntity(String The public identifier of the external entity being referenced, or null if none was supplied. p, String The system identifier of the external entity being referenced. s) Implements org.xml.sax.EntityResolver.resolveEntity. Allow the application to resolve external entities.
public void	warning(Locator[] locs, String errorMessage) Implements com.sun.msv.reader.GrammarReaderController.warning.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

ThrowController	back to summary
private ThrowController()

Method Detail

error	back to summary
public void error(Locator[] locs, String errorMessage, Exception nestedException) Implements com.sun.msv.reader.GrammarReaderController.error.

resolveEntity	back to summary
public InputSource resolveEntity(String p, String s) Implements org.xml.sax.EntityResolver.resolveEntity. Doc from org.xml.sax.EntityResolver.resolveEntity. Allow the application to resolve external entities. The parser will call this method before opening any external entity except the top-level document entity. Such entities include the external DTD subset and external parameter entities referenced within the DTD (in either case, only if the parser reads external parameter entities), and external general entities referenced within the document element (if the parser reads external general entities). The application may request that the parser locate the entity itself, that it use an alternative URI, or that it use data provided by the application (as a character or byte input stream). Application writers can use this method to redirect external system identifiers to secure and/or local URIs, to look up public identifiers in a catalogue, or to read an entity from a database or other input source (including, for example, a dialog box). Neither XML nor SAX specifies a preferred policy for using public or system IDs to resolve resources. However, SAX specifies how to interpret any InputSource returned by this method, and that if none is returned, then the system ID will be dereferenced as a URL. If the system identifier is a URL, the SAX parser must resolve it fully before reporting it to the application. Parameters p:String The public identifier of the external entity being referenced, or null if none was supplied. s:String The system identifier of the external entity being referenced. Returns:InputSource An InputSource object describing the new input source, or null to request that the parser open a regular URI connection to the system identifier.

resolveEntity

back to summary

public InputSource resolveEntity(String p, String s)

Implements org.xml.sax.EntityResolver.resolveEntity.

Doc from org.xml.sax.EntityResolver.resolveEntity.

Allow the application to resolve external entities.

The parser will call this method before opening any external entity except the top-level document entity. Such entities include the external DTD subset and external parameter entities referenced within the DTD (in either case, only if the parser reads external parameter entities), and external general entities referenced within the document element (if the parser reads external general entities). The application may request that the parser locate the entity itself, that it use an alternative URI, or that it use data provided by the application (as a character or byte input stream).

Application writers can use this method to redirect external system identifiers to secure and/or local URIs, to look up public identifiers in a catalogue, or to read an entity from a database or other input source (including, for example, a dialog box). Neither XML nor SAX specifies a preferred policy for using public or system IDs to resolve resources. However, SAX specifies how to interpret any InputSource returned by this method, and that if none is returned, then the system ID will be dereferenced as a URL.

If the system identifier is a URL, the SAX parser must resolve it fully before reporting it to the application.

Parameters

p:String: The public identifier of the external entity being referenced, or null if none was supplied.
s:String: The system identifier of the external entity being referenced.

Returns:InputSource

An InputSource object describing the new input source, or null to request that the parser open a regular URI connection to the system identifier.

warning	back to summary
public void warning(Locator[] locs, String errorMessage) Implements com.sun.msv.reader.GrammarReaderController.warning.

public Class GrammarLoader

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class GrammarLoader.GrammarLoaderException

Field Summary

Constructor Summary

Field Detail

Constructor Detail

private Class GrammarLoader.ThrowController

Constructor Summary

Method Summary

Constructor Detail

Method Detail