View Javadoc

1   /*
2    * Created on 13 mars 2005
3    *
4    * TODO To change the template for this generated file go to
5    * Window - Preferences - Java - Code Style - Code Templates
6    */
7   package genie.core;
8   
9   import org.xml.sax.EntityResolver;
10  
11  /***
12   * 
13   *
14   * @author T. Kia Ntoni
15   * 
16   * 13 mars 2005 
17   * IentityValidator @version 
18   */
19  public interface IEntityResolver extends EntityResolver{
20      /***
21       * <p>Register the specified DTD URL for the specified public identifier.
22       * This must be called before the first call to <code>parse()</code>.
23       * </p><p>
24       * <code>Digester</code> contains an internal <code>EntityResolver</code>
25       * implementation. This maps <code>PUBLICID</code>'s to URLs 
26       * (from which the resource will be loaded). A common use case for this
27       * method is to register local URLs (possibly computed at runtime by a 
28       * classloader) for DTDs. This allows the performance advantage of using
29       * a local version without having to ensure every <code>SYSTEM</code>
30       * URI on every processed xml document is local. This implementation provides
31       * only basic functionality. If more sophisticated features are required,
32       * using {@link #setEntityResolver} to set a custom resolver is recommended.
33       * </p><p>
34       * <strong>Note:</strong> This method will have no effect when a custom 
35       * <code>EntityResolver</code> has been set. (Setting a custom 
36       * <code>EntityResolver</code> overrides the internal implementation.) 
37       * </p>
38       * @param publicOrSystemId Public identifier of the DTD to be resolved
39       * @param entityURL The URL to use for reading this DTD
40       */
41      public abstract void register(String publicOrSystemId, String entityURL);
42  }