Flying Saucer Project Release ${app.version}

org.xhtmlrenderer.resource
Class FSEntityResolver

java.lang.Object
  extended by org.xhtmlrenderer.resource.FSEntityResolver
All Implemented Interfaces:
org.xml.sax.EntityResolver

public class FSEntityResolver
extends java.lang.Object
implements org.xml.sax.EntityResolver

A SAX EntityResolver for common entity references and DTDs in X/HTML processing. Maps official entity references to local copies to avoid network lookup. The local copies are stored in the source tree under /entities, and the references here are resolved by a system ClassLoader. As long as the entity files are in the classpath (or bundled in the FS jar), they will be picked up.

The basic form of this class comes from Elliot Rusty Harold, on http://www.cafeconleche.org/books/xmljava/chapters/ch07s02.html

This class is a Singleton; use instance to retrieve it.

Author:
Patrick Wright

Method Summary
 java.util.Map getEntities()
          Returns a map of entities parsed by this resolver.
static FSEntityResolver instance()
          Gets an instance of this class.
 org.xml.sax.InputSource resolveEntity(java.lang.String publicID, java.lang.String systemID)
          Description of the Method
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

resolveEntity

public org.xml.sax.InputSource resolveEntity(java.lang.String publicID,
                                             java.lang.String systemID)
                                      throws org.xml.sax.SAXException
Description of the Method

Specified by:
resolveEntity in interface org.xml.sax.EntityResolver
Parameters:
publicID - PARAM
systemID - PARAM
Returns:
Returns
Throws:
org.xml.sax.SAXException - Throws

instance

public static FSEntityResolver instance()
Gets an instance of this class.

Returns:
An instance of .

getEntities

public java.util.Map getEntities()
Returns a map of entities parsed by this resolver.

Returns:
a map of entities parsed by this resolver.

Flying Saucer Project Release ${app.version}

Flying Saucer Project Home