| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.xml.validation.ValidatorHandler
Streaming validator that works on SAX stream.
 A ValidatorHandler object is a thread-unsafe, non-reentrant object.
 In other words, it is the application's responsibility to make
 sure that one ValidatorHandler object is not used from
 more than one thread at any given time.
 
 
 ValidatorHandler checks if the SAX events follow 
 the set of constraints described in the associated Schema,
 and additionally it may modify the SAX events (for example
 by adding default values, etc.)
 
 
 ValidatorHandler extends from ContentHandler,
 but it refines the underlying ContentHandler in
 the following way:
 
uri, localName, and qname,
      even though SAX allows some of them to be null.
      Similarly, the user-specified ContentHandler will receive non-null
      Strings for all three parameters.
 
  ValidatorHandler's
      ContentHandler.startPrefixMapping(String,String) and
      ContentHandler.endPrefixMapping(String) are invoked
      properly. Similarly, the user-specified ContentHandler
      will receive startPrefixMapping/endPrefixMapping events.
      If the ValidatorHandler introduces additional namespace
      bindings, the user-specified ContentHandler will receive
      additional startPrefixMapping/endPrefixMapping events.
 
  Attributes for the
      ContentHandler.startElement(String,String,String,Attributes) method
      may or may not include xmlns* attributes.
 
 A ValidatorHandler is automatically reset every time
 the startDocument method is invoked.
 
 
 This spec defines the following feature that must be recognized
 by all ValidatorHandler implementations.
 
 
http://xml.org/sax/features/namespace-prefixes
 This feature controls how a ValidatorHandler introduces
 namespace bindings that were not present in the original SAX event
 stream.
 When this feature is set to true, it must make
 sure that the user's ContentHandler will see 
 the corresponding xmlns* attribute in
 the Attributes object of the
 ContentHandler.startElement(String,String,String,Attributes)
 callback. Otherwise, xmlns* attributes must not be
 added to Attributes that's passed to the
 user-specified ContentHandler.
 
 
 (Note that regardless of this switch, namespace bindings are
 always notified to applications through 
 ContentHandler.startPrefixMapping(String,String) and
 ContentHandler.endPrefixMapping(String) methods of the
 ContentHandler specified by the user.)
 
 
 Note that this feature does NOT affect the way
 a ValidatorHandler receives SAX events. It merely
 changes the way it augments SAX events.
 
 
This feature is set to false by default.
| Constructor Summary | |
| protected  | ValidatorHandler()Constructor for derived classes. | 
| Method Summary | |
| abstract  org.xml.sax.ContentHandler | getContentHandler()Gets the ContentHandlerwhich receives the
 augmented validation result. | 
| abstract  org.xml.sax.ErrorHandler | getErrorHandler()Gets the current ErrorHandlerset to thisValidatorHandler. | 
|  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. | 
| abstract  org.w3c.dom.ls.LSResourceResolver | getResourceResolver()Gets the current LSResourceResolverset to thisValidatorHandler. | 
| abstract  TypeInfoProvider | getTypeInfoProvider()Obtains the TypeInfoProviderimplementation of thisValidatorHandler. | 
| abstract  void | setContentHandler(org.xml.sax.ContentHandler receiver)Sets the ContentHandlerwhich receives
 the augmented validation result. | 
| abstract  void | setErrorHandler(org.xml.sax.ErrorHandler errorHandler)Sets the ErrorHandlerto receive errors encountered
 during the validation. | 
|  void | setFeature(java.lang.String name,
           boolean value)Set the value of a feature flag. | 
|  void | setProperty(java.lang.String name,
            java.lang.Object object)Set the value of a property. | 
| abstract  void | setResourceResolver(org.w3c.dom.ls.LSResourceResolver resourceResolver)Sets the LSResourceResolverto customize
 resource resolution while in a validation episode. | 
| Methods inherited from class java.lang.Object | 
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Methods inherited from interface org.xml.sax.ContentHandler | 
| characters, endDocument, endElement, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startElement, startPrefixMapping | 
| Constructor Detail | 
protected ValidatorHandler()
The constructor does nothing.
 Derived classes must create ValidatorHandler objects that have
 null ErrorHandler and
 null LSResourceResolver.
| Method Detail | 
public abstract void setContentHandler(org.xml.sax.ContentHandler receiver)
ContentHandler which receives
 the augmented validation result.
 
 When a ContentHandler is specified, a
 ValidatorHandler will work as a filter
 and basically copy the incoming events to the
 specified ContentHandler.
 
 
 In doing so, a ValidatorHandler may modify
 the events, for example by adding defaulted attributes.
 
 
 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.
  ValidatorHandler may not introduce new elements that
      were not present in the input.
 
  ValidatorHandler may not remove attributes that were
      present in the input.
 
 When a callback method on the specified ContentHandler
 throws an exception, the same exception object must be thrown
 from the ValidatorHandler. The ErrorHandler
 should not be notified of such an exception.
 
 
This method can be called even during a middle of a validation.
receiver - A ContentHandler or a null value.public abstract org.xml.sax.ContentHandler getContentHandler()
ContentHandler which receives the
 augmented validation result.
getContentHandler() method, or null
      if that method has never been called since this ValidatorHandler
      has created.setContentHandler(ContentHandler)public abstract void setErrorHandler(org.xml.sax.ErrorHandler errorHandler)
ErrorHandler to receive errors encountered
 during the validation.
 
 
 Error handler can be used to customize the error handling process
 during a validation. When an ErrorHandler is set,
 errors found during the validation will be first sent
 to the ErrorHandler.
 
 
 The error handler can abort further validation immediately
 by throwing SAXException from the handler. Or for example
 it can print an error to the screen and try to continue the
 validation by returning normally from the ErrorHandler 
 
 
 If any Throwable is thrown from an ErrorHandler,
 the same Throwable object will be thrown toward the
 root of the call stack.
 
 
 ValidatorHandler is not allowed to
 throw SAXException without first reporting it to
 ErrorHandler.
 
 
 When the ErrorHandler is null, the implementation will
 behave as if the following ErrorHandler is set:
 
class DraconianErrorHandler implementsErrorHandler{ public void fatalError(SAXParseExceptione ) throwsSAXException{ throw e; } public void error(SAXParseExceptione ) throwsSAXException{ throw e; } public void warning(SAXParseExceptione ) throwsSAXException{ // noop } }
 When a new ValidatorHandler object is created, initially
 this field is set to null.
errorHandler - A new error handler to be set. This parameter can be null.public abstract org.xml.sax.ErrorHandler getErrorHandler()
ErrorHandler set to this ValidatorHandler.
setErrorHandler(ErrorHandler) method, or null
      if that method has never been called since this ValidatorHandler
      has created.setErrorHandler(ErrorHandler)public abstract void setResourceResolver(org.w3c.dom.ls.LSResourceResolver resourceResolver)
LSResourceResolver to customize
 resource resolution while in a validation episode.
 
 
 ValidatorHandler uses a LSResourceResolver
 when it needs to locate external resources while a validation,
 although exactly what constitutes "locating external resources" is
 up to each schema language.
 
 
 When the LSResourceResolver is null, the implementation will
 behave as if the following LSResourceResolver is set:
 
class DumbLSResourceResolver implementsLSResourceResolver{ publicLSInputresolveResource( String publicId, String systemId, String baseURI) { return null; // always return null } }
 If a LSResourceResolver throws a RuntimeException
  (or instances of its derived classes),
 then the ValidatorHandler will abort the parsing and  
 the caller of the validate method will receive
 the same RuntimeException. 
 
 
 When a new ValidatorHandler object is created, initially
 this field is set to null.
resourceResolver - A new resource resolver to be set. This parameter can be null.public abstract org.w3c.dom.ls.LSResourceResolver getResourceResolver()
LSResourceResolver set to this ValidatorHandler.
setResourceResolver(LSResourceResolver) method, or null
      if that method has never been called since this ValidatorHandler
      has created.setErrorHandler(ErrorHandler)public abstract 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.
 
 
Some schema languages do not define the notion of type, for those languages, this method may not be supported. However, to be compliant with this specification, implementations for W3C XML Schema 1.0 must support this operation.
TypeInfo.
      Otherwise a non-null valid TypeInfoProvider.
public boolean getFeature(java.lang.String name)
                   throws org.xml.sax.SAXNotRecognizedException,
                          org.xml.sax.SAXNotSupportedException
The feature name is any fully-qualified URI.  It is
 possible for a ValidatorHandler to recognize a feature name but
 temporarily be unable to return its value.
 Some feature values may be available only in specific
 contexts, such as before, during, or after a validation.
 
Implementors are free (and encouraged) to invent their own features, using names built on their own URIs.
name - The feature name, which is a non-null fully-qualified URI.
org.xml.sax.SAXNotRecognizedException - If the feature
            value can't be assigned or retrieved.
org.xml.sax.SAXNotSupportedException - When the
            ValidatorHandler recognizes the feature name but 
            cannot determine its value at this time.
java.lang.NullPointerException - When the name parameter is null.setFeature(String, boolean)
public void setFeature(java.lang.String name,
                       boolean value)
                throws org.xml.sax.SAXNotRecognizedException,
                       org.xml.sax.SAXNotSupportedException
 Feature can be used to control the way a ValidatorHandler
 parses schemas, although ValidatorHandlers are not required
 to recognize any specific property names.
The feature name is any fully-qualified URI.  It is
 possible for a ValidatorHandler to expose a feature value but
 to be unable to change the current value.
 Some feature values may be immutable or mutable only 
 in specific contexts, such as before, during, or after 
 a validation.
name - The feature name, which is a non-null fully-qualified URI.value - The requested value of the feature (true or false).
org.xml.sax.SAXNotRecognizedException - If the feature
            value can't be assigned or retrieved.
org.xml.sax.SAXNotSupportedException - When the
            ValidatorHandler recognizes the feature name but 
            cannot set the requested value.
java.lang.NullPointerException - When the name parameter is null.getFeature(String)
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.
ValidatorHandlers are not required to recognize setting
 any specific property names.
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
            ValidatorHandler recognizes the property name but 
            cannot set the requested value.
java.lang.NullPointerException - When the name parameter is null.
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.
ValidatorHandlers are not required to recognize any specific
 property names.
Implementors are free (and encouraged) to invent their own properties, using names built on their own URIs.
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)| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||