com.sun.xml.xsom.parser

Class XSOMParser

java.lang.Object

com.sun.xml.xsom.parser.XSOMParser

public final class XSOMParser
extends Object

Parses possibly multiple W3C XML Schema files and compose them into one grammar.

Author:

Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)

Constructor Summary

Constructors

Constructor and Description
XSOMParser() Deprecated. Unsafe, use XSOMParser(factory) instead with security features initialized by setting XMLConstants.FEATURE_SECURE_PROCESSING feature.
XSOMParser(SAXParserFactory factory) Creates a new XSOMParser that uses the given SAXParserFactory for creating new SAX parsers.
XSOMParser(XMLParser parser) Creates a new XSOMParser that reads XML Schema from non-standard inputs.

Method Summary

Methods

Modifier and Type	Method and Description
AnnotationParserFactory	getAnnotationParserFactory()
Set<SchemaDocument>	getDocuments() Gets the set of SchemaDocument that represents parsed documents so far.
EntityResolver	getEntityResolver()
ErrorHandler	getErrorHandler()
ContentHandler	getParserHandler() Gets the parser implemented as a ContentHandler.
XSSchemaSet	getResult() Gets the parsed result.
void	parse(File schema) Parses a new XML Schema document.
void	parse(InputSource source) Parses a new XML Schema document.
void	parse(InputStream is) Parses a new XML Schema document.
void	parse(Reader reader) Parses a new XML Schema document.
void	parse(String systemId) Parses a new XML Schema document.
void	parse(URL url) Parses a new XML Schema document.
void	setAnnotationParser(AnnotationParserFactory factory) Sets the annotation parser factory.
void	setAnnotationParser(Class annParser) Sets the annotation parser.
void	setEntityResolver(EntityResolver resolver) Set an entity resolver that is used to resolve things like <xsd:import> and <xsd:include>.
void	setErrorHandler(ErrorHandler errorHandler) Set an error handler that receives all the errors encountered during the parsing.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XSOMParser

public XSOMParser()

Deprecated. Unsafe, use XSOMParser(factory) instead with security features initialized by setting XMLConstants.FEATURE_SECURE_PROCESSING feature.

Creates a new XSOMParser by using a SAX parser from JAXP.

XSOMParser

public XSOMParser(SAXParserFactory factory)

Creates a new XSOMParser that uses the given SAXParserFactory for creating new SAX parsers. The caller needs to configure it properly. Don't forget to call setNamespaceAware(true) or you'll see some strange errors.

XSOMParser

public XSOMParser(XMLParser parser)

Creates a new XSOMParser that reads XML Schema from non-standard inputs. By implementing the XMLParser interface, XML Schema can be read from something other than XML.

Parameters:

parser - This parser will be called to parse XML Schema documents.

Method Detail

parse

public void parse(InputStream is)
           throws SAXException

Parses a new XML Schema document.

When using this method, XSOM does not know the system ID of this document, therefore, when this stream contains relative references to other schemas, XSOM will fail to resolve them. To specify an system ID with a stream, use InputSource

Throws:

SAXException

parse

public void parse(Reader reader)
           throws SAXException

Parses a new XML Schema document.

When using this method, XSOM does not know the system ID of this document, therefore, when this reader contains relative references to other schemas, XSOM will fail to resolve them. To specify an system ID with a reader, use InputSource

Throws:

SAXException

parse

public void parse(File schema)
           throws SAXException,
                  IOException

Parses a new XML Schema document.

Throws:

SAXException

IOException

parse

public void parse(URL url)
           throws SAXException

Parses a new XML Schema document.

Throws:

SAXException

parse

public void parse(String systemId)
           throws SAXException

Parses a new XML Schema document.

Throws:

SAXException

parse

public void parse(InputSource source)
           throws SAXException

Parses a new XML Schema document.

Note that if the InputSource does not have a system ID, XSOM will fail to resolve them.

Throws:

SAXException

getParserHandler

public ContentHandler getParserHandler()

Gets the parser implemented as a ContentHandler. One can feed XML Schema as SAX events to this interface to parse a schema. To parse multiple schema files, feed multiple sets of events.

If you don't send a complete event sequence from a startDocument event to an endDocument event, the state of XSOMParser can become unstable. This sometimes happen when you encounter an error while generating SAX events. Don't call the getResult method in that case.

This way of reading XML Schema can be useful when XML Schema is not available as a stand-alone XML document. For example, one can feed XML Schema inside a WSDL document.

getResult

public XSSchemaSet getResult()
                      throws SAXException

Gets the parsed result. Don't call this method until you parse all the schemas.

Returns:

If there was any parse error, this method returns null. To receive error information, specify your error handler through the setErrorHandler method.

Throws:

SAXException - This exception will never be thrown unless it is thrown by an error handler.

getDocuments

public Set<SchemaDocument> getDocuments()

Gets the set of SchemaDocument that represents parsed documents so far.

Returns:

can be empty but never null.

getEntityResolver

public EntityResolver getEntityResolver()

setEntityResolver

public void setEntityResolver(EntityResolver resolver)

Set an entity resolver that is used to resolve things like <xsd:import> and <xsd:include>.

getErrorHandler

public ErrorHandler getErrorHandler()

setErrorHandler

public void setErrorHandler(ErrorHandler errorHandler)

Set an error handler that receives all the errors encountered during the parsing.

setAnnotationParser

public void setAnnotationParser(Class annParser)

Sets the annotation parser. Annotation parser can be used to parse application-specific annotations inside a schema.

For each annotation, new instance of this class will be created and used to parse <xs:annotation>.

setAnnotationParser

public void setAnnotationParser(AnnotationParserFactory factory)

Sets the annotation parser factory.

The specified factory will be used to create AnnotationParsers.

getAnnotationParserFactory

public AnnotationParserFactory getAnnotationParserFactory()