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.
| Modifier and Type | Field and Description |
|---|---|
| private final Map | |
| private static final FSEntityResolver | instance
Singleton instance, use |
| Access | Constructor and Description |
|---|---|
| private | FSEntityResolver()
Constructor for the FSEntityResolver object, fill the map of public ids to local urls. |
| Modifier and Type | Method and Description |
|---|---|
| public Map | Returns: an unmodifiable map of entities parsed by this resolver.Returns an unmodifiable map of entities parsed by this resolver. |
| public static FSEntityResolver | |
| public InputSource | resolveEntity(String
The public identifier of the external entity
being referenced, or null if none was supplied. publicID, String The system identifier of the external entity
being referenced. systemID)Implements org. Allow the application to resolve external entities. |
| entities | back to summary |
|---|---|
| private final Map<String, String> entities | |
| instance | back to summary |
|---|---|
| private static final FSEntityResolver instance Singleton instance, use | |
| FSEntityResolver | back to summary |
|---|---|
| private FSEntityResolver() Constructor for the FSEntityResolver object, fill the map of public ids to local urls. | |
| getEntities | back to summary |
|---|---|
| public Map Returns an unmodifiable map of entities parsed by this resolver. | |
| instance | back to summary |
|---|---|
| public static FSEntityResolver instance() Gets an instance of this class.
| |
| resolveEntity | back to summary |
|---|---|
| public InputSource resolveEntity(String publicID, String systemID) Implements org. Doc from org. Allow the application to resolve external entities. The parser will call this method before opening any external entity except the top-level document entity. Such entities include the external DTD subset and external parameter entities referenced within the DTD (in either case, only if the parser reads external parameter entities), and external general entities referenced within the document element (if the parser reads external general entities). The application may request that the parser locate the entity itself, that it use an alternative URI, or that it use data provided by the application (as a character or byte input stream). Application writers can use this method to redirect external system identifiers to secure and/or local URIs, to look up public identifiers in a catalogue, or to read an entity from a database or other input source (including, for example, a dialog box). Neither XML nor SAX specifies a preferred policy for using public or system IDs to resolve resources. However, SAX specifies how to interpret any InputSource returned by this method, and that if none is returned, then the system ID will be dereferenced as a URL. If the system identifier is a URL, the SAX parser must resolve it fully before reporting it to the application.
| |