org.apache.tools.ant.types.resolver: public class: ApacheCatalogResolver

org.apache.tools.ant.types.resolver
public class: ApacheCatalogResolver [javadoc | source]

java.lang.Object
   org.apache.xml.resolver.tools.CatalogResolver
      org.apache.tools.ant.types.resolver.ApacheCatalogResolver

This class extends the CatalogResolver class provided by Norman Walsh's resolver library in xml-commons. It provides the bridge between the Ant XMLCatalog datatype and the xml-commons Catalog class. XMLCatalog calls methods in this class using Reflection in order to avoid requiring the xml-commons resolver library in the path.

The ApacheCatalog class is used to parse external catalog files, which can be in either plain text format or XML format.

For each entry found in an external catalog file, if any, an instance of ResourceLocation is created and added to the controlling XMLCatalog datatype. In this way, these entries will be included in XMLCatalog's lookup algorithm. See XMLCatalog.java for more details.

Also see:

org.apache.tools.ant.types.XMLCatalog.CatalogResolver

org.apache.xml.resolver.CatalogManager

since: Ant - 1.6

Method from org.apache.tools.ant.types.resolver.ApacheCatalogResolver Summary:
addPublicEntry, addURIEntry, parseCatalog, setXMLCatalog

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.apache.tools.ant.types.resolver.ApacheCatalogResolver Detail:
public void addPublicEntry(String publicid, String systemid, URL base) { ResourceLocation dtd = new ResourceLocation(); dtd.setBase(base); dtd.setPublicId(publicid); dtd.setLocation(systemid); xmlCatalog.addDTD(dtd); } Add a PUBLIC catalog entry to the controlling XMLCatalog instance. ApacheCatalog calls this for each PUBLIC entry found in an external catalog file.
public void addURIEntry(String uri, String altURI, URL base) { ResourceLocation entity = new ResourceLocation(); entity.setBase(base); entity.setPublicId(uri); entity.setLocation(altURI); xmlCatalog.addEntity(entity); } Add a URI catalog entry to the controlling XMLCatalog instance. ApacheCatalog calls this for each URI entry found in an external catalog file.
public void parseCatalog(String file) { Catalog catalog = getCatalog(); if (!(catalog instanceof ApacheCatalog)) { throw new BuildException("Wrong catalog type found: " + catalog.getClass().getName()); } ApacheCatalog apacheCatalog = (ApacheCatalog) catalog; // Pass in reference to ourselves so we can be called back. apacheCatalog.setResolver(this); try { apacheCatalog.parseCatalog(file); } catch (MalformedURLException ex) { throw new BuildException(ex); } catch (IOException ex) { throw new BuildException(ex); } } XMLCatalog calls this to add an external catalog file for each file within a `<catalogfiles>` fileset.
public void setXMLCatalog(XMLCatalog xmlCatalog) { this.xmlCatalog = xmlCatalog; } Set the XMLCatalog object to callback.

Method from org.apache.tools.ant.types.resolver.ApacheCatalogResolver Detail:

 public  void addPublicEntry(String publicid,
    String systemid,
    URL base) {
        ResourceLocation dtd = new ResourceLocation();
        dtd.setBase(base);
        dtd.setPublicId(publicid);
        dtd.setLocation(systemid);
        xmlCatalog.addDTD(dtd);
}

Add a PUBLIC catalog entry to the controlling XMLCatalog instance. ApacheCatalog calls this for each PUBLIC entry found in an external catalog file.

 public  void addURIEntry(String uri,
    String altURI,
    URL base) {
        ResourceLocation entity = new ResourceLocation();
        entity.setBase(base);
        entity.setPublicId(uri);
        entity.setLocation(altURI);
        xmlCatalog.addEntity(entity);
}

Add a URI catalog entry to the controlling XMLCatalog instance. ApacheCatalog calls this for each URI entry found in an external catalog file.

 public  void parseCatalog(String file) {
        Catalog catalog = getCatalog();
        if (!(catalog instanceof ApacheCatalog)) {
            throw new BuildException("Wrong catalog type found: " + catalog.getClass().getName());
        }
        ApacheCatalog apacheCatalog = (ApacheCatalog) catalog;
        // Pass in reference to ourselves so we can be called back.
        apacheCatalog.setResolver(this);
        try {
            apacheCatalog.parseCatalog(file);
        } catch (MalformedURLException ex) {
            throw new BuildException(ex);
        } catch (IOException ex) {
            throw new BuildException(ex);
        }
}

<catalogfiles>

 public  void setXMLCatalog(XMLCatalog xmlCatalog) {
        this.xmlCatalog = xmlCatalog;
}

Set the XMLCatalog object to callback.