SchemaFactory (Java Platform SE 7 ) (original) (raw)

java.lang.Object
- javax.xml.validation.SchemaFactory

public abstract class SchemaFactory
extends Object
Factory that creates Schema objects. Entry-point to the validation API.
SchemaFactory is a schema compiler. It reads external representations of schemas and prepares them for validation.
The SchemaFactory class is not thread-safe. In other words, it is the application's responsibility to ensure that at most one thread is using a SchemaFactory object at any given moment. Implementations are encouraged to mark methods as synchronized to protect themselves from broken clients.
SchemaFactory is not re-entrant. While one of thenewSchema methods is being invoked, applications may not attempt to recursively invoke the newSchema method, even from the same thread.

Schema Language

This spec uses a namespace URI to designate a schema language. The following table shows the values defined by this specification.
To be compliant with the spec, the implementation is only required to support W3C XML Schema 1.0. However, if it chooses to support other schema languages listed here, it must conform to the relevant behaviors described in this spec.
Schema languages not listed here are expected to introduce their own URIs to represent themselves. The SchemaFactory class is capable of locating other implementations for other schema languages at run-time.
Note that because the XML DTD is strongly tied to the parsing process and has a significant effect on the parsing process, it is impossible to define the DTD validation as a process independent from parsing. For this reason, this specification does not define the semantics for the XML DTD. This doesn't prohibit implentors from implementing it in a way they see fit, but users are warned that any DTD validation implemented on this interface necessarily deviate from the XML DTD semantics as defined in the XML 1.0.

value	language
XMLConstants.W3C_XML_SCHEMA_NS_URI ("http://www.w3.org/2001/XMLSchema")	W3C XML Schema 1.0
XMLConstants.RELAXNG_NS_URI ("http://relaxng.org/ns/structure/1.0")	RELAX NG 1.0
Since:
1.5

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SchemaFactory() Constructor for derived classes.

Method Summary

Methods

Modifier and Type	Method and Description
abstract ErrorHandler	getErrorHandler() Gets the current ErrorHandler set to this SchemaFactory.
boolean	getFeature(String name) Look up the value of a feature flag.
Object	getProperty(String name) Look up the value of a property.
abstract LSResourceResolver	getResourceResolver() Gets the current LSResourceResolver set to this SchemaFactory.
abstract boolean	isSchemaLanguageSupported(String schemaLanguage) Is specified schema supported by this SchemaFactory?
static SchemaFactory	newInstance(String schemaLanguage) Lookup an implementation of the SchemaFactory that supports the specified schema language and return it.
static SchemaFactory	newInstance(String schemaLanguage,String factoryClassName,ClassLoader classLoader) Obtain a new instance of a SchemaFactory from class name.
abstract Schema	newSchema() Creates a special Schema object.
Schema	newSchema(File schema) Parses the specified File as a schema and returns it as a Schema.
Schema	newSchema(Source schema) Parses the specified source as a schema and returns it as a schema.
abstract Schema	newSchema(Source[] schemas) Parses the specified source(s) as a schema and returns it as a schema.
Schema	newSchema(URL schema) Parses the specified URL as a schema and returns it as a Schema.
abstract void	setErrorHandler(ErrorHandler errorHandler) Sets the ErrorHandler to receive errors encountered during the newSchema method invocation.
void	setFeature(String name, boolean value) Set a feature for this SchemaFactory,Schemas created by this factory, and by extension,Validators and ValidatorHandlers created by those Schemas.
void	setProperty(String name,Object object) Set the value of a property.
abstract void	setResourceResolver(LSResourceResolver resourceResolver) Sets the LSResourceResolver to customize resource resolution when parsing schemas.

   * ### Methods inherited from class java.lang.[Object](../../../java/lang/Object.html "class in java.lang")  
   `[clone](../../../java/lang/Object.html#clone%28%29), [equals](../../../java/lang/Object.html#equals%28java.lang.Object%29), [finalize](../../../java/lang/Object.html#finalize%28%29), [getClass](../../../java/lang/Object.html#getClass%28%29), [hashCode](../../../java/lang/Object.html#hashCode%28%29), [notify](../../../java/lang/Object.html#notify%28%29), [notifyAll](../../../java/lang/Object.html#notifyAll%28%29), [toString](../../../java/lang/Object.html#toString%28%29), [wait](../../../java/lang/Object.html#wait%28%29), [wait](../../../java/lang/Object.html#wait%28long%29), [wait](../../../java/lang/Object.html#wait%28long,%20int%29)`

Constructor Detail

 * #### SchemaFactory  
 protected SchemaFactory()

Method Detail

* #### newInstance  
public static final [SchemaFactory](../../../javax/xml/validation/SchemaFactory.html "class in javax.xml.validation") newInstance([String](../../../java/lang/String.html "class in java.lang") schemaLanguage)  
Lookup an implementation of the `SchemaFactory` that supports the specified schema language and return it.  
To find a `SchemaFactory` object for a given schema language, this method looks the following places in the following order where "the class loader" refers to the context class loader:  
         1. If the system property`"javax.xml.validation.SchemaFactory:_schemaLanguage_"` is present (where _schemaLanguage_ is the parameter to this method), then its value is read as a class name. The method will try to create a new instance of this class by using the class loader, and returns it if it is successfully created.  
         2. `$java.home/lib/jaxp.properties` is read and the value associated with the key being the system property above is looked for. If present, the value is processed just like above.  
         3. The class loader is asked for service provider provider-configuration files matching`javax.xml.validation.SchemaFactory` in the resource directory META-INF/services. See the JAR File Specification for file format and parsing rules. Each potential service provider is required to implement the method:  
                 [isSchemaLanguageSupported(String schemaLanguage)](../../../javax/xml/validation/SchemaFactory.html#isSchemaLanguageSupported%28java.lang.String%29)  
                      
          The first service provider found in class loader order that supports the specified schema language is returned.  
         4. Platform default `SchemaFactory` is located in a implementation specific way. There must be a platform default`SchemaFactory` for W3C XML Schema.  
If everything fails, [IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang") will be thrown.  
**Tip for Trouble-shooting:**  
See [Properties.load(java.io.InputStream)](../../../java/util/Properties.html#load%28java.io.InputStream%29) for exactly how a property file is parsed. In particular, colons ':' need to be escaped in a property file, so make sure schema language URIs are properly escaped in it. For example:  
 http\://www.w3.org/2001/XMLSchema=org.acme.foo.XSSchemaFactory  
       
Parameters:  
`schemaLanguage` \- Specifies the schema language which the returned SchemaFactory will understand. See[the list of available schema languages](#schemaLanguage) for the possible values.  
Returns:  
New instance of a `SchemaFactory`  
Throws:  
`[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- If no implementation of the schema language is available.  
`[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- If the `schemaLanguage` parameter is null.  
See Also:  
[newInstance(String schemaLanguage, String factoryClassName, ClassLoader classLoader)](../../../javax/xml/validation/SchemaFactory.html#newInstance%28java.lang.String,%20java.lang.String,%20java.lang.ClassLoader%29)  
* #### newInstance  
public static [SchemaFactory](../../../javax/xml/validation/SchemaFactory.html "class in javax.xml.validation") newInstance([String](../../../java/lang/String.html "class in java.lang") schemaLanguage,  
                        [String](../../../java/lang/String.html "class in java.lang") factoryClassName,  
                        [ClassLoader](../../../java/lang/ClassLoader.html "class in java.lang") classLoader)  
Obtain a new instance of a `SchemaFactory` from class name. `SchemaFactory` is returned if specified factory class name supports the specified schema language. 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.  
## 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:  
`schemaLanguage` \- Specifies the schema language which the returned`SchemaFactory` will understand. See[the list of available schema languages](#schemaLanguage) for the possible values.  
`factoryClassName` \- fully qualified factory class name that provides implementation of `javax.xml.validation.SchemaFactory`.  
`classLoader` \- `ClassLoader` used to load the factory class. If `null` current `Thread`'s context classLoader is used to load the factory class.  
Returns:  
New instance of a `SchemaFactory`  
Throws:  
`[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if `factoryClassName` is `null`, or the factory class cannot be loaded, instantiated or doesn't support the schema language specified in `schemLanguage` parameter.  
`[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- If the `schemaLanguage` parameter is null.  
Since:  
1.6  
See Also:  
[newInstance(String schemaLanguage)](../../../javax/xml/validation/SchemaFactory.html#newInstance%28java.lang.String%29)  
* #### isSchemaLanguageSupported  
public abstract boolean isSchemaLanguageSupported([String](../../../java/lang/String.html "class in java.lang") schemaLanguage)  
Is specified schema supported by this `SchemaFactory`?  
Parameters:  
`schemaLanguage` \- Specifies the schema language which the returned `SchemaFactory` will understand.`schemaLanguage` must specify a [valid](#schemaLanguage) schema language.  
Returns:  
`true` if `SchemaFactory` supports `schemaLanguage`, else `false`.  
Throws:  
`[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- If `schemaLanguage` is `null`.  
`[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- If `schemaLanguage.length() == 0` or `schemaLanguage` does not specify a [valid](#schemaLanguage) schema language.  
* #### getFeature  
public boolean getFeature([String](../../../java/lang/String.html "class in java.lang") name)  
                   throws [SAXNotRecognizedException](../../../org/xml/sax/SAXNotRecognizedException.html "class in org.xml.sax"),  
                          [SAXNotSupportedException](../../../org/xml/sax/SAXNotSupportedException.html "class in org.xml.sax")  
Look up the value of a feature flag.  
The feature name is any fully-qualified URI. It is possible for a [SchemaFactory](../../../javax/xml/validation/SchemaFactory.html "class in javax.xml.validation") to recognize a feature name but temporarily be unable to return its value.  
Implementors are free (and encouraged) to invent their own features, using names built on their own URIs.  
Parameters:  
`name` \- The feature name, which is a non-null fully-qualified URI.  
Returns:  
The current value of the feature (true or false).  
Throws:  
`[SAXNotRecognizedException](../../../org/xml/sax/SAXNotRecognizedException.html "class in org.xml.sax")` \- If the feature value can't be assigned or retrieved.  
`[SAXNotSupportedException](../../../org/xml/sax/SAXNotSupportedException.html "class in org.xml.sax")` \- When the[SchemaFactory](../../../javax/xml/validation/SchemaFactory.html "class in javax.xml.validation") recognizes the feature name but cannot determine its value at this time.  
`[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- If `name` is `null`.  
See Also:  
[setFeature(String, boolean)](../../../javax/xml/validation/SchemaFactory.html#setFeature%28java.lang.String,%20boolean%29)  
* #### setFeature  
public void setFeature([String](../../../java/lang/String.html "class in java.lang") name,  
              boolean value)  
                throws [SAXNotRecognizedException](../../../org/xml/sax/SAXNotRecognizedException.html "class in org.xml.sax"),  
                       [SAXNotSupportedException](../../../org/xml/sax/SAXNotSupportedException.html "class in org.xml.sax")  
Set a feature for this `SchemaFactory`,[Schema](../../../javax/xml/validation/Schema.html "class in javax.xml.validation")s created by this factory, and by extension,[Validator](../../../javax/xml/validation/Validator.html "class in javax.xml.validation")s and [ValidatorHandler](../../../javax/xml/validation/ValidatorHandler.html "class in javax.xml.validation")s created by those [Schema](../../../javax/xml/validation/Schema.html "class in javax.xml.validation")s.  
Implementors and developers should pay particular attention to how the special [Schema](../../../javax/xml/validation/Schema.html "class in javax.xml.validation") object returned by [newSchema()](../../../javax/xml/validation/SchemaFactory.html#newSchema%28%29) is processed. In some cases, for example, when the`SchemaFactory` and the class actually loading the schema come from different implementations, it may not be possible for `SchemaFactory` features to be inherited automatically. Developers should make sure that features, such as secure processing, are explicitly set in both places.  
The feature name is any fully-qualified URI. It is possible for a [SchemaFactory](../../../javax/xml/validation/SchemaFactory.html "class in javax.xml.validation") to expose a feature value but to be unable to change the current value.  
All implementations are required to support the [XMLConstants.FEATURE\_SECURE\_PROCESSING](../../../javax/xml/XMLConstants.html#FEATURE%5FSECURE%5FPROCESSING) 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[ErrorHandler.fatalError(SAXParseException exception)](../../../org/xml/sax/ErrorHandler.html#fatalError%28org.xml.sax.SAXParseException%29). See [setErrorHandler(ErrorHandler errorHandler)](../../../javax/xml/validation/SchemaFactory.html#setErrorHandler%28org.xml.sax.ErrorHandler%29).  
         * `false`: the implementation will processing XML according to the XML specifications without regard to possible implementation limits.  
Parameters:  
`name` \- The feature name, which is a non-null fully-qualified URI.  
`value` \- The requested value of the feature (true or false).  
Throws:  
`[SAXNotRecognizedException](../../../org/xml/sax/SAXNotRecognizedException.html "class in org.xml.sax")` \- If the feature value can't be assigned or retrieved.  
`[SAXNotSupportedException](../../../org/xml/sax/SAXNotSupportedException.html "class in org.xml.sax")` \- When the[SchemaFactory](../../../javax/xml/validation/SchemaFactory.html "class in javax.xml.validation") recognizes the feature name but cannot set the requested value.  
`[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- If `name` is `null`.  
See Also:  
[getFeature(String)](../../../javax/xml/validation/SchemaFactory.html#getFeature%28java.lang.String%29)  
* #### setProperty  
public void setProperty([String](../../../java/lang/String.html "class in java.lang") name,  
               [Object](../../../java/lang/Object.html "class in java.lang") object)  
                 throws [SAXNotRecognizedException](../../../org/xml/sax/SAXNotRecognizedException.html "class in org.xml.sax"),  
                        [SAXNotSupportedException](../../../org/xml/sax/SAXNotSupportedException.html "class in org.xml.sax")  
Parameters:  
`name` \- The property name, which is a non-null fully-qualified URI.  
`object` \- The requested value for the property.  
Throws:  
`[SAXNotRecognizedException](../../../org/xml/sax/SAXNotRecognizedException.html "class in org.xml.sax")` \- If the property value can't be assigned or retrieved.  
`[SAXNotSupportedException](../../../org/xml/sax/SAXNotSupportedException.html "class in org.xml.sax")` \- When the[SchemaFactory](../../../javax/xml/validation/SchemaFactory.html "class in javax.xml.validation") recognizes the property name but cannot set the requested value.  
`[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- If `name` is `null`.  
* #### getProperty  
public [Object](../../../java/lang/Object.html "class in java.lang") getProperty([String](../../../java/lang/String.html "class in java.lang") name)  
                   throws [SAXNotRecognizedException](../../../org/xml/sax/SAXNotRecognizedException.html "class in org.xml.sax"),  
                          [SAXNotSupportedException](../../../org/xml/sax/SAXNotSupportedException.html "class in org.xml.sax")  
Look up the value of a property.  
The property name is any fully-qualified URI. It is possible for a [SchemaFactory](../../../javax/xml/validation/SchemaFactory.html "class in javax.xml.validation") to recognize a property name but temporarily be unable to return its value.  
[SchemaFactory](../../../javax/xml/validation/SchemaFactory.html "class in javax.xml.validation")s are not required to recognize any specific property names.  
Implementors are free (and encouraged) to invent their own properties, using names built on their own URIs.  
Parameters:  
`name` \- The property name, which is a non-null fully-qualified URI.  
Returns:  
The current value of the property.  
Throws:  
`[SAXNotRecognizedException](../../../org/xml/sax/SAXNotRecognizedException.html "class in org.xml.sax")` \- If the property value can't be assigned or retrieved.  
`[SAXNotSupportedException](../../../org/xml/sax/SAXNotSupportedException.html "class in org.xml.sax")` \- When the XMLReader recognizes the property name but cannot determine its value at this time.  
`[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- If `name` is `null`.  
See Also:  
[setProperty(String, Object)](../../../javax/xml/validation/SchemaFactory.html#setProperty%28java.lang.String,%20java.lang.Object%29)  
* #### setErrorHandler  
public abstract void setErrorHandler([ErrorHandler](../../../org/xml/sax/ErrorHandler.html "interface in org.xml.sax") errorHandler)  
Parameters:  
`errorHandler` \- A new error handler to be set. This parameter can be `null`.  
* #### getErrorHandler  
public abstract [ErrorHandler](../../../org/xml/sax/ErrorHandler.html "interface in org.xml.sax") getErrorHandler()  
Returns:  
This method returns the object that was last set through the [setErrorHandler(ErrorHandler)](../../../javax/xml/validation/SchemaFactory.html#setErrorHandler%28org.xml.sax.ErrorHandler%29) method, or null if that method has never been called since this [SchemaFactory](../../../javax/xml/validation/SchemaFactory.html "class in javax.xml.validation") has created.  
See Also:  
[setErrorHandler(ErrorHandler)](../../../javax/xml/validation/SchemaFactory.html#setErrorHandler%28org.xml.sax.ErrorHandler%29)  
* #### setResourceResolver  
public abstract void setResourceResolver([LSResourceResolver](../../../org/w3c/dom/ls/LSResourceResolver.html "interface in org.w3c.dom.ls") resourceResolver)  
Sets the [LSResourceResolver](../../../org/w3c/dom/ls/LSResourceResolver.html "interface in org.w3c.dom.ls") to customize resource resolution when parsing schemas.  
[SchemaFactory](../../../javax/xml/validation/SchemaFactory.html "class in javax.xml.validation") uses a [LSResourceResolver](../../../org/w3c/dom/ls/LSResourceResolver.html "interface in org.w3c.dom.ls") when it needs to locate external resources while parsing schemas, although exactly what constitutes "locating external resources" is up to each schema language. For example, for W3C XML Schema, this includes files `<include>`d or `<import>`ed, and DTD referenced from schema files, etc.  
 Applications can call this method even during a [Schema](../../../javax/xml/validation/Schema.html "class in javax.xml.validation") is being parsed.  
 When the [LSResourceResolver](../../../org/w3c/dom/ls/LSResourceResolver.html "interface in org.w3c.dom.ls") is null, the implementation will behave as if the following [LSResourceResolver](../../../org/w3c/dom/ls/LSResourceResolver.html "interface in org.w3c.dom.ls") is set:  
 class DumbDOMResourceResolver implements [LSResourceResolver](../../../org/w3c/dom/ls/LSResourceResolver.html "interface in org.w3c.dom.ls") {  
     public [LSInput](../../../org/w3c/dom/ls/LSInput.html "interface in org.w3c.dom.ls") resolveResource(  
         String publicId, String systemId, String baseURI) {  
         return null; // always return null  
     }  
 }  
       
 If a [LSResourceResolver](../../../org/w3c/dom/ls/LSResourceResolver.html "interface in org.w3c.dom.ls") throws a [RuntimeException](../../../java/lang/RuntimeException.html "class in java.lang") (or instances of its derived classes), then the [SchemaFactory](../../../javax/xml/validation/SchemaFactory.html "class in javax.xml.validation") will abort the parsing and the caller of the `newSchema` method will receive the same [RuntimeException](../../../java/lang/RuntimeException.html "class in java.lang").  
 When a new [SchemaFactory](../../../javax/xml/validation/SchemaFactory.html "class in javax.xml.validation") object is created, initially this field is set to null. This field will _NOT_ be inherited to [Schema](../../../javax/xml/validation/Schema.html "class in javax.xml.validation")s, [Validator](../../../javax/xml/validation/Validator.html "class in javax.xml.validation")s, or[ValidatorHandler](../../../javax/xml/validation/ValidatorHandler.html "class in javax.xml.validation")s that are created from this [SchemaFactory](../../../javax/xml/validation/SchemaFactory.html "class in javax.xml.validation").  
Parameters:  
`resourceResolver` \- A new resource resolver to be set. This parameter can be null.  
* #### getResourceResolver  
public abstract [LSResourceResolver](../../../org/w3c/dom/ls/LSResourceResolver.html "interface in org.w3c.dom.ls") getResourceResolver()  
Returns:  
This method returns the object that was last set through the [setResourceResolver(LSResourceResolver)](../../../javax/xml/validation/SchemaFactory.html#setResourceResolver%28org.w3c.dom.ls.LSResourceResolver%29) method, or null if that method has never been called since this [SchemaFactory](../../../javax/xml/validation/SchemaFactory.html "class in javax.xml.validation") has created.  
See Also:  
[setErrorHandler(ErrorHandler)](../../../javax/xml/validation/SchemaFactory.html#setErrorHandler%28org.xml.sax.ErrorHandler%29)  
* #### newSchema  
public [Schema](../../../javax/xml/validation/Schema.html "class in javax.xml.validation") newSchema([Source](../../../javax/xml/transform/Source.html "interface in javax.xml.transform") schema)  
                 throws [SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")  
Parameters:  
`schema` \- Source that represents a schema.  
Returns:  
New `Schema` from parsing `schema`.  
Throws:  
`[SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")` \- If a SAX error occurs during parsing.  
`[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- if `schema` is null.  
* #### newSchema  
public [Schema](../../../javax/xml/validation/Schema.html "class in javax.xml.validation") newSchema([File](../../../java/io/File.html "class in java.io") schema)  
                 throws [SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")  
Parses the specified `File` as a schema and returns it as a `Schema`.  
This is a convenience method for [newSchema(Source schema)](../../../javax/xml/validation/SchemaFactory.html#newSchema%28javax.xml.transform.Source%29).  
Parameters:  
`schema` \- File that represents a schema.  
Returns:  
New `Schema` from parsing `schema`.  
Throws:  
`[SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")` \- If a SAX error occurs during parsing.  
`[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- if `schema` is null.  
* #### newSchema  
public [Schema](../../../javax/xml/validation/Schema.html "class in javax.xml.validation") newSchema([URL](../../../java/net/URL.html "class in java.net") schema)  
                 throws [SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")  
Parses the specified `URL` as a schema and returns it as a `Schema`.  
This is a convenience method for [newSchema(Source schema)](../../../javax/xml/validation/SchemaFactory.html#newSchema%28javax.xml.transform.Source%29).  
Parameters:  
`schema` \- `URL` that represents a schema.  
Returns:  
New `Schema` from parsing `schema`.  
Throws:  
`[SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")` \- If a SAX error occurs during parsing.  
`[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- if `schema` is null.  
* #### newSchema  
public abstract [Schema](../../../javax/xml/validation/Schema.html "class in javax.xml.validation") newSchema([Source](../../../javax/xml/transform/Source.html "interface in javax.xml.transform")[] schemas)  
                          throws [SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")  
Parses the specified source(s) as a schema and returns it as a schema.  
 The callee will read all the [Source](../../../javax/xml/transform/Source.html "interface in javax.xml.transform")s and combine them into a single schema. The exact semantics of the combination depends on the schema language that this [SchemaFactory](../../../javax/xml/validation/SchemaFactory.html "class in javax.xml.validation") object is created for.  
 When an [ErrorHandler](../../../org/xml/sax/ErrorHandler.html "interface in org.xml.sax") is set, the callee will report all the errors found in sources to the handler. If the handler throws an exception, it will abort the schema compilation and the same exception will be thrown from this method. Also, after an error is reported to a handler, the callee is allowed to abort the further processing by throwing it. If an error handler is not set, the callee will throw the first error it finds in the sources.  
## W3C XML Schema 1.0  
 The resulting schema contains components from the specified sources. The same result would be achieved if all these sources were imported, using appropriate values for schemaLocation and namespace, into a single schema document with a different targetNamespace and no components of its own, if the import elements were given in the same order as the sources. Section 4.2.3 of the XML Schema recommendation describes the options processors have in this regard. While a processor should be consistent in its treatment of JAXP schema sources and XML Schema imports, the behaviour between JAXP-compliant parsers may vary; in particular, parsers may choose to ignore all but the first <import> for a given namespace, regardless of information provided in schemaLocation.  
 If the parsed set of schemas includes error(s) as specified in the section 5.1 of the XML Schema spec, then the error must be reported to the [ErrorHandler](../../../org/xml/sax/ErrorHandler.html "interface in org.xml.sax").  
## RELAX NG  
For RELAX NG, this method must throw [UnsupportedOperationException](../../../java/lang/UnsupportedOperationException.html "class in java.lang") if `schemas.length!=1`.  
Parameters:  
`schemas` \- inputs to be parsed. [SchemaFactory](../../../javax/xml/validation/SchemaFactory.html "class in javax.xml.validation") is required to recognize [SAXSource](../../../javax/xml/transform/sax/SAXSource.html "class in javax.xml.transform.sax"),[StreamSource](../../../javax/xml/transform/stream/StreamSource.html "class in javax.xml.transform.stream"),[StAXSource](../../../javax/xml/transform/stax/StAXSource.html "class in javax.xml.transform.stax"), and [DOMSource](../../../javax/xml/transform/dom/DOMSource.html "class in javax.xml.transform.dom"). Input schemas must be XML documents or XML elements and must not be null. For backwards compatibility, the results of passing anything other than a document or element are implementation-dependent. Implementations must either recognize and process the input or thrown an IllegalArgumentException.  
Returns:  
Always return a non-null valid [Schema](../../../javax/xml/validation/Schema.html "class in javax.xml.validation") object. Note that when an error has been reported, there is no guarantee that the returned [Schema](../../../javax/xml/validation/Schema.html "class in javax.xml.validation") object is meaningful.  
Throws:  
`[SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")` \- If an error is found during processing the specified inputs. When an [ErrorHandler](../../../org/xml/sax/ErrorHandler.html "interface in org.xml.sax") is set, errors are reported to there first. See [setErrorHandler(ErrorHandler)](../../../javax/xml/validation/SchemaFactory.html#setErrorHandler%28org.xml.sax.ErrorHandler%29).  
`[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- If the `schemas` parameter itself is null or any item in the array is null.  
`[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- If any item in the array is not recognized by this method.  
`[UnsupportedOperationException](../../../java/lang/UnsupportedOperationException.html "class in java.lang")` \- If the schema language doesn't support this operation.  
* #### newSchema  
public abstract [Schema](../../../javax/xml/validation/Schema.html "class in javax.xml.validation") newSchema()  
                          throws [SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")  
Creates a special [Schema](../../../javax/xml/validation/Schema.html "class in javax.xml.validation") object.  
The exact semantics of the returned [Schema](../../../javax/xml/validation/Schema.html "class in javax.xml.validation") object depend on the schema language for which this [SchemaFactory](../../../javax/xml/validation/SchemaFactory.html "class in javax.xml.validation") is created.  
Also, implementations are allowed to use implementation-specific property/feature to alter the semantics of this method.  
Implementors and developers should pay particular attention to how the features set on this [SchemaFactory](../../../javax/xml/validation/SchemaFactory.html "class in javax.xml.validation") are processed by this special [Schema](../../../javax/xml/validation/Schema.html "class in javax.xml.validation"). In some cases, for example, when the[SchemaFactory](../../../javax/xml/validation/SchemaFactory.html "class in javax.xml.validation") and the class actually loading the schema come from different implementations, it may not be possible for [SchemaFactory](../../../javax/xml/validation/SchemaFactory.html "class in javax.xml.validation") features to be inherited automatically. Developers should make sure that features, such as secure processing, are explicitly set in both places.  
## W3C XML Schema 1.0  
 For XML Schema, this method creates a [Schema](../../../javax/xml/validation/Schema.html "class in javax.xml.validation") object that performs validation by using location hints specified in documents.  
 The returned [Schema](../../../javax/xml/validation/Schema.html "class in javax.xml.validation") object assumes that if documents refer to the same URL in the schema location hints, they will always resolve to the same schema document. This asusmption allows implementations to reuse parsed results of schema documents so that multiple validations against the same schema will run faster.  
 Note that the use of schema location hints introduces a vulnerability to denial-of-service attacks.  
## RELAX NG  
 RELAX NG does not support this operation.  
Returns:  
Always return non-null valid [Schema](../../../javax/xml/validation/Schema.html "class in javax.xml.validation") object.  
Throws:  
`[UnsupportedOperationException](../../../java/lang/UnsupportedOperationException.html "class in java.lang")` \- If this operation is not supported by the callee.  
`[SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")` \- If this operation is supported but failed for some reason.

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2020, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

SchemaFactory (Java Platform SE 7 ) (original) (raw)

Schema Language

Constructor Summary

Method Summary

Constructor Detail

Method Detail