org.mdiutil.xml

Class EntityListResolver

java.lang.Object

org.mdiutil.xml.EntityListResolver

All Implemented Interfaces:

URIResolver, LSResourceResolver, EntityResolver

public class EntityListResolver
extends Object
implements LSResourceResolver, EntityResolver, URIResolver

A class which can manage entity resolution in XML files. This class offer a framework to resolve resources encountered in XML files (including XML Schemas). Note that this class is able to resolve sibling entities of an entity which has been resolved. For example, if the following systemID is resolved:

• "http://location/refXSD.xsd" => "D:/myFiles/schemas/refXSD.xsd"

Then upon encountering the following entity (for example referred to in refXSD.xsd):

• "http://location/childSchema.xsd"

The resolver will look for the following resource:

• "D:/myFiles/schemas/childSchema.xsd"

Example

Let's define an XMLSAXParser

 EntityListResolver resolver = new EntityListResolver();*
 URL xsd = new URL(<URL of an XSD>);
 resolver.addResolvedSystemID("http://location/refXSD.xsd", xsd);

 XMLSAXParser parser = new XMLSAXParser();
 parser.setEntityListResolver(resolver);
 

During the parsing of an XML file:

• Schema locations with a "http://location/refXSD.xsd" location will be resolved to the specified XSD
• XML inclusions with a "http://location/refXSD.xsd" location will be resolved to the specified XSD

Adding default resolved entities

The addDefaultResolvedEntities() method allows to resolve the following entities:

• http://www.w3.org/2001/xml.xsd
• http://www.w3.org/2009/01/xml.xsd
• http://www.w3.org/2007/08/xml.xsd
• http://www.w3.org/2004/10/xml.xsd
• http://www.w3.org/2001/03/xml.xsd
• http://www.w3.org/2001/XMLSchema

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EntityListResolver.URLLSInput An LSInput implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SCHEMA_RESOURCES
static String	XML_RESOURCES

Constructor Summary

Constructors

Constructor and Description
EntityListResolver()
EntityListResolver(URL baseURL)

Method Summary

Modifier and Type	Method and Description
void	addDefaultResolvedEntities() Add default resolved entities.
void	addResolvedEntity(String publicId, URL entity) Add an entity resolution to the resolver.
void	addResolvedSystemID(String systemId, URL entity) Add an entity resolution to the resolver, for a specific systemID.
void	addResolvedSystemIDs(List<String> systemIDs, URL entity) Add an entity resolution to the resolver, for a list of systemIDs.
void	cacheSources(boolean cache) Set if sources are cached.
Map<String,URL>	getResolvedEntities() Return the resolved entities in the resolver.
protected InputSource	getSource(URL url, String publicId, String systemId) Return an InputSource for a systemID and an URL.
boolean	isCachingSources() Return true if sources are cached.
boolean	isResolvingEntities() Return true if the resolver is resolving entities.
boolean	isResolvingSystemEntities() Return true if the resolver is resolving system entities.
boolean	isResolvingSystemID(String systemId) Return true if the resolver resolves a specified systemID.
void	reset() Clear the content of the resolver.
InputSource	resolve(String publicId) Resolve the entity for one publicID.
Source	resolve(String href, String base)
InputSource	resolveEntity(String publicId, String systemId)
LSInput	resolveResource(String type, String namespaceURI, String publicId, String systemId, String baseURI) Allow to resolve external resources for Schema validation.
InputSource	resolveSystemID(String baseURI, String systemId) Resolve the entity for one systemID.
protected String	resolveURI(String uriAsString) Return a baseURI or a systemId as a String.

Methods inherited from class java.lang.Object

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

Field Detail

XML_RESOURCES

public static final String XML_RESOURCES

See Also:

Constant Field Values

SCHEMA_RESOURCES

public static final String SCHEMA_RESOURCES

See Also:

Constant Field Values

Constructor Detail

EntityListResolver

public EntityListResolver()

EntityListResolver

public EntityListResolver(URL baseURL)

Method Detail

addDefaultResolvedEntities

public void addDefaultResolvedEntities()

Add default resolved entities.

• http://www.w3.org/2001/xml.xsd
• http://www.w3.org/2009/01/xml.xsd
• http://www.w3.org/2007/08/xml.xsd
• http://www.w3.org/2004/10/xml.xsd
• http://www.w3.org/2001/03/xml.xsd
• http://www.w3.org/2001/XMLSchema

reset

public void reset()

Clear the content of the resolver.

cacheSources

public void cacheSources(boolean cache)

Set if sources are cached.

Parameters:

cache - true if sources are cached

isCachingSources

public boolean isCachingSources()

Return true if sources are cached. Sources are not cached by default.

Returns:

true if sources are cached

addResolvedSystemID

public void addResolvedSystemID(String systemId,
                                URL entity)

Add an entity resolution to the resolver, for a specific systemID.

Parameters:

systemId - the system ID

entity - the URL to use for the entity resolution

addResolvedSystemIDs

public void addResolvedSystemIDs(List<String> systemIDs,
                                 URL entity)

Add an entity resolution to the resolver, for a list of systemIDs.

Parameters:

systemIDs - the list of systemIDs

entity - the URL to use for the entity resolution

addResolvedEntity

public final void addResolvedEntity(String publicId,
                                    URL entity)

Add an entity resolution to the resolver.

Parameters:

publicId - the public ID

entity - the URL to use for the entity resolution

getResolvedEntities

public Map<String,URL> getResolvedEntities()

Return the resolved entities in the resolver.

Returns:

the resolved entities in the resolver

isResolvingSystemID

public boolean isResolvingSystemID(String systemId)

Return true if the resolver resolves a specified systemID.

Parameters:

systemId - the system ID

Returns:

true if the resolver resolves the specified system ID

isResolvingSystemEntities

public boolean isResolvingSystemEntities()

Return true if the resolver is resolving system entities.

Returns:

true if the resolver is resolving system entities

isResolvingEntities

public boolean isResolvingEntities()

Return true if the resolver is resolving entities.

Returns:

true if the resolver is resolving entities

getSource

protected InputSource getSource(URL url,
                                String publicId,
                                String systemId)
                         throws IOException

Return an InputSource for a systemID and an URL.

Parameters:

url - the URL

publicId - the public ID

systemId - the systemID

Returns:

the InputSource

Throws:

IOException - if it is not posible to open the stream corresponding to the URL

resolveURI

protected String resolveURI(String uriAsString)

Return a baseURI or a systemId as a String. The default implementation simply return the input String.

Parameters:

uriAsString - the baseURI or systemId

Returns:

the return the resolved baseURI or systemId

resolveSystemID

public InputSource resolveSystemID(String baseURI,
                                   String systemId)

Resolve the entity for one systemID. Will return null if there is no entity resolution for the selected systemID.

Parameters:

baseURI - the base URI

systemId - the systemID

Returns:

the resolved entity

resolve

public InputSource resolve(String publicId)

Resolve the entity for one publicID. Will return null if there is no entity resolution for the selected publicID.

Parameters:

publicId - the public ID

Returns:

the resolved entity

resolveResource

public LSInput resolveResource(String type,
                               String namespaceURI,
                               String publicId,
                               String systemId,
                               String baseURI)

Allow to resolve external resources for Schema validation. Note that newly discovered resolutions can be added to the getResolvedEntities() Map (if a child resource is found because the baseURI was discovered, it will be added to the resolution Map).

Algorithm

The way the resolver work for external resources is the following:

• If the systemId is resolved, then return the associated resolved URL
• Else if the baseURI is resolved, get the location of the systemId relative to the parent baseURI, and return the associated URL. It willalso add the resulting absolute systemId in the list of getResolvedEntities()
• Else return null, and use the default resolution

Examples

A simple example

• If http://www.my.site/mySchema.xsd is resolved to the URL associated to D:/myDirectory/myXMLSchema.xsd
• And systemId = http://www.my.site/mySchema.xsd
• The resource will be the LSInput constructed with D:/myDirectory/myXMLSchema.xsd

A more complex example

• If http://www.my.site/mySchema.xsd is resolved to the URL associated to D:/myDirectory/myXMLSchema.xsd
• And baseURI = http://www.my.site/mySchema.xsd and systemId = subSchema.xsd
• The resource will be the LSInput constructed with D:/myDirectory/subSchema.xsd
• We will add the following resolution: http://www.my.site/subSchema.xsd" to D:/myDirectory/subSchema.xsd

Specified by:

resolveResource in interface LSResourceResolver

Parameters:

type - The type of the resource being resolved. For XML [XML 1.0] resources (i.e. entities), applications must use the value "http://www.w3.org/TR/REC-xml". For XML Schema [XML Schema Part 1] , applications must use the value "http://www.w3.org/2001/XMLSchema"

namespaceURI - The namespace of the resource being resolved, e.g. the target namespace of the XML Schema

publicId - The public identifier of the external entity being referenced, or null if no public identifier was supplied or if the resource is not an entity

systemId - The system identifier, a URI reference [IETF RFC 2396], of the external resource being referenced, or null if no system identifier was supplied

baseURI - The absolute base URI of the resource being parsed, or null if there is no base URI

Returns:

the resolved resource

resolveEntity

public InputSource resolveEntity(String publicId,
                                 String systemId)
                          throws SAXException,
                                 IOException

Specified by:

resolveEntity in interface EntityResolver

Throws:

SAXException

IOException

resolve

public Source resolve(String href,
                      String base)
               throws TransformerException

Specified by:

resolve in interface URIResolver

Throws:

TransformerException