Save This Page
Home » Xerces-J-src.2.9.1 » org.apache.xerces » util » [javadoc | source]
org.apache.xerces.util
public class: XMLCatalogResolver [javadoc | source]
java.lang.Object
   org.apache.xerces.util.XMLCatalogResolver

All Implemented Interfaces:
    LSResourceResolver, XMLEntityResolver, EntityResolver2

The catalog resolver handles the resolution of external identifiers and URI references through XML catalogs. This component supports XML catalogs defined by the OASIS XML Catalogs Specification. It encapsulates the XML Commons resolver. An instance of this class may be registered on the parser as a SAX entity resolver, as a DOM LSResourceResolver or as an XNI entity resolver by setting the property (http://apache.org/xml/properties/internal/entity-resolver).

It is intended that this class may be used standalone to perform catalog resolution outside of a parsing context. It may be shared between several parsers and the application.

Constructor:
 public XMLCatalogResolver() 
 public XMLCatalogResolver(String[] catalogs) 

    Constructs a catalog resolver with the given list of entry files.

    Parameters:
    catalogs - an ordered array list of absolute URIs
 public XMLCatalogResolver(String[] catalogs,
    boolean preferPublic) 

    Constructs a catalog resolver with the given list of entry files and the preference for whether system or public matches are preferred.

    Parameters:
    catalogs - an ordered array list of absolute URIs
    preferPublic - the prefer public setting
Method from org.apache.xerces.util.XMLCatalogResolver Summary:
clear,   getCatalogList,   getExternalSubset,   getPreferPublic,   getUseLiteralSystemId,   resolveEntity,   resolveEntity,   resolveEntity,   resolveIdentifier,   resolvePublic,   resolveResource,   resolveSystem,   resolveURI,   setCatalogList,   setPreferPublic,   setUseLiteralSystemId
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.xerces.util.XMLCatalogResolver Detail:
 public final synchronized  void clear() 

    Forces the cache of catalog mappings to be cleared.

 public final synchronized String[] getCatalogList() 

    Returns the initial list of catalog entry files.

 public InputSource getExternalSubset(String name,
    String baseURI) throws IOException, SAXException 

    Locates an external subset for documents which do not explicitly provide one. This method always returns null. It should be overrided if other behaviour is required.

 public final boolean getPreferPublic() 

    Returns the preference for whether system or public matches are preferred. This is used in the absence of any occurrence of the prefer attribute on the catalog entry of a catalog. If this property has not yet been explicitly set its value is true.

 public final boolean getUseLiteralSystemId() 

    Returns the preference for whether the literal system identifier should be used when resolving system identifiers when both it and the expanded system identifier are available. If this property has not yet been explicitly set its value is true.

 public XMLInputSource resolveEntity(XMLResourceIdentifier resourceIdentifier) throws IOException, XNIException 

    Resolves an external entity. If the entity cannot be resolved, this method should return null. This method only calls resolveIdentifier and returns an input source if an entry was found in the catalog. It should be overridden if other behaviour is required.

 public InputSource resolveEntity(String publicId,
    String systemId) throws IOException, SAXException 

    Resolves an external entity. If the entity cannot be resolved, this method should return null. This method returns an input source if an entry was found in the catalog for the given external identifier. It should be overridden if other behaviour is required.

 public InputSource resolveEntity(String name,
    String publicId,
    String baseURI,
    String systemId) throws IOException, SAXException 

    Resolves an external entity. If the entity cannot be resolved, this method should return null. This method returns an input source if an entry was found in the catalog for the given external identifier. It should be overridden if other behaviour is required.

 public String resolveIdentifier(XMLResourceIdentifier resourceIdentifier) throws IOException, XNIException 

    Resolves an identifier using the catalog. This method interprets that the namespace of the identifier corresponds to uri entries in the catalog. Where both a namespace and an external identifier exist, the namespace takes precedence.

 public final synchronized String resolvePublic(String publicId,
    String systemId) throws IOException 

    Returns the URI mapping in the catalog for the given external identifier or null if no mapping exists. Public identifiers are normalized before comparison.

 public LSInput resolveResource(String type,
    String namespaceURI,
    String publicId,
    String systemId,
    String baseURI) 

    Resolves a resource using the catalog. This method interprets that the namespace URI corresponds to uri entries in the catalog. Where both a namespace and an external identifier exist, the namespace takes precedence.

 public final synchronized String resolveSystem(String systemId) throws IOException 

    Returns the URI mapping in the catalog for the given external identifier or null if no mapping exists. If the system identifier is an URN in the publicid namespace it is converted into a public identifier by URN "unwrapping" as specified in the XML Catalogs specification.

 public final synchronized String resolveURI(String uri) throws IOException 

    Returns the URI mapping in the catalog for the given URI reference or null if no mapping exists. URI comparison is case sensitive. If the URI reference is an URN in the publicid namespace it is converted into a public identifier by URN "unwrapping" as specified in the XML Catalogs specification and then resolution is performed following the semantics of external identifier resolution.

 public final synchronized  void setCatalogList(String[] catalogs) 

    Sets the initial list of catalog entry files. If there were any catalog mappings cached from the previous list they will be replaced by catalog mappings from the new list the next time the catalog is queried.

 public final  void setPreferPublic(boolean preferPublic) 

    Sets the preference for whether system or public matches are preferred. This is used in the absence of any occurrence of the prefer attribute on the catalog entry of a catalog.

 public final  void setUseLiteralSystemId(boolean useLiteralSystemId) 

    Sets the preference for whether the literal system identifier should be used when resolving system identifiers when both it and the expanded system identifier are available.

    The literal system identifier is the URI as it was provided before absolutization. It may be embedded within an entity. It may be provided externally or it may be the result of redirection. For example, redirection may have come from the protocol level through HTTP or from an application's entity resolver.

    The expanded system identifier is an absolute URI which is the result of resolving the literal system identifier against a base URI.