Java Doc for SAXParserFactory.java in  » 6.0-JDK-Core » xml » javax » xml » parsers » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
Java Source Code / Java Documentation
1.6.0 JDK Core
2.6.0 JDK Modules
3.6.0 JDK Modules com.sun
4.6.0 JDK Modules com.sun.java
5.6.0 JDK Modules sun
6.6.0 JDK Platform
7.Ajax
8.Apache Harmony Java SE
9.Aspect oriented
10.Authentication Authorization
11.Blogger System
12.Build
13.Byte Code
14.Cache
15.Chart
16.Chat
17.Code Analyzer
18.Collaboration
19.Content Management System
20.Database Client
21.Database DBMS
22.Database JDBC Connection Pool
23.Database ORM
24.Development
25.EJB Server
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » xml » javax.xml.parsers 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   javax.xml.parsers.SAXParserFactory

SAXParserFactory
abstract public class SAXParserFactory (Code)
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 $



Constructor Summary
protected  SAXParserFactory()
    

Method Summary
abstract public  booleangetFeature(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.
public  SchemagetSchema()
     Gets the Schema object specified through the SAXParserFactory.setSchema(Schema schema) method.
public  booleanisNamespaceAware()
     Indicates whether or not the factory is configured to produce parsers which are namespace aware.
public  booleanisValidating()
     Indicates whether or not the factory is configured to produce parsers which validate the XML content during parse.
public  booleanisXIncludeAware()
    
public static  SAXParserFactorynewInstance()
     Obtain a new instance of a SAXParserFactory.
public static  SAXParserFactorynewInstance(String factoryClassName, 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 ....
 

Parameters:
  factoryClassName - fully qualified factory class name that provides implementation of javax.xml.parsers.SAXParserFactory.
Parameters:
  classLoader - ClassLoader used to load the factory class.
abstract public  SAXParsernewSAXParser()
    
abstract public  voidsetFeature(String name, boolean value)
    

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

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

public  voidsetValidating(boolean validating)
     Specifies that the parser produced by this code will validate documents as they are parsed.
public  voidsetXIncludeAware(boolean state)
    


Constructor Detail
SAXParserFactory
protected SAXParserFactory()(Code)

Protected constructor to force use of SAXParserFactory.newInstance() .





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

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. 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 Also:   org.xml.sax.XMLReader.getProperty



getSchema
public Schema getSchema()(Code)
Gets the Schema object specified through the SAXParserFactory.setSchema(Schema schema) method.
throws:
  UnsupportedOperationException - When implementation does notoverride this methodthe Schema object that was last set throughthe SAXParserFactory.setSchema(Schema) method, or nullif the method was not invoked since a SAXParserFactoryis created.
since:
   1.5



isNamespaceAware
public boolean isNamespaceAware()(Code)
Indicates whether or not the factory is configured to produce parsers which are namespace aware. true if the factory is configured to produceparsers which are namespace aware; false otherwise.



isValidating
public boolean isValidating()(Code)
Indicates whether or not the factory is configured to produce parsers which validate the XML content during parse. true if the factory is configured to produce parsers which validatethe XML content during parse; false otherwise.



isXIncludeAware
public boolean isXIncludeAware()(Code)

Get state of XInclude processing.

current state of XInclude processing
throws:
  UnsupportedOperationException - When implementation does notoverride this method
since:
   1.5



newInstance
public static SAXParserFactory newInstance()(Code)
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 DocumentBuilder s, try:

 java -Djaxp.debug=1 YourProgram ....
 
A new instance of a SAXParserFactory.
throws:
  FactoryConfigurationError - if the implementation isnot available or cannot be instantiated.



newInstance
public static SAXParserFactory newInstance(String factoryClassName, ClassLoader classLoader)(Code)

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

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



newSAXParser
abstract public SAXParser newSAXParser() throws ParserConfigurationException, SAXException(Code)

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

A new instance of a SAXParser.
throws:
  ParserConfigurationException - if a parser cannotbe created which satisfies the requested configuration.
throws:
  SAXException - for SAX errors.



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

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

Parameters:
  name - The name of the feature to be set.
Parameters:
  value - The value of the feature to be set.
throws:
  ParserConfigurationException - if a parser cannotbe created which satisfies the requested configuration.
throws:
  SAXNotRecognizedException - When the underlying XMLReader doesnot recognize the property name.
throws:
  SAXNotSupportedException - When the underlying XMLReaderrecognizes the property name but doesn't support theproperty.
throws:
  NullPointerException - If the name parameter is null.
See Also:   org.xml.sax.XMLReader.setFeature



setNamespaceAware
public void setNamespaceAware(boolean awareness)(Code)
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 willprovide support for XML namespaces; false otherwise.



setSchema
public void setSchema(Schema schema)(Code)

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.

Initialy, null is set as the Schema .

This processing will take effect even if the SAXParserFactory.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 implmentors

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.


Parameters:
  schema - Schema to use, null to remove a schema.
throws:
  UnsupportedOperationException - When implementation does notoverride this method
since:
   1.5



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


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



setXIncludeAware
public void setXIncludeAware(boolean state)(Code)

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 orfalse
throws:
  UnsupportedOperationException - When implementation does notoverride this method
since:
   1.5



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.