Examples of org.jboss.util.xml.catalog.Catalog

org.jboss.util.xml.catalog.Catalog
asis-open.org/html/a401.htm">OASIS Technical Resolution 9401:1997 (Amendment 2 to TR 9401)).

The primary purpose of the Catalog is to associate resources in the document with local system identifiers. Some entities (document types, XML entities, and notations) have names and all of them can have either public or system identifiers or both. (In XML, only a notation can have a public identifier without a system identifier, but the methods implemented in this class obey the Catalog semantics from the SGML days when system identifiers were optional.)

The system identifiers returned by the resolution methods in this class are valid, i.e. usable by, and in fact constructed by, the java.net.URL class. Unfortunately, this class seems to behave in somewhat non-standard ways and the system identifiers returned may not be directly usable in a browser or filesystem context.
This class recognizes all of the Catalog entries defined in TR9401:1997:
- BASE changes the base URI for resolving relative system identifiers. The initial base URI is the URI of the location of the catalog (which is, in turn, relative to the location of the current working directory at startup, as returned by the user.dir system property).
- CATALOG processes other catalog files. An included catalog occurs logically at the end of the including catalog.
- DELEGATE_PUBLIC specifies alternate catalogs for some public identifiers. The delegated catalogs are not loaded until they are needed, but they are cached once loaded.
- DELEGATE_SYSTEM specifies alternate catalogs for some system identifiers. The delegated catalogs are not loaded until they are needed, but they are cached once loaded.
- DELEGATE_URI specifies alternate catalogs for some URIs. The delegated catalogs are not loaded until they are needed, but they are cached once loaded.
- REWRITE_SYSTEM specifies alternate prefix for a system identifier.
- REWRITE_URI specifies alternate prefix for a URI.
- DOCTYPE associates the names of root elements with URIs. (In other words, an XML processor might infer the doctype of an XML document that does not include a doctype declaration by looking for the DOCTYPE entry in the catalog which matches the name of the root element of the document.)
- DOCUMENT provides a default document.
- DTDDECL recognized and silently ignored. Not relevant for XML.
- ENTITY associates entity names with URIs.
- LINKTYPE recognized and silently ignored. Not relevant for XML.
- NOTATION associates notation names with URIs.
- OVERRIDE changes the override behavior. Initial behavior is set by the system property xml.catalog.override. The default initial behavior is 'YES', that is, entries in the catalog override system identifiers specified in the document.
- PUBLIC maps a public identifier to a system identifier.
- SGMLDECL recognized and silently ignored. Not relevant for XML.
- SYSTEM maps a system identifier to another system identifier.
- URI maps a URI to another URI.
Note that BASE entries are treated as described by RFC2396. In particular, this has the counter-intuitive property that after a BASE entry identifing "http://example.com/a/b/c" as the base URI, the relative URI "foo" is resolved to the absolute URI "http://example.com/a/b/foo". You must provide the trailing slash if you do not want the final component of the path to be discarded as a filename would in a URI for a resource: "http://example.com/a/b/c/".

Note that subordinate catalogs (all catalogs except the first, including CATALOG and DELEGATE* catalogs) are only loaded if and when they are required.

This class relies on classes which implement the CatalogReader interface to actually load catalog files. This allows the catalog semantics to be implemented for TR9401 text-based catalogs, XML catalogs, or any number of other storage formats.

Additional catalogs may also be loaded with the {@link #parseCatalog(String)} method.

Change Log:
2.0

Rewrite to use CatalogReaders.

1.1
Allow quoted components in xml.catalog.files so that URLs containing colons can be used on Unix. The string passed to xml.catalog.files can now have the form:
```
 unquoted-path-with-no-sep-chars:"double-quoted path with or without sep chars":'single-quoted path with or without sep chars' 
```
(Where ":" is the separater character in this example.)

If an unquoted path contains an embedded double or single quote character, no special processig is performed on that character. No path can contain separater characters, double, and single quotes simultaneously.

Fix bug in calculation of BASE entries: if a catalog contains multiple BASE entries, each is relative to the preceding base, not the default base URI of the catalog.
1.0.1

Fixed a bug in the calculation of the list of subordinate catalogs. This bug caused an infinite loop where parsing would alternately process two catalogs indefinitely.
@see CatalogReader @see CatalogEntry @author Norman WalshNorman.Walsh@Sun.COM @version 1.0
Derived from public domain code originally published by Arbortext, Inc.

   * Get a new catalog instance.
   *
   * This method always returns a new instance of the underlying catalog class.
   */
  public Catalog getPrivateCatalog() {
    Catalog catalog = staticCatalog;


    if (useStaticCatalog == null) {
      useStaticCatalog = new Boolean(getUseStaticCatalog());
    }


    if (catalog == null || !useStaticCatalog.booleanValue()) {


      try {
  String catalogClassName = getCatalogClassName();


  if (catalogClassName == null) {
    catalog = new Catalog();
  } else {
    try {
      catalog = (Catalog) Class.forName(catalogClassName).newInstance();
    } catch (ClassNotFoundException cnfe) {
      debug.message(1,"Catalog class named '"
        + catalogClassName
        + "' could not be found. Using default.");
      catalog = new Catalog();
    } catch (ClassCastException cnfe) {
      debug.message(1,"Class named '"
        + catalogClassName
        + "' is not a Catalog. Using default.");
      catalog = new Catalog();
    }
  }


  catalog.setCatalogManager(this);
  catalog.setupReaders();
  catalog.loadSystemCatalogs();
      } catch (Exception ex) {
  ex.printStackTrace();
      }


      if (useStaticCatalog.booleanValue()) {

View Full Code Here

   *
   * If this manager uses static catalogs, the same static catalog will
   * always be returned. Otherwise a new catalog will be returned.
   */
  public Catalog getCatalog() {
    Catalog catalog = staticCatalog;


    if (useStaticCatalog == null) {
      useStaticCatalog = new Boolean(getUseStaticCatalog());
    }

View Full Code Here

   * @return a new catalog instance.
   *
   * This method always returns a new instance of the underlying catalog class.
   */
  public Catalog getPrivateCatalog() {
    Catalog catalog = staticCatalog;


    if (useStaticCatalog == null) {
      useStaticCatalog = new Boolean(getUseStaticCatalog());
    }


    if (catalog == null || !useStaticCatalog.booleanValue()) {


      try {
  String catalogClassName = getCatalogClassName();


  if (catalogClassName == null) {
    catalog = new Catalog();
  } else {
    try {
      catalog = (Catalog) Class.forName(catalogClassName).newInstance();
    } catch (ClassNotFoundException cnfe) {
      debug.message(1,"Catalog class named '"
        + catalogClassName
        + "' could not be found. Using default.");
      catalog = new Catalog();
    } catch (ClassCastException cnfe) {
      debug.message(1,"Class named '"
        + catalogClassName
      + "' is not a Catalog. Using default.");
      catalog = new Catalog();
    }
  }


  catalog.setCatalogManager(this);
  catalog.setupReaders();
  catalog.loadSystemCatalogs();
      } catch (Exception ex) {
  ex.printStackTrace();
      }


      if (useStaticCatalog.booleanValue()) {

View Full Code Here

   *
   * If this manager uses static catalogs, the same static catalog will
   * always be returned. Otherwise a new catalog will be returned.
   */
  public Catalog getCatalog() {
    Catalog catalog = staticCatalog;


    if (useStaticCatalog == null) {
      useStaticCatalog = new Boolean(getUseStaticCatalog());
    }

View Full Code Here

TOP

Related Classes of org.jboss.util.xml.catalog.Catalog

org.jboss.util.xml.catalog.CatalogManager

org.jboss.util.xml.catalog.readers.CatalogReader

org.jboss.util.xml.catalog.readers.SAXCatalogReader

org.jboss.util.xml.catalog.readers.TR9401CatalogReader

javax.xml.parsers.SAXParserFactory

java.io.DataInputStream

java.net.URL

java.util.Vector

java.util.Enumeration

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.