org.xhtmlrenderer.resource.FSEntityResolver Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of core-renderer Show documentation
Show all versions of core-renderer Show documentation
An XML/XHTML CSS 2.1 Renderer library in pure Java for rendering to PDF, images, and Swing panels.
The newest version!
/*
* {{{ header & license
* FSEntityResolver.java
* Copyright (c) 2004, 2005 Patrick Wright
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 2.1
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
* }}}
*/
package org.xhtmlrenderer.resource;
import org.xhtmlrenderer.util.GeneralUtil;
import org.xhtmlrenderer.util.XRLog;
import org.xml.sax.EntityResolver;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.util.HashMap;
import java.util.Map;
import java.util.logging.Level;
/**
*
* 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 {@link #instance} to retrieve it.
*
*
* @author Patrick Wright
*/
public class FSEntityResolver implements EntityResolver {
/**
* Singleton instance, use {@link #instance()} to retrieve.
*/
private static FSEntityResolver instance;
private final Map entities = new HashMap();
// fill the list of URLs
/**
* Constructor for the FSEntityResolver object
*/
private FSEntityResolver() {
FSCatalog catalog = new FSCatalog();
// The HTML 4.01 DTDs; includes entities. Load from catalog file.
entities.putAll(catalog.parseCatalog("resources/schema/html-4.01/catalog-html-4.01.xml"));
// XHTML common (shared declarations)
entities.putAll(catalog.parseCatalog("resources/schema/xhtml/catalog-xhtml-common.xml"));
// The XHTML 1.0 DTDs
entities.putAll(catalog.parseCatalog("resources/schema/xhtml/catalog-xhtml-1.0.xml"));
// The XHMTL 1.1 DTD
entities.putAll(catalog.parseCatalog("resources/schema/xhtml/catalog-xhtml-1.1.xml"));
// DocBook DTDs
entities.putAll(catalog.parseCatalog("resources/schema/docbook/catalog-docbook.xml"));
// The XHTML 1.1 element sets
}
/**
* Description of the Method
*
* @param publicID PARAM
* @param systemID PARAM
* @return Returns
* @throws SAXException Throws
*/
public InputSource resolveEntity(String publicID,
String systemID)
throws SAXException {
InputSource local = null;
String url = (String) getEntities().get(publicID);
if (url != null) {
URL realUrl = GeneralUtil.getURLFromClasspath(this, url);
InputStream is = null;
try {
is = realUrl.openStream();
} catch (IOException e) {
e.printStackTrace();
}
if (is == null) {
XRLog.xmlEntities(Level.WARNING,
"Can't find a local reference for Entity for public ID: " + publicID +
" and expected to. The local URL should be: " + url + ". Not finding " +
"this probably means a CLASSPATH configuration problem; this resource " +
"should be included with the renderer and so not finding it means it is " +
"not on the CLASSPATH, and should be. Will let parser use the default in " +
"this case.");
}
local = new InputSource(is);
local.setSystemId(realUrl.toExternalForm());
XRLog.xmlEntities(Level.FINE, "Entity public: " + publicID + " -> " + url +
(local == null ? ", NOT FOUND" : " (local)"));
} else {
XRLog.xmlEntities("Entity public: " + publicID + ", no local mapping. Parser will probably pull from network.");
}
return local;
}
/**
* Gets an instance of this class.
*
* @return An instance of .
*/
public static synchronized FSEntityResolver instance() {
if (instance == null) {
instance = new FSEntityResolver();
}
return instance;
}
/**
* Returns a map of entities parsed by this resolver.
* @return a map of entities parsed by this resolver.
*/
public Map getEntities() {
return new HashMap(entities);
}
}
/*
* $Id$
*
* $Log$
* Revision 1.8 2008/12/01 20:37:24 pdoubleya
* Expose copy of parsed entities from catalog.
*
* Revision 1.7 2007/05/21 22:13:02 peterbrant
* Code cleanup (patch from Sean Bright)
*
* Revision 1.6 2007/05/20 23:25:34 peterbrant
* Various code cleanups (e.g. remove unused imports)
*
* Patch from Sean Bright
*
* Revision 1.5 2005/06/13 06:50:15 tobega
* Fixed a bug in table content resolution.
* Various "tweaks" in other stuff.
*
* Revision 1.4 2005/03/28 14:24:48 pdoubleya
* Changed to resolve all entities using simple catalog files.
*
* Revision 1.3 2005/03/27 18:36:26 pdoubleya
* Added separate logging for entity resolution.
*
* Revision 1.2 2005/03/21 09:13:50 pdoubleya
* Added XHTML 1.1 references (Kevin).
*
* Revision 1.1 2005/02/03 20:39:34 pdoubleya
* Added to CVS.
*
*
*/