<p>If a SAX application needs to implement customized handling
for external entities, it must implement this interface and
register an instance with the SAX driver using the
{@link org.xml.sax.XMLReader#setEntityResolver setEntityResolver}
method.</p>
<p>The XML reader will then allow the application to intercept any
external entities (including the external DTD subset and external
parameter entities, if any) before including them.</p>
<p>Many SAX applications will not need to implement this interface,
but it will be especially useful for applications that build
XML documents from databases or other specialised input sources,
or for applications that use URI types other than URLs.</p>
<p>The following resolver would provide the application
with a special character stream for the entity with the system
identifier "http://www.myhost.com/today":</p>
public class MyResolver implements EntityResolver {
public InputSource resolveEntity (String publicId, String systemId)
{
if (systemId.equals("http://www.myhost.com/today")) {
// return a special input source
MyReader reader = new MyReader();
return new InputSource(reader);
} else {
// use the default behaviour
return null;
}
}
}
</pre>
<p>The application can also use this interface to redirect system
identifiers to local URIs or to look up replacements in a catalog
(possibly by using the public identifier).</p>
Basic interface for resolving entities.
<p>If a SAX application needs to implement customized handling for external entities, it must implement this interface and register an instance with the SAX driver using the {@link org.xml.sax.XMLReader#setEntityResolver setEntityResolver} method.</p>
<p>The XML reader will then allow the application to intercept any external entities (including the external DTD subset and external parameter entities, if any) before including them.</p>
<p>Many SAX applications will not need to implement this interface, but it will be especially useful for applications that build XML documents from databases or other specialised input sources, or for applications that use URI types other than URLs.</p>
<p>The following resolver would provide the application with a special character stream for the entity with the system identifier "http://www.myhost.com/today":</p>
<pre> import org.xml.sax.EntityResolver; import org.xml.sax.InputSource;
public class MyResolver implements EntityResolver { public InputSource resolveEntity (String publicId, String systemId) { if (systemId.equals("http://www.myhost.com/today")) { // return a special input source MyReader reader = new MyReader(); return new InputSource(reader); } else { // use the default behaviour return null; } } } </pre>
<p>The application can also use this interface to redirect system identifiers to local URIs or to look up replacements in a catalog (possibly by using the public identifier).</p>
@since SAX 1.0 @author David Megginson @version 2.0.1 (sax2r2) @see org.xml.sax.XMLReader#setEntityResolver @see org.xml.sax.InputSource