Package org.xmlresolver.loaders

Class XmlLoader

  • All Implemented Interfaces:
    CatalogLoader
    public class XmlLoader
extends java.lang.Object
implements CatalogLoader
    An XML catalog loader.

    This loader understands the XML Catalogs 1.1 specification XML catalog syntax.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean getArchivedCatalogs()
      Return whether or not archived catalogs are allowed.
      static Resolver getLoaderResolver()  
      boolean getPreferPublic()
      Return the current "prefer public" status.
      org.xmlresolver.catalog.entry.EntryCatalog loadCatalog​(java.net.URI catalog)
      Load the specified catalog.
      org.xmlresolver.catalog.entry.EntryCatalog loadCatalog​(java.net.URI catalog, org.xml.sax.InputSource source)
      Load the specified catalog from a given input source.
      void setArchivedCatalogs​(boolean allow)
      Allow archived catalogs on the catalog path.
      void setPreferPublic​(boolean prefer)
      Set the default "prefer public" status for this catalog.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • setPreferPublic

        public void setPreferPublic​(boolean prefer)
        Set the default "prefer public" status for this catalog.
        Specified by:
        setPreferPublic in interface CatalogLoader
        Parameters:
        prefer - True if public identifiers are to be preferred.

      • getPreferPublic

        public boolean getPreferPublic()
        Return the current "prefer public" status.
        Specified by:
        getPreferPublic in interface CatalogLoader
        Returns:
        The current "prefer public" status of this catalog loader.

      • setArchivedCatalogs

        public void setArchivedCatalogs​(boolean allow)
        Description copied from interface: CatalogLoader
        Allow archived catalogs on the catalog path.

        If allowed, then ZIP files may be specified as catalogs. The loader will return the catalog associated with the /catalog.xml or /org/xmlresolver/catalog.xml within the ZIP file.

        Specified by:
        setArchivedCatalogs in interface CatalogLoader
        Parameters:
        allow - True if archived catalogs are to be allowed.

      • getArchivedCatalogs

        public boolean getArchivedCatalogs()
        Description copied from interface: CatalogLoader
        Return whether or not archived catalogs are allowed.
        Specified by:
        getArchivedCatalogs in interface CatalogLoader
        Returns:
        True if archived catalogs are allowed.

      • getLoaderResolver

        public static Resolver getLoaderResolver()

      • loadCatalog

        public org.xmlresolver.catalog.entry.EntryCatalog loadCatalog​(java.net.URI catalog)
        Description copied from interface: CatalogLoader
        Load the specified catalog.

        The manager maintains a set of the catalogs that it has loaded. If an attempt is made to load a catalog twice, the previously loaded catalog is returned.

        Specified by:
        loadCatalog in interface CatalogLoader
        Parameters:
        catalog - The catalog URI.
        Returns:
        The parsed catalog.

      • loadCatalog

        public org.xmlresolver.catalog.entry.EntryCatalog loadCatalog​(java.net.URI catalog,
                                                              org.xml.sax.InputSource source)
        Load the specified catalog from a given input source.

        This method exists so that a catalog can be loaded even if it doesn't have a URI that can be dereferenced. It must still have a URI.

        The manager maintains a set of the catalogs that it has loaded. If an attempt is made to load a catalog twice, the previously loaded catalog is returned.

        Specified by:
        loadCatalog in interface CatalogLoader
        Parameters:
        catalog - The catalog URI.
        source - The input source.
        Returns:
        The parsed catalog.