Class FSEntityResolver

java.lang.Object

org.openpdf.resource.FSEntityResolver

All Implemented Interfaces:

EntityResolver, EntityResolver2

public class FSEntityResolver
extends Object
implements EntityResolver2

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 ...

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

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<String,String>	entities
private static final FSEntityResolver	instance	Singleton instance, use instance() to retrieve.
private static final org.slf4j.Logger	log

Constructor Summary

Constructors

Modifier	Constructor	Description
private	FSEntityResolver()

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getEntities()	Returns a map of entities parsed by this resolver.
@Nullable String	getEntity(String url)
@Nullable InputSource	getExternalSubset(String name, String baseURI)
static FSEntityResolver	instance()	Gets an instance of this class.
private static InputSource	newEmptySource()
private static InputSource	newHTML5DoctypeSource()
InputSource	resolveEntity(String publicID, String systemID)
InputSource	resolveEntity(String name, String publicId, String baseURI, String systemId)

Methods inherited from class Object

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

Field Details

log

private static final org.slf4j.Logger log

instance

private static final FSEntityResolver instance

Singleton instance, use instance() to retrieve.

entities

private final Map<String,String> entities

Constructor Details

FSEntityResolver

private FSEntityResolver()

Method Details

resolveEntity

public InputSource resolveEntity(String publicID,
 String systemID)

Specified by:

resolveEntity in interface EntityResolver

resolveEntity

public InputSource resolveEntity(String name,
 String publicId,
 String baseURI,
 String systemId)

Specified by:

resolveEntity in interface EntityResolver2

getExternalSubset

public @Nullable InputSource getExternalSubset(String name,
 String baseURI)

Specified by:

getExternalSubset in interface EntityResolver2

newHTML5DoctypeSource

private static InputSource newHTML5DoctypeSource()

newEmptySource

private static InputSource newEmptySource()

instance

public static FSEntityResolver instance()

Gets an instance of this class.

Returns:

An instance of .

getEntities

public Map<String,String> getEntities()

Returns a map of entities parsed by this resolver.

getEntity

public @Nullable String getEntity(String url)