FileDocCategorySizeDatePackage
SAXParserFactory.javaAPI DocJava SE 6 API18226Tue Jun 10 00:27:08 BST 2008javax.xml.parsers

SAXParserFactory

public abstract class SAXParserFactory extends Object
Defines a factory API that enables applications to configure and obtain a SAX based parser to parse XML documents.
author
Jeff Suttor
author
Neeraj Bajaj
version
$Revision: 1.5 $, $Date: 2006/04/24 13:41:47 $

Fields Summary
private static final String
DEFAULT_PROPERTY_NAME
The default property name according to the JAXP spec
private boolean
validating

Should Parsers be validating?

private boolean
namespaceAware

Should Parsers be namespace aware?

Constructors Summary
protected SAXParserFactory()

Protected constructor to force use of {@link #newInstance()}.

    
                 
       
    
    
Methods Summary
public abstract booleangetFeature(java.lang.String name)

Returns the particular property requested for in the underlying implementation of org.xml.sax.XMLReader.

param
name The name of the property to be retrieved.
return
Value of the requested property.
throws
ParserConfigurationException if a parser cannot be created which satisfies the requested configuration.
throws
SAXNotRecognizedException When the underlying XMLReader does not recognize the property name.
throws
SAXNotSupportedException When the underlying XMLReader recognizes the property name but doesn't support the property.
see
org.xml.sax.XMLReader#getProperty

public javax.xml.validation.SchemagetSchema()
Gets the {@link Schema} object specified through the {@link #setSchema(Schema schema)} method.

throws
UnsupportedOperationException When implementation does not override this method
return
the {@link Schema} object that was last set through the {@link #setSchema(Schema)} method, or null if the method was not invoked since a {@link SAXParserFactory} is created.
since
1.5

        throw new UnsupportedOperationException(
            "This parser does not support specification \""
            + this.getClass().getPackage().getSpecificationTitle()
            + "\" version \""
            + this.getClass().getPackage().getSpecificationVersion()
            + "\""
            );
    
public booleanisNamespaceAware()
Indicates whether or not the factory is configured to produce parsers which are namespace aware.

return
true if the factory is configured to produce parsers which are namespace aware; false otherwise.

        return namespaceAware;
    
public booleanisValidating()
Indicates whether or not the factory is configured to produce parsers which validate the XML content during parse.

return
true if the factory is configured to produce parsers which validate the XML content during parse; false otherwise.

        return validating;
    
public booleanisXIncludeAware()

Get state of XInclude processing.

return
current state of XInclude processing
throws
UnsupportedOperationException When implementation does not override this method
since
1.5

        throw new UnsupportedOperationException(
            "This parser does not support specification \""
            + this.getClass().getPackage().getSpecificationTitle()
            + "\" version \""
            + this.getClass().getPackage().getSpecificationVersion()
            + "\""
            );
    
public static javax.xml.parsers.SAXParserFactorynewInstance()
Obtain a new instance of a SAXParserFactory. This static method creates a new factory instance This method uses the following ordered lookup procedure to determine the SAXParserFactory implementation class to load:
  • Use the javax.xml.parsers.SAXParserFactory system property.
  • Use the properties file "lib/jaxp.properties" in the JRE directory. This configuration file is in standard java.util.Properties format and contains the fully qualified name of the implementation class with the key being the system property defined above. The jaxp.properties file is read only once by the JAXP implementation and it's values are then cached for future use. If the file does not exist when the first attempt is made to read from it, no further attempts are made to check for its existence. It is not possible to change the value of any property in jaxp.properties after it has been read for the first time.
  • Use the Services API (as detailed in the JAR specification), if available, to determine the classname. The Services API will look for a classname in the file META-INF/services/javax.xml.parsers.SAXParserFactory in jars available to the runtime.
  • Platform default SAXParserFactory instance.
Once an application has obtained a reference to a SAXParserFactory it can use the factory to configure and obtain parser instances.

Tip for Trouble-shooting

Setting the jaxp.debug system property will cause this method to print a lot of debug messages to System.err about what it is doing and where it is looking at.

If you have problems loading {@link DocumentBuilder}s, try:

java -Djaxp.debug=1 YourProgram ....

return
A new instance of a SAXParserFactory.
throws
FactoryConfigurationError if the implementation is not available or cannot be instantiated.

        try {
            return (SAXParserFactory) FactoryFinder.find(
                /* The default property name according to the JAXP spec */
                "javax.xml.parsers.SAXParserFactory",
                /* The fallback implementation class name */
                "com.sun.org.apache.xerces.internal.jaxp.SAXParserFactoryImpl");
        } catch (FactoryFinder.ConfigurationError e) {
            throw new FactoryConfigurationError(e.getException(),
                                                e.getMessage());
        }
    
public static javax.xml.parsers.SAXParserFactorynewInstance(java.lang.String factoryClassName, java.lang.ClassLoader classLoader)

Obtain a new instance of a SAXParserFactory from class name. This function is useful when there are multiple providers in the classpath. It gives more control to the application as it can specify which provider should be loaded.

Once an application has obtained a reference to a SAXParserFactory it can use the factory to configure and obtain parser instances.

Tip for Trouble-shooting

Setting the jaxp.debug system property will cause this method to print a lot of debug messages to System.err about what it is doing and where it is looking at.

If you have problems, try:

java -Djaxp.debug=1 YourProgram ....

param
factoryClassName fully qualified factory class name that provides implementation of javax.xml.parsers.SAXParserFactory.
param
classLoader ClassLoader used to load the factory class. If null current Thread's context classLoader is used to load the factory class.
return
New instance of a SAXParserFactory
throws
FactoryConfigurationError if factoryClassName is null, or the factory class cannot be loaded, instantiated.
see
#newInstance()
since
1.6

        try {
            //do not fallback if given classloader can't find the class, throw exception
            return (SAXParserFactory) FactoryFinder.newInstance(factoryClassName, classLoader, false);
        } catch (FactoryFinder.ConfigurationError e) {
            throw new FactoryConfigurationError(e.getException(),
                                                e.getMessage());
        }        
    
public abstract javax.xml.parsers.SAXParsernewSAXParser()

Creates a new instance of a SAXParser using the currently configured factory parameters.

return
A new instance of a SAXParser.
throws
ParserConfigurationException if a parser cannot be created which satisfies the requested configuration.
throws
SAXException for SAX errors.

public abstract voidsetFeature(java.lang.String name, boolean value)

Sets the particular feature in the underlying implementation of org.xml.sax.XMLReader. A list of the core features and properties can be found at http://www.saxproject.org/

All implementations are required to support the {@link javax.xml.XMLConstants#FEATURE_SECURE_PROCESSING} feature. When the feature is

  • true: the implementation will limit XML processing to conform to implementation limits. Examples include enity expansion limits and XML Schema constructs that would consume large amounts of resources. If XML processing is limited for security reasons, it will be reported via a call to the registered {@link org.xml.sax.ErrorHandler#fatalError(SAXParseException exception)}. See {@link SAXParser} parse methods for handler specification.
  • When the feature is false, the implementation will processing XML according to the XML specifications without regard to possible implementation limits.

param
name The name of the feature to be set.
param
value The value of the feature to be set.
throws
ParserConfigurationException if a parser cannot be created which satisfies the requested configuration.
throws
SAXNotRecognizedException When the underlying XMLReader does not recognize the property name.
throws
SAXNotSupportedException When the underlying XMLReader recognizes the property name but doesn't support the property.
throws
NullPointerException If the name parameter is null.
see
org.xml.sax.XMLReader#setFeature

public voidsetNamespaceAware(boolean awareness)
Specifies that the parser produced by this code will provide support for XML namespaces. By default the value of this is set to false.

param
awareness true if the parser produced by this code will provide support for XML namespaces; false otherwise.

        this.namespaceAware = awareness;
    
public voidsetSchema(javax.xml.validation.Schema schema)

Set the {@link Schema} to be used by parsers created from this factory.

When a {@link Schema} is non-null, a parser will use a validator created from it to validate documents before it passes information down to the application.

When warnings/errors/fatal errors are found by the validator, the parser must handle them as if those errors were found by the parser itself. In other words, if the user-specified {@link org.xml.sax.ErrorHandler} is set, it must receive those errors, and if not, they must be treated according to the implementation specific default error handling rules.

A validator may modify the SAX event stream (for example by adding default values that were missing in documents), and a parser is responsible to make sure that the application will receive those modified event stream.

Initialy, null is set as the {@link Schema}.

This processing will take effect even if the {@link #isValidating()} method returns false.

It is an error to use the http://java.sun.com/xml/jaxp/properties/schemaSource property and/or the http://java.sun.com/xml/jaxp/properties/schemaLanguage property in conjunction with a non-null {@link Schema} object. Such configuration will cause a {@link SAXException} exception when those properties are set on a {@link SAXParser}.

Note for implmentors

A parser must be able to work with any {@link Schema} implementation. However, parsers and schemas are allowed to use implementation-specific custom mechanisms as long as they yield the result described in the specification.

param
schema Schema to use, null to remove a schema.
throws
UnsupportedOperationException When implementation does not override this method
since
1.5

        throw new UnsupportedOperationException(
            "This parser does not support specification \""
            + this.getClass().getPackage().getSpecificationTitle()
            + "\" version \""
            + this.getClass().getPackage().getSpecificationVersion()
            + "\""
            );
    
public voidsetValidating(boolean validating)
Specifies that the parser produced by this code will validate documents as they are parsed. By default the value of this is set to false.

Note that "the validation" here means a validating parser as defined in the XML recommendation. In other words, it essentially just controls the DTD validation. (except the legacy two properties defined in JAXP 1.2.)

To use modern schema languages such as W3C XML Schema or RELAX NG instead of DTD, you can configure your parser to be a non-validating parser by leaving the {@link #setValidating(boolean)} method false, then use the {@link #setSchema(Schema)} method to associate a schema to a parser.

param
validating true if the parser produced by this code will validate documents as they are parsed; false otherwise.

        this.validating = validating;
    
public voidsetXIncludeAware(boolean state)

Set state of XInclude processing.

If XInclude markup is found in the document instance, should it be processed as specified in XML Inclusions (XInclude) Version 1.0.

XInclude processing defaults to false.

param
state Set XInclude processing to true or false
throws
UnsupportedOperationException When implementation does not override this method
since
1.5

        throw new UnsupportedOperationException(
            "This parser does not support specification \""
            + this.getClass().getPackage().getSpecificationTitle()
            + "\" version \""
            + this.getClass().getPackage().getSpecificationVersion()
            + "\""
            );