org.docx4j.org.xhtmlrenderer.resource

Class FSCatalog

java.lang.Object

org.docx4j.org.xhtmlrenderer.resource.FSCatalog

public class FSCatalog
extends Object

FSCatalog loads an XML catalog file to read mappings of public IDs for XML schemas/dtds, to resolve those mappings to a local store for the schemas. The catalog file allows one to have a single mapping of schema IDs to local files, and is useful when there are many schemas, or when schemas are broken into many smaller files. Currently FSCatalog only supports the very simple mapping of public id to local URI using the public element in the catalog XML.

FSCatalog is not an EntityResolver; it only parses a catalog file. See FSEntityResolver for entity resolution.

To use, instantiate the class, and call parseCatalog(InputSource) to retrieve a Map keyed by public ids. The class uses an XMLReader instance retrieved via XMLResource.newXMLReader(), so XMLReader configuration (and specification) follows that of the standard XML parsing in Flying Saucer.

This class is not safe for multi-threaded access.

Author:

Patrick Wright

Constructor Summary

Constructors

Constructor and Description
FSCatalog() Default constructor

Method Summary

Methods

Modifier and Type	Method and Description
Map	parseCatalog(InputSource inputSource) Parses an XML catalog file and returns a Map of public ids to local URIs read from the catalog.
Map	parseCatalog(String catalogURI) Parses an XML catalog file and returns a Map of public ids to local URIs read from the catalog.

Methods inherited from class java.lang.Object

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

Constructor Detail

FSCatalog

public FSCatalog()

Default constructor

Method Detail

parseCatalog

public Map parseCatalog(String catalogURI)

Parses an XML catalog file and returns a Map of public ids to local URIs read from the catalog. Only the catalog public elements are parsed.

Parameters:

catalogURI - A String URI to a catalog XML file on the classpath.

parseCatalog

public Map parseCatalog(InputSource inputSource)

Parses an XML catalog file and returns a Map of public ids to local URIs read from the catalog. Only the catalog public elements are parsed.

Parameters:

inputSource - A SAX InputSource to a catalog XML file on the classpath.