javax.xml.parsers

Class 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.

Version: $Revision: 226183 $, $Date: 2005-04-08 06:39:14 -0400 (Fri, 08 Apr 2005) $

Author: Jeff Suttor

Constructor Summary
protected SAXParserFactory()

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

Method Summary
abstract booleangetFeature(String name)

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

SchemagetSchema()
Gets the {@link Schema} object specified through the {@link #setSchema(Schema schema)} method.
booleanisNamespaceAware()
Indicates whether or not the factory is configured to produce parsers which are namespace aware.
booleanisValidating()
Indicates whether or not the factory is configured to produce parsers which validate the XML content during parse.
booleanisXIncludeAware()

Get state of XInclude processing.

static SAXParserFactorynewInstance()
Obtain a new instance of a SAXParserFactory.
abstract SAXParsernewSAXParser()

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

abstract voidsetFeature(String name, boolean value)

Sets the particular feature in the underlying implementation of org.xml.sax.XMLReader.

voidsetNamespaceAware(boolean awareness)
Specifies that the parser produced by this code will provide support for XML namespaces.
voidsetSchema(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.

voidsetValidating(boolean validating)
Specifies that the parser produced by this code will validate documents as they are parsed.
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.

Constructor Detail

SAXParserFactory

protected SAXParserFactory()

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

Method Detail

getFeature

public abstract boolean getFeature(String name)

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

Parameters: name The name of the property to be retrieved.

Returns: Value of the requested property.

Throws: ParserConfigurationException if a parser cannot be created which satisfies the requested configuration. SAXNotRecognizedException When the underlying XMLReader does not recognize the property name. SAXNotSupportedException When the underlying XMLReader recognizes the property name but doesn't support the property.

See Also: XMLReader

getSchema

public Schema getSchema()
Gets the {@link Schema} object specified through the {@link #setSchema(Schema schema)} method.

Returns: 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.

Throws: UnsupportedOperationException For backward compatibility, when implementations for earlier versions of JAXP is used, this exception will be thrown.

Since: 1.5

isNamespaceAware

public boolean isNamespaceAware()
Indicates whether or not the factory is configured to produce parsers which are namespace aware.

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

isValidating

public boolean isValidating()
Indicates whether or not the factory is configured to produce parsers which validate the XML content during parse.

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

isXIncludeAware

public boolean isXIncludeAware()

Get state of XInclude processing.

Returns: current state of XInclude processing

Throws: UnsupportedOperationException For backward compatibility, when implementations for earlier versions of JAXP is used, this exception will be thrown.

Since: 1.5

newInstance

public static SAXParserFactory newInstance()
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: 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 ....
 

Returns: A new instance of a SAXParserFactory.

Throws: FactoryConfigurationError if the implementation is not available or cannot be instantiated.

newSAXParser

public abstract SAXParser newSAXParser()

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

Returns: A new instance of a SAXParser.

Throws: ParserConfigurationException if a parser cannot be created which satisfies the requested configuration. SAXException for SAX errors.

setFeature

public abstract void setFeature(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

Parameters: name The name of the feature to be set. value The value of the feature to be set.

Throws: ParserConfigurationException if a parser cannot be created which satisfies the requested configuration. SAXNotRecognizedException When the underlying XMLReader does not recognize the property name. SAXNotSupportedException When the underlying XMLReader recognizes the property name but doesn't support the property. NullPointerException If the name parameter is null.

See Also: XMLReader

setNamespaceAware

public void setNamespaceAware(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.

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

setSchema

public void setSchema(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.

Parameters: schema Schema to use, null to remove a schema.

Throws: UnsupportedOperationException For backward compatibility, when implementations for earlier versions of JAXP is used, this exception will be thrown.

Since: 1.5

setValidating

public void setValidating(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. See here for more details.)

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.

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

setXIncludeAware

public void setXIncludeAware(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.

Parameters: state Set XInclude processing to true or false

Throws: UnsupportedOperationException For backward compatibility, when implementations for earlier versions of JAXP is used, this exception will be thrown.

Since: 1.5