org.apache.xerces.impl.xs

Class XMLSchemaLoader

java.lang.Object

org.apache.xerces.impl.xs.XMLSchemaLoader

All Implemented Interfaces:

XSElementDeclHelper, XMLGrammarLoader, XMLComponent, XSLoader, DOMConfiguration

public class XMLSchemaLoader
extends Object
implements XMLGrammarLoader, XMLComponent, XSElementDeclHelper, XSLoader, DOMConfiguration

This class implements xni.grammars.XMLGrammarLoader. It also serves as implementation of xs.XSLoader interface and DOMConfiguration interface. This class is designed to interact either with a proxy for a user application which wants to preparse schemas, or with our own Schema validator. It is hoped that none of these "external" classes will therefore need to communicate directly with XSDHandler in future.

This class only knows how to make XSDHandler do its thing. The caller must ensure that all its properties (schemaLocation, JAXPSchemaSource etc.) have been properly set.

Version:

$Id$

Author:

Neil Graham, IBM

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ALLOW_JAVA_ENCODINGS Feature identifier: allow java encodings to be recognized when parsing schema docs.
protected static String	AUGMENT_PSVI
protected static String	CONTINUE_AFTER_FATAL_ERROR Feature identifier: continue after fatal error.
protected static String	DISALLOW_DOCTYPE Feature: disallow doctype
protected static String	ENTITY_MANAGER
static String	ENTITY_RESOLVER Property identifier: entity resolver.
protected static String	ERROR_HANDLER Property identifier: error handler.
static String	ERROR_REPORTER Property identifier: error reporter.
protected static String	GENERATE_SYNTHETIC_ANNOTATIONS Feature: generate synthetic annotations
protected static String	HONOUR_ALL_SCHEMALOCATIONS Feature identifier: honour all schemaLocations
protected static String	JAXP_SCHEMA_SOURCE Property identifier: JAXP schema source.
protected static String	LOCALE Property identifier: locale.
protected static String	NAMESPACE_GROWTH Feature identifier: namespace growth
protected static String	PARSER_SETTINGS
protected static String	SCHEMA_DV_FACTORY Property identifier: Schema DV Factory
protected static String	SCHEMA_FULL_CHECKING Feature identifier: schema full checking
protected static String	SCHEMA_LOCATION Property identifier: schema location.
protected static String	SCHEMA_NONS_LOCATION Property identifier: no namespace schema location.
protected static String	SECURITY_MANAGER
protected static String	STANDARD_URI_CONFORMANT_FEATURE Feature identifier: standard uri conformant feature.
static String	SYMBOL_TABLE Property identifier: symbol table.
protected static String	TOLERATE_DUPLICATES Feature identifier: tolerate duplicates
protected static String	VALIDATE_ANNOTATIONS Feature identifier: validate annotations.
static String	XMLGRAMMAR_POOL Property identifier: grammar pool.

Constructor Summary

Constructors

Constructor and Description
XMLSchemaLoader()
XMLSchemaLoader(SymbolTable symbolTable)

Method Summary

Modifier and Type	Method and Description
boolean	canSetParameter(String name, Object value)
DOMConfiguration	getConfig() The configuration of a document.
XMLEntityResolver	getEntityResolver() Returns the registered entity resolver.
XMLErrorHandler	getErrorHandler() Returns the registered error handler.
boolean	getFeature(String featureId) Returns the state of a feature.
Boolean	getFeatureDefault(String featureId) Returns the default state for a feature, or null if this component does not want to report a default value for this feature.
XSElementDecl	getGlobalElementDecl(QName element)
Locale	getLocale() Return the Locale the XMLGrammarLoader is using.
Object	getParameter(String name)
DOMStringList	getParameterNames()
Object	getProperty(String propertyId) Returns the state of a property.
Object	getPropertyDefault(String propertyId) Returns the default state for a property, or null if this component does not want to report a default value for this property.
String[]	getRecognizedFeatures() Returns a list of feature identifiers that are recognized by this XMLGrammarLoader.
String[]	getRecognizedProperties() Returns a list of property identifiers that are recognized by this XMLGrammarLoader.
XSModel	load(LSInput is) Parse an XML Schema document from a resource identified by a LSInput .
Grammar	loadGrammar(XMLInputSource source) Returns a Grammar object by parsing the contents of the entity pointed to by source.
void	loadGrammar(XMLInputSource[] source) Returns a Grammar object by parsing the contents of the entities pointed to by sources.
XSModel	loadInputList(LSInputList is) Parses the content of XML Schema documents specified as a list of LSInputs.
XSModel	loadURI(String uri) Parse an XML Schema document from a location identified by a URI reference.
XSModel	loadURIList(StringList uriList) Parses the content of XML Schema documents specified as the list of URI references.
static void	processExternalHints(String sl, String nsl, Hashtable locations, XMLErrorReporter er)
void	reset(XMLComponentManager componentManager) Resets the component.
static XMLInputSource	resolveDocument(XSDDescription desc, Hashtable locationPairs, XMLEntityResolver entityResolver) This method tries to resolve location of the given schema.
void	setEntityResolver(XMLEntityResolver entityResolver) Sets the entity resolver.
void	setErrorHandler(XMLErrorHandler errorHandler) Sets the error handler.
void	setFeature(String featureId, boolean state) Sets the state of a feature.
void	setLocale(Locale locale) Set the locale to use for messages.
void	setParameter(String name, Object value)
void	setProperty(String propertyId, Object state) Sets the state of a property.
static boolean	tokenizeSchemaLocationStr(String schemaStr, Hashtable locations, String base)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SCHEMA_FULL_CHECKING

protected static final String SCHEMA_FULL_CHECKING

Feature identifier: schema full checking

See Also:

Constant Field Values

CONTINUE_AFTER_FATAL_ERROR

protected static final String CONTINUE_AFTER_FATAL_ERROR

Feature identifier: continue after fatal error.

See Also:

Constant Field Values

ALLOW_JAVA_ENCODINGS

protected static final String ALLOW_JAVA_ENCODINGS

Feature identifier: allow java encodings to be recognized when parsing schema docs.

See Also:

Constant Field Values

STANDARD_URI_CONFORMANT_FEATURE

protected static final String STANDARD_URI_CONFORMANT_FEATURE

Feature identifier: standard uri conformant feature.

See Also:

Constant Field Values

VALIDATE_ANNOTATIONS

protected static final String VALIDATE_ANNOTATIONS

Feature identifier: validate annotations.

See Also:

Constant Field Values

DISALLOW_DOCTYPE

protected static final String DISALLOW_DOCTYPE

Feature: disallow doctype

See Also:

Constant Field Values

GENERATE_SYNTHETIC_ANNOTATIONS

protected static final String GENERATE_SYNTHETIC_ANNOTATIONS

Feature: generate synthetic annotations

See Also:

Constant Field Values

HONOUR_ALL_SCHEMALOCATIONS

protected static final String HONOUR_ALL_SCHEMALOCATIONS

Feature identifier: honour all schemaLocations

See Also:

Constant Field Values

AUGMENT_PSVI

protected static final String AUGMENT_PSVI

See Also:

Constant Field Values

PARSER_SETTINGS

protected static final String PARSER_SETTINGS

See Also:

Constant Field Values

NAMESPACE_GROWTH

protected static final String NAMESPACE_GROWTH

Feature identifier: namespace growth

See Also:

Constant Field Values

TOLERATE_DUPLICATES

protected static final String TOLERATE_DUPLICATES

Feature identifier: tolerate duplicates

See Also:

Constant Field Values

SCHEMA_DV_FACTORY

protected static final String SCHEMA_DV_FACTORY

Property identifier: Schema DV Factory

See Also:

Constant Field Values

SYMBOL_TABLE

public static final String SYMBOL_TABLE

Property identifier: symbol table.

See Also:

Constant Field Values

ERROR_REPORTER

public static final String ERROR_REPORTER

Property identifier: error reporter.

See Also:

Constant Field Values

ERROR_HANDLER

protected static final String ERROR_HANDLER

Property identifier: error handler.

See Also:

Constant Field Values

ENTITY_RESOLVER

public static final String ENTITY_RESOLVER

Property identifier: entity resolver.

See Also:

Constant Field Values

XMLGRAMMAR_POOL

public static final String XMLGRAMMAR_POOL

Property identifier: grammar pool.

See Also:

Constant Field Values

SCHEMA_LOCATION

protected static final String SCHEMA_LOCATION

Property identifier: schema location.

See Also:

Constant Field Values

SCHEMA_NONS_LOCATION

protected static final String SCHEMA_NONS_LOCATION

Property identifier: no namespace schema location.

See Also:

Constant Field Values

JAXP_SCHEMA_SOURCE

protected static final String JAXP_SCHEMA_SOURCE

Property identifier: JAXP schema source.

See Also:

Constant Field Values

SECURITY_MANAGER

protected static final String SECURITY_MANAGER

See Also:

Constant Field Values

LOCALE

protected static final String LOCALE

Property identifier: locale.

See Also:

Constant Field Values

ENTITY_MANAGER

protected static final String ENTITY_MANAGER

See Also:

Constant Field Values

Constructor Detail

XMLSchemaLoader

public XMLSchemaLoader()

XMLSchemaLoader

public XMLSchemaLoader(SymbolTable symbolTable)

Method Detail

getRecognizedFeatures

public String[] getRecognizedFeatures()

Returns a list of feature identifiers that are recognized by this XMLGrammarLoader. This method may return null if no features are recognized.

Specified by:

getRecognizedFeatures in interface XMLGrammarLoader

Specified by:

getRecognizedFeatures in interface XMLComponent

getFeature

public boolean getFeature(String featureId)
                   throws XMLConfigurationException

Returns the state of a feature.

Specified by:

getFeature in interface XMLGrammarLoader

Parameters:

featureId - The feature identifier.

Throws:

XMLConfigurationException - Thrown on configuration error.

setFeature

public void setFeature(String featureId,
                       boolean state)
                throws XMLConfigurationException

Sets the state of a feature.

Specified by:

setFeature in interface XMLGrammarLoader

Specified by:

setFeature in interface XMLComponent

Parameters:

featureId - The feature identifier.

state - The state of the feature.

Throws:

XMLConfigurationException - Thrown when a feature is not recognized or cannot be set.

getRecognizedProperties

public String[] getRecognizedProperties()

Returns a list of property identifiers that are recognized by this XMLGrammarLoader. This method may return null if no properties are recognized.

Specified by:

getRecognizedProperties in interface XMLGrammarLoader

Specified by:

getRecognizedProperties in interface XMLComponent

getProperty

public Object getProperty(String propertyId)
                   throws XMLConfigurationException

Returns the state of a property.

Specified by:

getProperty in interface XMLGrammarLoader

Parameters:

propertyId - The property identifier.

Throws:

XMLConfigurationException - Thrown on configuration error.

setProperty

public void setProperty(String propertyId,
                        Object state)
                 throws XMLConfigurationException

Sets the state of a property.

Specified by:

setProperty in interface XMLGrammarLoader

Specified by:

setProperty in interface XMLComponent

Parameters:

propertyId - The property identifier.

state - The state of the property.

Throws:

XMLConfigurationException - Thrown when a property is not recognized or cannot be set.

setLocale

public void setLocale(Locale locale)

Set the locale to use for messages.

Specified by:

setLocale in interface XMLGrammarLoader

Parameters:

locale - The locale object to use for localization of messages.

Throws:

XNIException - Thrown if the parser does not support the specified locale.

getLocale

public Locale getLocale()

Return the Locale the XMLGrammarLoader is using.

Specified by:

getLocale in interface XMLGrammarLoader

setErrorHandler

public void setErrorHandler(XMLErrorHandler errorHandler)

Sets the error handler.

Specified by:

setErrorHandler in interface XMLGrammarLoader

Parameters:

errorHandler - The error handler.

getErrorHandler

public XMLErrorHandler getErrorHandler()

Returns the registered error handler.

Specified by:

getErrorHandler in interface XMLGrammarLoader

setEntityResolver

public void setEntityResolver(XMLEntityResolver entityResolver)

Sets the entity resolver.

Specified by:

setEntityResolver in interface XMLGrammarLoader

Parameters:

entityResolver - The new entity resolver.

getEntityResolver

public XMLEntityResolver getEntityResolver()

Returns the registered entity resolver.

Specified by:

getEntityResolver in interface XMLGrammarLoader

loadGrammar

public void loadGrammar(XMLInputSource[] source)
                 throws IOException,
                        XNIException

Returns a Grammar object by parsing the contents of the entities pointed to by sources.

Parameters:

source - the locations of the entity which forms the staring point of the grammars to be constructed

Throws:

IOException - when a problem is encounted reading the entity

XNIException - when a condition arises (such as a FatalError) that requires parsing of the entity be terminated

loadGrammar

public Grammar loadGrammar(XMLInputSource source)
                    throws IOException,
                           XNIException

Returns a Grammar object by parsing the contents of the entity pointed to by source.

Specified by:

loadGrammar in interface XMLGrammarLoader

Parameters:

source - the location of the entity which forms the starting point of the grammar to be constructed.

Throws:

IOException - When a problem is encountered reading the entity XNIException When a condition arises (such as a FatalError) that requires parsing of the entity be terminated.

XNIException

resolveDocument

public static XMLInputSource resolveDocument(XSDDescription desc,
                                             Hashtable locationPairs,
                                             XMLEntityResolver entityResolver)
                                      throws IOException

This method tries to resolve location of the given schema. The loader stores the namespace/location pairs in a hashtable (use "" as the namespace of absent namespace). When resolving an entity, loader first tries to find in the hashtable whether there is a value for that namespace, if so, pass that location value to the user-defined entity resolver.

Parameters:

desc -

locationPairs -

entityResolver -

Returns:

the XMLInputSource

Throws:

IOException

processExternalHints

public static void processExternalHints(String sl,
                                        String nsl,
                                        Hashtable locations,
                                        XMLErrorReporter er)

tokenizeSchemaLocationStr

public static boolean tokenizeSchemaLocationStr(String schemaStr,
                                                Hashtable locations,
                                                String base)

getFeatureDefault

public Boolean getFeatureDefault(String featureId)

Description copied from interface: XMLComponent

Returns the default state for a feature, or null if this component does not want to report a default value for this feature.

Specified by:

getFeatureDefault in interface XMLComponent

Parameters:

featureId - The feature identifier.

getPropertyDefault

public Object getPropertyDefault(String propertyId)

Description copied from interface: XMLComponent

Returns the default state for a property, or null if this component does not want to report a default value for this property.

Specified by:

getPropertyDefault in interface XMLComponent

Parameters:

propertyId - The property identifier.

reset

public void reset(XMLComponentManager componentManager)
           throws XMLConfigurationException

Description copied from interface: XMLComponent

Resets the component. The component can query the component manager about any features and properties that affect the operation of the component.

Specified by:

reset in interface XMLComponent

Parameters:

componentManager - The component manager.

Throws:

XMLConfigurationException

getConfig

public DOMConfiguration getConfig()

Description copied from interface: XSLoader

The configuration of a document. It maintains a table of recognized parameters. Using the configuration, it is possible to change the behavior of the load methods. The configuration may support the setting of and the retrieval of the following non-boolean parameters defined on the DOMConfiguration interface: error-handler (DOMErrorHandler) and resource-resolver (LSResourceResolver).
The following list of boolean parameters is defined:

"validate"

true

[required] (default) Validate an XML Schema during loading. If validation errors are found, the error handler is notified.

false

[optional] Do not report errors during the loading of an XML Schema document.

Specified by:

getConfig in interface XSLoader

load

public XSModel load(LSInput is)

Description copied from interface: XSLoader

Parse an XML Schema document from a resource identified by a LSInput .

Specified by:

load in interface XSLoader

Parameters:

is - The LSInput from which the source document is to be read.

Returns:

An XSModel representing this schema.

loadInputList

public XSModel loadInputList(LSInputList is)

Description copied from interface: XSLoader

Parses the content of XML Schema documents specified as a list of LSInputs.

Specified by:

loadInputList in interface XSLoader

Parameters:

is - The list of LSInputs from which the XML Schema documents are to be read.

Returns:

An XSModel representing the schema documents.

loadURI

public XSModel loadURI(String uri)

Description copied from interface: XSLoader

Parse an XML Schema document from a location identified by a URI reference. If the URI contains a fragment identifier, the behavior is not defined by this specification.

Specified by:

loadURI in interface XSLoader

Parameters:

uri - The location of the XML Schema document to be read.

Returns:

An XSModel representing this schema.

loadURIList

public XSModel loadURIList(StringList uriList)

Description copied from interface: XSLoader

Parses the content of XML Schema documents specified as the list of URI references. If the URI contains a fragment identifier, the behavior is not defined by this specification.

Specified by:

loadURIList in interface XSLoader

Parameters:

uriList - The list of URI locations.

Returns:

An XSModel representing the schema documents.

canSetParameter

public boolean canSetParameter(String name,
                               Object value)

Specified by:

canSetParameter in interface DOMConfiguration

getParameter

public Object getParameter(String name)
                    throws DOMException

Specified by:

getParameter in interface DOMConfiguration

Throws:

DOMException

getParameterNames

public DOMStringList getParameterNames()

Specified by:

getParameterNames in interface DOMConfiguration

setParameter

public void setParameter(String name,
                         Object value)
                  throws DOMException

Specified by:

setParameter in interface DOMConfiguration

Throws:

DOMException

getGlobalElementDecl

public XSElementDecl getGlobalElementDecl(QName element)

Specified by:

getGlobalElementDecl in interface XSElementDeclHelper