public class ValidatingReader
extends java.lang.Object
implements org.xml.sax.XMLReader
This class is supplied for the benefit of applications that expect to perform validation by creating a validating SAX parser; it allows such applications to take advantage of the Saxon validator with no change to the application.
Constructor and Description |
---|
ValidatingReader()
Create a ValidatingReader.
|
ValidatingReader(EnterpriseConfiguration config)
Create a ValidatingReader that uses a specified Saxon Configuration.
|
ValidatingReader(EnterpriseConfiguration config,
org.xml.sax.XMLReader parser)
Create a ValidatingReader based on a supplied Saxon Configuration and a supplied
(presumably non-validating) XMLReader to perform the underlying XML parsing.
|
Modifier and Type | Method and Description |
---|---|
org.xml.sax.ContentHandler |
getContentHandler()
Return the current content handler.
|
org.xml.sax.DTDHandler |
getDTDHandler()
Return the current DTD handler.
|
org.xml.sax.EntityResolver |
getEntityResolver()
Return the current entity resolver.
|
org.xml.sax.ErrorHandler |
getErrorHandler()
Return the current error handler.
|
boolean |
getFeature(java.lang.String name)
Look up the value of a feature flag.
|
java.lang.Object |
getProperty(java.lang.String name)
Look up the value of a property.
|
void |
parse(org.xml.sax.InputSource input)
Parse an XML document.
|
void |
parse(java.lang.String systemId)
Parse an XML document from a system identifier (URI).
|
void |
setContentHandler(org.xml.sax.ContentHandler handler)
Allow an application to register a content event handler.
|
void |
setDTDHandler(org.xml.sax.DTDHandler handler)
Allow an application to register a DTD event handler.
|
void |
setEntityResolver(org.xml.sax.EntityResolver resolver)
Allow an application to register an entity resolver.
|
void |
setErrorHandler(org.xml.sax.ErrorHandler handler)
Allow an application to register an error event handler.
|
void |
setFeature(java.lang.String name,
boolean value)
Set the value of a feature flag.
|
void |
setProperty(java.lang.String name,
java.lang.Object value)
Set the value of a property.
|
public ValidatingReader()
public ValidatingReader(EnterpriseConfiguration config)
config
- the Saxon Configuration. The Configuration
can be pre-initialized with configuration options; it can also contain a pre-loaded cache
of schema components to be used for validationpublic ValidatingReader(EnterpriseConfiguration config, org.xml.sax.XMLReader parser)
config
- the Saxon Configuration. The Configuration
can be pre-initialized with configuration options; it can also contain a pre-loaded cache
of schema components to be used for validationparser
- The XML parser to be usedpublic boolean getFeature(java.lang.String name) throws org.xml.sax.SAXNotRecognizedException, org.xml.sax.SAXNotSupportedException
getFeature
in interface org.xml.sax.XMLReader
name
- The names that are recognized are the union of (a) the flags recognized by the underlying SAX XMLReader,
and (b) the properties of the Saxon Configuration that have boolean values. A feature name starting with
"http://saxon.sf.net" is assumed to be in the second category; these features are listed in
FeatureKeys
.org.xml.sax.SAXNotRecognizedException
- if the feature name is not recognizedorg.xml.sax.SAXNotSupportedException
public void setFeature(java.lang.String name, boolean value) throws org.xml.sax.SAXNotRecognizedException, org.xml.sax.SAXNotSupportedException
setFeature
in interface org.xml.sax.XMLReader
name
- The names that are recognized are the union of (a) the flags recognized by the underlying SAX XMLReader,
and (b) the properties of the Saxon Configuration that have boolean values. A feature name starting with
"http://saxon.sf.net" is assumed to be in the second category; these features are listed in
FeatureKeys
.value
- true or falseorg.xml.sax.SAXNotRecognizedException
- if the feature name is not recognized, or if it is the name of a
Saxon configuration property whose value is not booleanorg.xml.sax.SAXNotSupportedException
public java.lang.Object getProperty(java.lang.String name) throws org.xml.sax.SAXNotRecognizedException, org.xml.sax.SAXNotSupportedException
getProperty
in interface org.xml.sax.XMLReader
name
- The names that are recognized are the union of (a) the properties recognized by the underlying SAX XMLReader,
and (b) the properties of the Saxon Configuration. A feature name starting with
"http://saxon.sf.net" is assumed to be in the second category; these features are listed in
FeatureKeys
.org.xml.sax.SAXNotRecognizedException
- if the property name is not recognizedorg.xml.sax.SAXNotSupportedException
public void setProperty(java.lang.String name, java.lang.Object value) throws org.xml.sax.SAXNotRecognizedException, org.xml.sax.SAXNotSupportedException
setProperty
in interface org.xml.sax.XMLReader
name
- The names that are recognized are the union of
(a) the properties recognized by the underlying SAX XMLReader,
and (b) the properties of the Saxon Configuration. A feature name starting with
"http://saxon.sf.net" is assumed to be in the second category; these features are listed in
FeatureKeys
.
Saxon accepts the Apache-defined properties
http://apache.org/xml/properties/schema/external-noNamespaceSchemaLocation
and
http://apache.org/xml/properties/schema/external-schemaLocation
to define the
location of schema documents. These properties may be set repeatedly to load more than one
schema document.
To enable schema validation using XSD 1.1, the property FeatureKeys.XSD_VERSION
must be set to the value "1.1".
value
- the value of the propertyorg.xml.sax.SAXNotRecognizedException
- if the property name is not recognized, or if the value is inappropriateorg.xml.sax.SAXNotSupportedException
public void setEntityResolver(org.xml.sax.EntityResolver resolver)
If the application does not register an entity resolver, the XMLReader will perform its own default resolution.
Applications may register a new or different resolver in the middle of a parse, and the SAX parser must begin using the new resolver immediately.
setEntityResolver
in interface org.xml.sax.XMLReader
resolver
- The entity resolver.getEntityResolver()
public org.xml.sax.EntityResolver getEntityResolver()
getEntityResolver
in interface org.xml.sax.XMLReader
setEntityResolver(org.xml.sax.EntityResolver)
public void setDTDHandler(org.xml.sax.DTDHandler handler)
If the application does not register a DTD handler, all DTD events reported by the SAX parser will be silently ignored.
Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.
setDTDHandler
in interface org.xml.sax.XMLReader
handler
- The DTD handler.getDTDHandler()
public org.xml.sax.DTDHandler getDTDHandler()
getDTDHandler
in interface org.xml.sax.XMLReader
setDTDHandler(org.xml.sax.DTDHandler)
public void setContentHandler(org.xml.sax.ContentHandler handler)
If the application does not register a content handler, all content events reported by the SAX parser will be silently ignored.
Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.
setContentHandler
in interface org.xml.sax.XMLReader
handler
- The content handler.getContentHandler()
public org.xml.sax.ContentHandler getContentHandler()
getContentHandler
in interface org.xml.sax.XMLReader
setContentHandler(org.xml.sax.ContentHandler)
public void setErrorHandler(org.xml.sax.ErrorHandler handler)
If the application does not register an error handler, all error events reported by the SAX parser will be silently ignored; however, normal processing may not continue. It is highly recommended that all SAX applications implement an error handler to avoid unexpected bugs.
Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.
setErrorHandler
in interface org.xml.sax.XMLReader
handler
- The error handler.getErrorHandler()
public org.xml.sax.ErrorHandler getErrorHandler()
getErrorHandler
in interface org.xml.sax.XMLReader
setErrorHandler(org.xml.sax.ErrorHandler)
public void parse(org.xml.sax.InputSource input) throws java.io.IOException, org.xml.sax.SAXException
The application can use this method to instruct the XML reader to begin parsing an XML document from any valid input source (a character stream, a byte stream, or a URI).
Applications may not invoke this method while a parse is in progress (they should create a new XMLReader instead for each nested XML document). Once a parse is complete, an application may reuse the same XMLReader object, possibly with a different input source. Configuration of the XMLReader object (such as handler bindings and values established for feature flags and properties) is unchanged by completion of a parse, unless the definition of that aspect of the configuration explicitly specifies other behavior. (For example, feature flags or properties exposing characteristics of the document being parsed.)
During the parse, the XMLReader will provide information about the XML document through the registered event handlers.
This method is synchronous: it will not return until parsing has ended. If a client application wants to terminate parsing early, it should throw an exception.
parse
in interface org.xml.sax.XMLReader
input
- The input source for the top-level of the
XML document.org.xml.sax.SAXException
- Any SAX exception, possibly
wrapping another exception.java.io.IOException
- An IO exception from the parser,
possibly from a byte stream or character stream
supplied by the application.InputSource
,
parse(String)
,
setEntityResolver(org.xml.sax.EntityResolver)
,
setDTDHandler(org.xml.sax.DTDHandler)
,
setContentHandler(org.xml.sax.ContentHandler)
,
setErrorHandler(org.xml.sax.ErrorHandler)
public void parse(java.lang.String systemId) throws java.io.IOException, org.xml.sax.SAXException
This method is a shortcut for the common case of reading a document from a system identifier. It is the exact equivalent of the following:
parse(new InputSource(systemId));
If the system identifier is a URL, it must be fully resolved by the application before it is passed to the parser.
parse
in interface org.xml.sax.XMLReader
systemId
- The system identifier (URI).org.xml.sax.SAXException
- Any SAX exception, possibly
wrapping another exception.java.io.IOException
- An IO exception from the parser,
possibly from a byte stream or character stream
supplied by the application.parse(org.xml.sax.InputSource)
Copyright (c) 2004-2018 Saxonica Limited. All rights reserved.