| java.lang.Object
 com.sun.org.apache.xml.internal.resolver.CatalogManager
| CatalogManager | | public class CatalogManager (Code) | | CatalogManager provides an interface to the catalog properties.
Properties can come from two places: from system properties or
from a CatalogManager.properties file. This class provides a transparent
interface to both, with system properties preferred over property file values.
The following table summarizes the properties:
| System Property |
CatalogManager.properties
Property |
Description |
| xml.catalog.ignoreMissing |
|
If true, a missing CatalogManager.properties file or missing properties
within that file will not generate warning messages. See also the
ignoreMissingProperties method. |
| xml.catalog.files |
catalogs |
The semicolon-delimited list of catalog files. |
| |
relative-catalogs |
If false, relative catalog URIs are made absolute with respect to the base URI of
the CatalogManager.properties file. This setting only applies to catalog
URIs obtained from the catalogs property in the
CatalogManager.properties file |
| xml.catalog.verbosity |
verbosity |
If non-zero, the Catalog classes will print informative and debugging messages.
The higher the number, the more messages. |
| xml.catalog.prefer |
prefer |
Which identifier is preferred, "public" or "system"? |
| xml.catalog.staticCatalog |
static-catalog |
Should a single catalog be constructed for all parsing, or should a different
catalog be created for each parser? |
| xml.catalog.allowPI |
allow-oasis-xml-catalog-pi |
If the source document contains "oasis-xml-catalog" processing instructions,
should they be used? |
| xml.catalog.className |
catalog-class-name |
If you're using the convenience classes
com.sun.org.apache.xml.internal.resolver.tools.*), this setting
allows you to specify an alternate class name to use for the underlying
catalog. |
See Also: Catalog
author:
Norman Walsh
author:
Norman.Walsh@Sun.COM
version:
1.0 |
| Field Summary | |
| public Debug | debug
The manager's debug object. |
| debug | | public Debug debug(Code) | | The manager's debug object. Used for printing debugging messages.
This field is public so that objects that have access to this
CatalogManager can use this debug object.
|
| CatalogManager | | public CatalogManager()(Code) | | Constructor.
|
| CatalogManager | | public CatalogManager(String propertyFile)(Code) | | Constructor that specifies an explicit property file.
|
| allowOasisXMLCatalogPI | | public boolean allowOasisXMLCatalogPI()(Code) | | Get the current XML Catalog PI setting.
|
| catalogClassName | | public String catalogClassName()(Code) | | Get the current Catalog class name.
|
| catalogFiles | | public Vector catalogFiles()(Code) | | Return the current list of catalog files.
A vector of the catalog file names or null if no catalogsare available in the properties. |
| getAllowOasisXMLCatalogPI | | public boolean getAllowOasisXMLCatalogPI()(Code) | | Get the current XML Catalog PI setting.
|
| getCatalog | | public Catalog getCatalog()(Code) | | Get a catalog instance.
If this manager uses static catalogs, the same static catalog will
always be returned. Otherwise a new catalog will be returned.
|
| getCatalogClassName | | public String getCatalogClassName()(Code) | | Get the current Catalog class name.
|
| getCatalogFiles | | public Vector getCatalogFiles()(Code) | | Return the current list of catalog files.
A vector of the catalog file names or null if no catalogsare available in the properties. |
| getIgnoreMissingProperties | | public boolean getIgnoreMissingProperties()(Code) | | How are missing properties handled?
If true, missing or unreadable property files will
not be reported. Otherwise, a message will be sent to System.err.
|
| getPreferPublic | | public boolean getPreferPublic()(Code) | | Return the current prefer public setting.
True if public identifiers are preferred. |
| getPrivateCatalog | | public Catalog getPrivateCatalog()(Code) | | Get a new catalog instance.
This method always returns a new instance of the underlying catalog class.
|
| getRelativeCatalogs | | public boolean getRelativeCatalogs()(Code) | | Get the relativeCatalogs setting.
This property is used when the catalogFiles property is
interrogated. If true, then relative catalog entry file names
are returned. If false, relative catalog entry file names are
made absolute with respect to the properties file before returning
them.
This property only applies when the catalog files
come from a properties file. If they come from a system property or
the default list, they are never considered relative. (What would
they be relative to?)
In the properties, a value of 'yes', 'true', or '1' is considered
true, anything else is false.
The relativeCatalogs setting from the propertyFile or thedefaultRelativeCatalogs. |
| getStaticManager | | public static CatalogManager getStaticManager()(Code) | | Allow access to the static CatalogManager
|
| getUseStaticCatalog | | public boolean getUseStaticCatalog()(Code) | | Get the current use static catalog setting.
|
| getVerbosity | | public int getVerbosity()(Code) | | What is the current verbosity?
|
| ignoreMissingProperties | | public void ignoreMissingProperties(boolean ignore)(Code) | | How are missing properties handled?
If ignore is true, missing or unreadable property files will
not be reported. Otherwise, a message will be sent to System.err.
|
| preferPublic | | public boolean preferPublic()(Code) | | Return the current prefer public setting.
True if public identifiers are preferred. |
| queryAllowOasisXMLCatalogPI | | public boolean queryAllowOasisXMLCatalogPI()(Code) | | Obtain the oasisXMLCatalogPI setting from the properties.
In the properties, a value of 'yes', 'true', or '1' is considered
true, anything else is false.
The oasisXMLCatalogPI setting from the propertyFile or thedefaultOasisXMLCatalogPI. |
| queryCatalogClassName | | public String queryCatalogClassName()(Code) | | Obtain the Catalog class name setting from the properties.
|
| relativeCatalogs | | public boolean relativeCatalogs()(Code) | | Get the relativeCatalogs setting.
|
| setAllowOasisXMLCatalogPI | | public void setAllowOasisXMLCatalogPI(boolean allowPI)(Code) | | Set the XML Catalog PI setting
|
| setCatalogClassName | | public void setCatalogClassName(String className)(Code) | | Set the Catalog class name.
|
| setCatalogFiles | | public void setCatalogFiles(String fileList)(Code) | | Set the list of catalog files.
|
| setIgnoreMissingProperties | | public void setIgnoreMissingProperties(boolean ignore)(Code) | | How should missing properties be handled?
If ignore is true, missing or unreadable property files will
not be reported. Otherwise, a message will be sent to System.err.
|
| setPreferPublic | | public void setPreferPublic(boolean preferPublic)(Code) | | Set the prefer public setting.
|
| setUseStaticCatalog | | public void setUseStaticCatalog(boolean useStatic)(Code) | | Set the use static catalog setting.
|
| setVerbosity | | public void setVerbosity(int verbosity)(Code) | | Set the current verbosity.
|
| staticCatalog | | public boolean staticCatalog()(Code) | | Get the current use static catalog setting.
|
| verbosity | | public int verbosity()(Code) | | What is the current verbosity?
|
|
|