public class ValidatorHandlerImpl
extends javax.xml.validation.ValidatorHandler
implements org.xml.sax.ContentHandler, org.xml.sax.ext.LexicalHandler, org.xml.sax.DTDHandler
A ValidatorHandler is the front end to a rather complex pipeline. The ValidatorHandler is the first stage in the pipeline: it receives events from a SAX parser or other source of SAX events. The next stage is a ReceivingContentHandler, which translates SAX events into Receiver events. This is followed by a number of Receivers to do the validation (actually a stack of Receivers, since a new ComplexContentValidator is added each time a new element starts). The last Receiver is the finalProxy: this translates Receiver events back into SAX2 events, for delivery to the user's ContentHandler.
The user's ContentHandler has access to a TypeInfoProvider that gives information about the types of elements and attributes. This information is passed down the Receiver pipeline in the form of typeCodes associated with element and attribute events. The TypeInfoProvider is part of the finalProxy, which saves the type information locally and returns it to the user's ContentHandler on request. The TypeInfo objects supplied by the TypeInfoProvider are in fact the schema components representing the type, as a SchemaType object.
Constructor and Description |
---|
ValidatorHandlerImpl() |
Modifier and Type | Method and Description |
---|---|
void |
characters(char[] ch,
int start,
int length)
Receive notification of character data.
|
void |
comment(char[] ch,
int start,
int length)
Report an XML comment anywhere in the document.
|
void |
endCDATA()
Report the end of a CDATA section.
|
void |
endDocument()
Receive notification of the end of a document.
|
void |
endDTD()
Report the end of DTD declarations.
|
void |
endElement(java.lang.String uri,
java.lang.String localName,
java.lang.String qName)
Receive notification of the end of an element.
|
void |
endEntity(java.lang.String name)
Report the end of an entity.
|
void |
endPrefixMapping(java.lang.String prefix)
End the scope of a prefix-URI mapping.
|
EnterpriseConfiguration |
getConfiguration()
Get the Configuration object
|
org.xml.sax.ContentHandler |
getContentHandler()
Gets the
ContentHandler which receives the
augmented validation result. |
org.xml.sax.ErrorHandler |
getErrorHandler()
Gets the current
ErrorHandler |
java.lang.Object |
getProperty(java.lang.String name)
Look up the value of a property.
|
org.w3c.dom.ls.LSResourceResolver |
getResourceResolver()
Gets the current
LSResourceResolver |
javax.xml.validation.TypeInfoProvider |
getTypeInfoProvider()
Obtains the
TypeInfoProvider implementation of this
ValidatorHandler . |
void |
ignorableWhitespace(char[] ch,
int start,
int length)
Receive notification of ignorable whitespace in element content.
|
void |
notationDecl(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId)
Receive notification of a notation declaration event.
|
void |
processingInstruction(java.lang.String target,
java.lang.String data)
Receive notification of a processing instruction.
|
void |
setContentHandler(org.xml.sax.ContentHandler receiver)
Sets the
ContentHandler which receives
the augmented validation result. |
void |
setDocumentLocator(org.xml.sax.Locator locator)
Receive an object for locating the origin of SAX document events.
|
void |
setErrorHandler(org.xml.sax.ErrorHandler errorHandler)
Sets the
ErrorHandler to receive errors encountered
during the validation. |
void |
setFinalProxy(TypedContentHandler proxy)
Set the TypedContentHandler that acts as the final stage in this pipeline, receiving
typed events from the validator stack
|
void |
setPipelineConfiguration(PipelineConfiguration pipe)
Set the pipeline configuration used by this validator handler
|
void |
setProperty(java.lang.String name,
java.lang.Object object)
Set the value of a property.
|
void |
setReceivingContentHandler(ReceivingContentHandler rch)
Get the ReceivingContentHandler that receives the SAX events at the start of this pipeline
|
void |
setResourceResolver(org.w3c.dom.ls.LSResourceResolver resourceResolver)
Sets the
LSResourceResolver to customize
resource resolution while in a validation episode. |
void |
skippedEntity(java.lang.String name)
Receive notification of a skipped entity.
|
void |
startCDATA()
Report the start of a CDATA section.
|
void |
startDocument()
Receive notification of the beginning of a document.
|
void |
startDTD(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId)
Report the start of DTD declarations, if any.
|
void |
startElement(java.lang.String uri,
java.lang.String localName,
java.lang.String qName,
org.xml.sax.Attributes atts)
Receive notification of the beginning of an element.
|
void |
startEntity(java.lang.String name)
Report the beginning of some internal and external XML entities.
|
void |
startPrefixMapping(java.lang.String prefix,
java.lang.String uri)
Begin the scope of a prefix-URI Namespace mapping.
|
void |
unparsedEntityDecl(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId,
java.lang.String notationName)
Receive notification of an unparsed entity declaration event.
|
public void setPipelineConfiguration(PipelineConfiguration pipe)
pipe
- the pipeline configurationpublic void setReceivingContentHandler(ReceivingContentHandler rch)
rch
- the ReceivingContentHandlerpublic void setFinalProxy(TypedContentHandler proxy)
proxy
- the TypedContentHandler at the end of the pipelinepublic void setContentHandler(org.xml.sax.ContentHandler receiver)
ContentHandler
which receives
the augmented validation result.
A ValidatorHandler
may buffer events to certain
extent, but to allow ValidatorHandler
to be used
by a parser, the following requirement has to be met.
ContentHandler.startElement(String, String, String, Attributes)
,
ContentHandler.endElement(String, String, String)
,
ContentHandler.startDocument()
, or
ContentHandler.endDocument()
are invoked on a ValidatorHandler
,
the same method on the user-specified ContentHandler
must be invoked for the same event before the callback
returns.
The Saxon implementation does not meet this requirement. StartElement events are buffered until the first thing following the attributes is encountered.
setContentHandler
in class javax.xml.validation.ValidatorHandler
receiver
- A ContentHandler
or a null value.public org.xml.sax.ContentHandler getContentHandler()
ContentHandler
which receives the
augmented validation result.getContentHandler
in class javax.xml.validation.ValidatorHandler
setContentHandler(org.xml.sax.ContentHandler)
method, or null
if that method has never been called since this ValidatorHandler
has created.setContentHandler(org.xml.sax.ContentHandler)
public void setErrorHandler(org.xml.sax.ErrorHandler errorHandler)
ErrorHandler
to receive errors encountered
during the validation.setErrorHandler
in class javax.xml.validation.ValidatorHandler
errorHandler
- A new error handler to be set. This parameter can be null.public org.xml.sax.ErrorHandler getErrorHandler()
ErrorHandler
getErrorHandler
in class javax.xml.validation.ValidatorHandler
setErrorHandler(org.xml.sax.ErrorHandler)
method, or null
if that method has never been calledsetErrorHandler(org.xml.sax.ErrorHandler)
public void setResourceResolver(org.w3c.dom.ls.LSResourceResolver resourceResolver)
LSResourceResolver
to customize
resource resolution while in a validation episode.setResourceResolver
in class javax.xml.validation.ValidatorHandler
resourceResolver
- A new resource resolver to be set. This parameter can be null.public org.w3c.dom.ls.LSResourceResolver getResourceResolver()
LSResourceResolver
getResourceResolver
in class javax.xml.validation.ValidatorHandler
setResourceResolver(org.w3c.dom.ls.LSResourceResolver)
method, or null
if that method has never been calledpublic javax.xml.validation.TypeInfoProvider getTypeInfoProvider()
TypeInfoProvider
implementation of this
ValidatorHandler
.
The obtained TypeInfoProvider
can be queried during a parse
to access the type information determined by the validator.getTypeInfoProvider
in class javax.xml.validation.ValidatorHandler
TypeInfoProvider
.public void setDocumentLocator(org.xml.sax.Locator locator)
setDocumentLocator
in interface org.xml.sax.ContentHandler
locator
- an object that can return the location of
any SAX document eventLocator
public java.lang.Object getProperty(java.lang.String name) throws org.xml.sax.SAXNotRecognizedException, org.xml.sax.SAXNotSupportedException
The property name is any fully-qualified URI. It is
possible for a ValidatorHandler
to recognize a property name but
temporarily be unable to return its value.
Some property values may be available only in specific
contexts, such as before, during, or after a validation.
Validator
s are not required to recognize any specific
property names.
In the Saxon implementation, the property names that are recognized are the same as the
attribute names recognised by a TransformerFactory
.
These are listed as constant fields
in the class FeatureKeys
getProperty
in class javax.xml.validation.ValidatorHandler
name
- The property name, which is a non-null fully-qualified URI.org.xml.sax.SAXNotRecognizedException
- If the property
value can't be assigned or retrieved.org.xml.sax.SAXNotSupportedException
- When the
XMLReader recognizes the property name but
cannot determine its value at this time.java.lang.NullPointerException
- When the name parameter is null.setProperty(String, Object)
public void setProperty(java.lang.String name, java.lang.Object object) throws org.xml.sax.SAXNotRecognizedException, org.xml.sax.SAXNotSupportedException
The property name is any fully-qualified URI. It is
possible for a ValidatorHandler
to recognize a property name but
to be unable to change the current value.
Some property values may be immutable or mutable only
in specific contexts, such as before, during, or after
a validation.
In the Saxon implementation, the property names that are recognized are the same as the
attribute names recognised by a TransformerFactory
.
These are listed as constant fields
in the class FeatureKeys
setProperty
in class javax.xml.validation.ValidatorHandler
name
- The property name, which is a non-null fully-qualified URI.object
- The requested value for the property.org.xml.sax.SAXNotRecognizedException
- If the property
value can't be assigned or retrieved.org.xml.sax.SAXNotSupportedException
- When the
Validator
recognizes the property name but
cannot set the requested value.java.lang.NullPointerException
- When the name parameter is null.public EnterpriseConfiguration getConfiguration()
public void startDocument() throws org.xml.sax.SAXException
The SAX parser will invoke this method only once, before any
other event callbacks (except for setDocumentLocator
).
startDocument
in interface org.xml.sax.ContentHandler
org.xml.sax.SAXException
- any SAX exception, possibly
wrapping another exceptionendDocument()
public void endDocument() throws org.xml.sax.SAXException
endDocument
in interface org.xml.sax.ContentHandler
org.xml.sax.SAXException
- any SAX exception, possibly
wrapping another exceptionpublic void startPrefixMapping(java.lang.String prefix, java.lang.String uri) throws org.xml.sax.SAXException
There should never be start/endPrefixMapping events for the "xml" prefix, since it is predeclared and immutable.
startPrefixMapping
in interface org.xml.sax.ContentHandler
prefix
- the Namespace prefix being declared.
An empty string is used for the default element namespace,
which has no prefix.uri
- the Namespace URI the prefix is mapped toorg.xml.sax.SAXException
- the client may throw
an exception during processingendPrefixMapping(java.lang.String)
,
startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)
public void endPrefixMapping(java.lang.String prefix) throws org.xml.sax.SAXException
endPrefixMapping
in interface org.xml.sax.ContentHandler
prefix
- the prefix that was being mapped.
This is the empty string when a default mapping scope ends.org.xml.sax.SAXException
- the client may throw
an exception during processingpublic void startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts) throws org.xml.sax.SAXException
startElement
in interface org.xml.sax.ContentHandler
uri
- the Namespace URI, or the empty string if the
element has no Namespace URI or if Namespace
processing is not being performedlocalName
- the local name (without prefix), or the
empty string if Namespace processing is not being
performedqName
- the qualified name (with prefix), or the
empty string if qualified names are not availableatts
- the attributes attached to the element. If
there are no attributes, it shall be an empty
Attributes object. The value of this object after
startElement returns is undefinedorg.xml.sax.SAXException
- any SAX exception, possibly
wrapping another exceptionpublic void endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName) throws org.xml.sax.SAXException
endElement
in interface org.xml.sax.ContentHandler
org.xml.sax.SAXException
public void characters(char[] ch, int start, int length) throws org.xml.sax.SAXException
characters
in interface org.xml.sax.ContentHandler
org.xml.sax.SAXException
public void ignorableWhitespace(char[] ch, int start, int length) throws org.xml.sax.SAXException
ignorableWhitespace
in interface org.xml.sax.ContentHandler
org.xml.sax.SAXException
public void processingInstruction(java.lang.String target, java.lang.String data) throws org.xml.sax.SAXException
processingInstruction
in interface org.xml.sax.ContentHandler
org.xml.sax.SAXException
public void skippedEntity(java.lang.String name) throws org.xml.sax.SAXException
skippedEntity
in interface org.xml.sax.ContentHandler
org.xml.sax.SAXException
public void startDTD(java.lang.String name, java.lang.String publicId, java.lang.String systemId) throws org.xml.sax.SAXException
startDTD
in interface org.xml.sax.ext.LexicalHandler
org.xml.sax.SAXException
public void endDTD() throws org.xml.sax.SAXException
endDTD
in interface org.xml.sax.ext.LexicalHandler
org.xml.sax.SAXException
public void startEntity(java.lang.String name) throws org.xml.sax.SAXException
startEntity
in interface org.xml.sax.ext.LexicalHandler
org.xml.sax.SAXException
public void endEntity(java.lang.String name) throws org.xml.sax.SAXException
endEntity
in interface org.xml.sax.ext.LexicalHandler
org.xml.sax.SAXException
public void startCDATA() throws org.xml.sax.SAXException
startCDATA
in interface org.xml.sax.ext.LexicalHandler
org.xml.sax.SAXException
public void endCDATA() throws org.xml.sax.SAXException
endCDATA
in interface org.xml.sax.ext.LexicalHandler
org.xml.sax.SAXException
public void comment(char[] ch, int start, int length) throws org.xml.sax.SAXException
comment
in interface org.xml.sax.ext.LexicalHandler
org.xml.sax.SAXException
public void notationDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId) throws org.xml.sax.SAXException
notationDecl
in interface org.xml.sax.DTDHandler
org.xml.sax.SAXException
public void unparsedEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String notationName) throws org.xml.sax.SAXException
unparsedEntityDecl
in interface org.xml.sax.DTDHandler
org.xml.sax.SAXException
Copyright (c) 2004-2018 Saxonica Limited. All rights reserved.