javax.xml.parsers
Class SAXParserFactory

java.lang.Object
  javax.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.

Constructor Summary
protected	SAXParserFactory ()           Protected constructor to force use of newInstance()

 

Method Summary
abstract  boolean	getFeature ( String           Returns the particular property requested for in the underlying implementation of org.xml.sax.XMLReader.
Schema	getSchema ()           Gets the Schema object specified through the setSchema(Schema schema)
SecureProcessing	getSecureProcessing ()           Get the SecureProcessing object specified through the setSecureProcessing(SecureProcessing)
boolean	isNamespaceAware ()           Indicates whether or not the factory is configured to produce parsers which are namespace aware.
boolean	isValidating ()           Indicates whether or not the factory is configured to produce parsers which validate the XML content during parse.
boolean	isXIncludeAware ()           Get state of XInclude processing.
static  SAXParserFactory	newInstance ()           Obtain a new instance of a SAXParserFactory.
abstract   SAXParser	newSAXParser ()           Creates a new instance of a SAXParser using the currently configured factory parameters.
abstract  void	setFeature ( String           Sets the particular feature in the underlying implementation of org.xml.sax.XMLReader.
void	setNamespaceAware (boolean awareness)           Specifies that the parser produced by this code will provide support for XML namespaces.
void	setSchema ( Schema           Set the Schema
void	setSecureProcessing ( SecureProcessing           Associate the SecureProcessing
void	setValidating (boolean validating)           Specifies that the parser produced by this code will validate documents as they are parsed.
void	setXIncludeAware (boolean state)           Set state of XInclude processing.

 

Methods inherited from class java.lang. Object
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait

 

Constructor Detail

SAXParserFactory

protected SAXParserFactory () 

Protected constructor to force use of newInstance() .

Method Detail

newInstance

public static 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.

Returns:

A new instance of a SAXParserFactory.

Throws:

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

newSAXParser

public abstract SAXParsernewSAXParser ()
 throws ParserConfigurationException,
 SAXException

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.

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.

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.

Parameters:

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

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.

setFeature

public abstract void setFeature ( String name,
 boolean value)
 throws ParserConfigurationException,
 SAXNotRecognizedException,
 SAXNotSupportedException

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/

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.

See Also:

XMLReader.setFeature(java.lang.String, boolean)

getFeature

public abstract boolean getFeature ( String name)
 throws ParserConfigurationException,
 SAXNotRecognizedException,
 SAXNotSupportedException

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.getProperty(java.lang.String)

getSchema

public SchemagetSchema () 

Gets the Schema object specified through the setSchema(Schema schema) method.

Returns:

the Schema object that was last set through the setSchema(Schema) method, or null if the method was not invoked since a 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

setSchema

public void setSchema ( Schema schema) 

Set the Schema to be used by parsers created from this factory.

When a 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 errors are found by the validator, the parser is responsible to report them to the user-specified ErrorHandler , just like any other errors found by the parser itself.

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

This processing will take effect even if the 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 Schema object. Such configuration will cause a ParserConfigurationException exception when the newSAXParser() is invoked.

Note for implmentors

A parser must be able to work with any Schema implementation.

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

setSecureProcessing

public void setSecureProcessing ( SecureProcessing secureProcessing) 

Associate the SecureProcessing configuration for this SAXParserFactory.

The field is initially set to null , meaning the parsers created by this factory will work in a way specified by the relevant specs.

Parameters:

secureProcessing - If a non-null object is specified, the parser will observe the settings of the specified SecureProcessing . Set null to remove the previously set SecureProcessing object from this SAXParserFactory .

Throws:

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

Since:

1.5

getSecureProcessing

public SecureProcessinggetSecureProcessing () 

Get the SecureProcessing object specified through the setSecureProcessing(SecureProcessing) method.

Returns:

the SecureProcessing object that was last set through the setSecureProcessing(SecureProcessing) method, or null if the method was not invoked since this 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

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

isXIncludeAware

public boolean isXIncludeAware () 

Get state of XInclude processing.

An implementation of the SAXParserFactory class is NOT guaranteed to be thread safe. It is up to the user application to make sure about the use of the SAXParserFactory from more than one thread. Alternatively the application can have one instance of the SAXParserFactory per thread. An application can use the same instance of the factory to obtain one or more instances of the SAXParser provided the instance of the factory isn't being used in more than one thread at a time.

The static newInstance method returns a new concrete implementation of this class.

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 JAXP 1.0

Constructor Summary
protected	SAXParserFactory ()

 

Method Summary
abstract  boolean	getFeature ( String           Returns the particular property requested for in the underlying implementation of org.xml.sax.XMLReader.
boolean	isNamespaceAware ()           Indicates whether or not the factory is configured to produce parsers which are namespace aware.
boolean	isValidating ()           Indicates whether or not the factory is configured to produce parsers which validate the XML content during parse.
static  SAXParserFactory	newInstance ()           Obtain a new instance of a SAXParserFactory.
abstract   SAXParser	newSAXParser ()           Creates a new instance of a SAXParser using the currently configured factory parameters.
abstract  void	setFeature ( String           Sets the particular feature in the underlying implementation of org.xml.sax.XMLReader.
void	setNamespaceAware (boolean awareness)           Specifies that the parser produced by this code will provide support for XML namespaces.
void	setValidating (boolean validating)           Specifies that the parser produced by this code will validate documents as they are parsed.

 

Methods inherited from class java.lang. Object
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait

 

Constructor Detail

SAXParserFactory

 
protected SAXParserFactory () 

Method Detail

newInstance

 
public static SAXParserFactorynewInstance ()
 throws FactoryConfigurationError

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

Returns:

A new instance of a SAXParserFactory.

Throws:

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

newSAXParser

 
public abstract SAXParsernewSAXParser ()
 throws ParserConfigurationException,
 SAXException

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

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.

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.

Parameters:

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

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.

setFeature

 
public abstract void setFeature ( String name,
 boolean value)
 throws ParserConfigurationException,
 SAXNotRecognizedException,
 SAXNotSupportedException

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.megginson.com/SAX/Java/features.html

Parameters:

name - The name of the feature to be set.

value - The value of the feature to be set.

Throws:

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.

ParserConfigurationException

See Also:

XMLReader.setFeature(java.lang.String, boolean)

getFeature

 
public abstract boolean getFeature ( String name)
 throws ParserConfigurationException,
 SAXNotRecognizedException,
 SAXNotSupportedException

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:

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.

ParserConfigurationException

See Also:

XMLReader.getProperty(java.lang.String)