org.apache.xerces.jaxp
Class SAXParserImpl

java.lang.Object
  |
  +--javax.xml.parsers.SAXParser
        |
        +--org.apache.xerces.jaxp.SAXParserImpl
All Implemented Interfaces:
JAXPConstants, org.apache.xerces.xs.PSVIProvider

public class SAXParserImpl
extends javax.xml.parsers.SAXParser
implements JAXPConstants, org.apache.xerces.xs.PSVIProvider

This is the implementation specific class for the javax.xml.parsers.SAXParser.

Version:
$Id: SAXParserImpl.java 704573 2008-10-14 16:11:22Z mrglavas $
Author:
Rajiv Mordani, Edwin Goei

Inner Class Summary
static class SAXParserImpl.JAXPSAXParser
          Extension of SAXParser.
 
Fields inherited from interface org.apache.xerces.jaxp.JAXPConstants
JAXP_SCHEMA_LANGUAGE, JAXP_SCHEMA_SOURCE, W3C_XML_SCHEMA
 
Method Summary
 org.apache.xerces.xs.AttributePSVI getAttributePSVI(int index)
          Provides AttributePSVI given the index of an attribute information item in the current element's attribute list.
 org.apache.xerces.xs.AttributePSVI getAttributePSVIByName(java.lang.String uri, java.lang.String localname)
          Provides AttributePSVI given the namespace name and the local name of an attribute information item in the current element's attribute list.
 org.apache.xerces.xs.ElementPSVI getElementPSVI()
          Provides the post schema validation item for the current element information item.
 org.xml.sax.Parser getParser()
          Returns the SAX parser that is encapsulated by the implementation of this class.
 java.lang.Object getProperty(java.lang.String name)
          returns the particular property requested for in the underlying implementation of org.xml.sax.XMLReader.
 javax.xml.validation.Schema getSchema()
          Get a reference to the the Schema being used by the XML processor.
 org.xml.sax.XMLReader getXMLReader()
          Returns the XMLReader that is encapsulated by the implementation of this class.
 boolean isNamespaceAware()
          Indicates whether or not this parser is configured to understand namespaces.
 boolean isValidating()
          Indicates whether or not this parser is configured to validate XML documents.
 boolean isXIncludeAware()
          Gets the XInclude processing mode for this parser
 void parse(org.xml.sax.InputSource is, org.xml.sax.helpers.DefaultHandler dh)
          Parse the content given InputSource as XML using the specified DefaultHandler.
 void parse(org.xml.sax.InputSource is, org.xml.sax.HandlerBase hb)
          Parse the content given InputSource as XML using the specified HandlerBase.
 void reset()
          Reset this SAXParser to its original configuration.
 void setProperty(java.lang.String name, java.lang.Object value)
          Sets the particular property in the underlying implementation of org.xml.sax.XMLReader.
 
Methods inherited from class javax.xml.parsers.SAXParser
parse, parse, parse, parse, parse, parse, parse, parse
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getParser

public org.xml.sax.Parser getParser()
                             throws org.xml.sax.SAXException
Description copied from class: javax.xml.parsers.SAXParser
Returns the SAX parser that is encapsulated by the implementation of this class.
Overrides:
getParser in class javax.xml.parsers.SAXParser
Following copied from class: javax.xml.parsers.SAXParser
Returns:
The SAX parser that is encapsulated by the implementation of this class.
Throws:
org.xml.sax.SAXException - If any SAX errors occur during processing.

getXMLReader

public org.xml.sax.XMLReader getXMLReader()
Returns the XMLReader that is encapsulated by the implementation of this class.
Overrides:
getXMLReader in class javax.xml.parsers.SAXParser
Following copied from class: javax.xml.parsers.SAXParser
Returns:
The XMLReader that is encapsulated by the implementation of this class.
Throws:
org.xml.sax.SAXException - If any SAX errors occur during processing.

isNamespaceAware

public boolean isNamespaceAware()
Description copied from class: javax.xml.parsers.SAXParser
Indicates whether or not this parser is configured to understand namespaces.
Overrides:
isNamespaceAware in class javax.xml.parsers.SAXParser
Following copied from class: javax.xml.parsers.SAXParser
Returns:
true if this parser is configured to understand namespaces; false otherwise.

isValidating

public boolean isValidating()
Description copied from class: javax.xml.parsers.SAXParser
Indicates whether or not this parser is configured to validate XML documents.
Overrides:
isValidating in class javax.xml.parsers.SAXParser
Following copied from class: javax.xml.parsers.SAXParser
Returns:
true if this parser is configured to validate XML documents; false otherwise.

isXIncludeAware

public boolean isXIncludeAware()
Gets the XInclude processing mode for this parser
Overrides:
isXIncludeAware in class javax.xml.parsers.SAXParser
Returns:
the state of XInclude processing mode

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)
                 throws org.xml.sax.SAXNotRecognizedException,
                        org.xml.sax.SAXNotSupportedException
Sets the particular property in the underlying implementation of org.xml.sax.XMLReader.
Overrides:
setProperty in class javax.xml.parsers.SAXParser
Following copied from class: javax.xml.parsers.SAXParser
Parameters:
name - The name of the property to be set.
value - The value of the property to be set.
Throws:
org.xml.sax.SAXNotRecognizedException - When the underlying XMLReader does not recognize the property name.
org.xml.sax.SAXNotSupportedException - When the underlying XMLReader recognizes the property name but doesn't support the property.
See Also:
XMLReader.setProperty(java.lang.String, java.lang.Object)

getProperty

public java.lang.Object getProperty(java.lang.String name)
                             throws org.xml.sax.SAXNotRecognizedException,
                                    org.xml.sax.SAXNotSupportedException
returns the particular property requested for in the underlying implementation of org.xml.sax.XMLReader.
Overrides:
getProperty in class javax.xml.parsers.SAXParser
Following copied from class: javax.xml.parsers.SAXParser
Parameters:
name - The name of the property to be retrieved.
Returns:
Value of the requested property.
Throws:
org.xml.sax.SAXNotRecognizedException - When the underlying XMLReader does not recognize the property name.
org.xml.sax.SAXNotSupportedException - When the underlying XMLReader recognizes the property name but doesn't support the property.
See Also:
XMLReader.getProperty(java.lang.String)

parse

public void parse(org.xml.sax.InputSource is,
                  org.xml.sax.helpers.DefaultHandler dh)
           throws org.xml.sax.SAXException,
                  java.io.IOException
Description copied from class: javax.xml.parsers.SAXParser
Parse the content given InputSource as XML using the specified DefaultHandler.
Overrides:
parse in class javax.xml.parsers.SAXParser
Following copied from class: javax.xml.parsers.SAXParser
Parameters:
is - The InputSource containing the content to be parsed.
dh - The SAX DefaultHandler to use.
Throws:
java.lang.IllegalArgumentException - If the InputSource object is null.
java.io.IOException - If any IO errors occur.
org.xml.sax.SAXException - If any SAX errors occur during processing.
See Also:
DocumentHandler

parse

public void parse(org.xml.sax.InputSource is,
                  org.xml.sax.HandlerBase hb)
           throws org.xml.sax.SAXException,
                  java.io.IOException
Description copied from class: javax.xml.parsers.SAXParser
Parse the content given InputSource as XML using the specified HandlerBase. Use of the DefaultHandler version of this method is recommended as the HandlerBase class has been deprecated in SAX 2.0
Overrides:
parse in class javax.xml.parsers.SAXParser
Following copied from class: javax.xml.parsers.SAXParser
Parameters:
is - The InputSource containing the content to be parsed.
hb - The SAX HandlerBase to use.
Throws:
java.lang.IllegalArgumentException - If the InputSource object is null.
java.io.IOException - If any IO errors occur.
org.xml.sax.SAXException - If any SAX errors occur during processing.
See Also:
DocumentHandler

getSchema

public javax.xml.validation.Schema getSchema()
Description copied from class: javax.xml.parsers.SAXParser

Get a reference to the the Schema being used by the XML processor.

If no schema is being used, null is returned.

Overrides:
getSchema in class javax.xml.parsers.SAXParser
Following copied from class: javax.xml.parsers.SAXParser
Returns:
Schema being used or null if none in use
Throws:
UnsupportedOperationException - For backward compatibility, when implementations for earlier versions of JAXP is used, this exception will be thrown.

reset

public void reset()
Description copied from class: javax.xml.parsers.SAXParser

Reset this SAXParser to its original configuration.

SAXParser is reset to the same state as when it was created with SAXParserFactory.newSAXParser(). reset() is designed to allow the reuse of existing SAXParsers thus saving resources associated with the creation of new SAXParsers.

The reset SAXParser is not guaranteed to have the same Schema Object, e.g. Object.equals(Object obj). It is guaranteed to have a functionally equal Schema.

Overrides:
reset in class javax.xml.parsers.SAXParser

getElementPSVI

public org.apache.xerces.xs.ElementPSVI getElementPSVI()
Description copied from interface: org.apache.xerces.xs.PSVIProvider
Provides the post schema validation item for the current element information item. The method must be called by an application while in the scope of the methods which report the start and end of an element. For example, for SAX the method must be called within the scope of the document handler's startElement or endElement call. If the method is called outside of the specified scope, the return value is undefined.
Specified by:
getElementPSVI in interface org.apache.xerces.xs.PSVIProvider
Following copied from interface: org.apache.xerces.xs.PSVIProvider
Returns:
The post schema validation infoset for the current element. If an element information item is valid, then in the post-schema-validation infoset the following properties must be available for the element information item: The following properties are available in the scope of the method that reports the start of an element: {element declaration}, {validation context}, {notation}. The {schema information} property is available for the validation root. The {error codes} property is available if any errors occured during validation. The following properties are available in the scope of the method that reports the end of an element: {nil}, {schema specified}, {normalized value},{ member type definition}, {validity}, {validation attempted} . If the declaration has a value constraint, the property {schema default} is available. The {error codes} property is available if any errors occured during validation. Note: some processors may choose to provide all the PSVI properties in the scope of the method that reports the end of an element.

getAttributePSVI

public org.apache.xerces.xs.AttributePSVI getAttributePSVI(int index)
Description copied from interface: org.apache.xerces.xs.PSVIProvider
Provides AttributePSVI given the index of an attribute information item in the current element's attribute list. The method must be called by an application while in the scope of the methods which report the start and end of an element at a point where the attribute list is available. For example, for SAX the method must be called while in the scope of the document handler's startElement call. If the method is called outside of the specified scope, the return value is undefined.
Specified by:
getAttributePSVI in interface org.apache.xerces.xs.PSVIProvider
Following copied from interface: org.apache.xerces.xs.PSVIProvider
Parameters:
index - The attribute index.
Returns:
The post schema validation properties of the attribute.

getAttributePSVIByName

public org.apache.xerces.xs.AttributePSVI getAttributePSVIByName(java.lang.String uri,
                                                                 java.lang.String localname)
Description copied from interface: org.apache.xerces.xs.PSVIProvider
Provides AttributePSVI given the namespace name and the local name of an attribute information item in the current element's attribute list. The method must be called by an application while in the scope of the methods which report the start and end of an element at a point where the attribute list is available. For example, for SAX the method must be called while in the scope of the document handler's startElement call. If the method is called outside of the specified scope, the return value is undefined.
Specified by:
getAttributePSVIByName in interface org.apache.xerces.xs.PSVIProvider
Following copied from interface: org.apache.xerces.xs.PSVIProvider
Parameters:
uri - The namespace name of an attribute.
localname - The local name of an attribute.
Returns:
The post schema validation properties of the attribute.


Copyright 1999-2018 The Apache Software Foundation. All Rights Reserved.