Home » xml-commons-external-1.4.01-src » javax » xml » parsers » [javadoc | source]
javax.xml.parsers
abstract public class: SAXParserFactory [javadoc | source]
java.lang.Object
   javax.xml.parsers.SAXParserFactory
Defines a factory API that enables applications to configure and obtain a SAX based parser to parse XML documents.
Constructor:
 protected SAXParserFactory() 
Method from javax.xml.parsers.SAXParserFactory Summary:
getFeature,   getSchema,   isNamespaceAware,   isValidating,   isXIncludeAware,   newInstance,   newInstance,   newSAXParser,   setFeature,   setNamespaceAware,   setSchema,   setValidating,   setXIncludeAware
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.xml.parsers.SAXParserFactory Detail:
 abstract public boolean getFeature(String name) throws ParserConfigurationException, SAXNotRecognizedException, SAXNotSupportedException

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

 public Schema getSchema() 
 public boolean isNamespaceAware() 
    Indicates whether or not the factory is configured to produce parsers which are namespace aware.
 public boolean isValidating() 
    Indicates whether or not the factory is configured to produce parsers which validate the XML content during parse.
 public boolean isXIncludeAware() 

    Get state of XInclude processing.

 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:
    • 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 SAXParser s, try:

    java -Djaxp.debug=1 YourProgram ....
    
 public static SAXParserFactory newInstance(String factoryClassName,
    ClassLoader classLoader) 
 abstract public SAXParser newSAXParser() throws ParserConfigurationException, SAXException

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

 abstract public  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/

    All implementations are required to support the 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 entity 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 org.xml.sax.ErrorHandler#fatalError(SAXParseException exception) . See 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.
 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.
 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 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 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.

    Initially, 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 SAXException exception when those properties are set on a SAXParser .

    Note for implementors

    A parser must be able to work with any 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.

 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 #setValidating(boolean) method false, then use the #setSchema(Schema) method to associate a schema to a parser.

 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.