mrglavas 2004/04/24 20:25:07 Added: java/src/org/apache/xerces/util EntityResolver2Wrapper.java Log: A new XNI entity resolver for wrapping SAX2 Extensions 1.1's
EntityResolver2. Using an EntityResolver2 like interface until the real one is available. Revision Changes Path 1.1 xml-xerces/java/src/org/apache/xerces/util/EntityResolver2Wrapper.java Index: EntityResolver2Wrapper.java =================================================================== /* * Copyright 2004 The Apache Software Foundation. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package org.apache.xerces.util; import java.io.InputStream; import java.io.IOException; import java.io.Reader; import org.apache.xerces.impl.ExternalSubsetResolver; import org.apache.xerces.impl.XMLEntityDescription; import org.apache.xerces.xni.XMLResourceIdentifier; import org.apache.xerces.xni.XNIException; import org.apache.xerces.xni.grammars.XMLDTDDescription; import org.apache.xerces.xni.parser.XMLInputSource; import org.xml.sax.EntityResolver; import org.xml.sax.InputSource; import org.xml.sax.SAXException; /** * <p>This class wraps a SAX EntityResolver2 in an XNI entity resolver.</p> * * @author Michael Glavassevich, IBM * * @version $Id: EntityResolver2Wrapper.java,v 1.1 2004/04/25 03:25:07 mrglavas Exp $ */ public class EntityResolver2Wrapper implements ExternalSubsetResolver { // // Data // /** The SAX entity resolver (EntityResolver2). */ protected EntityResolver2 fEntityResolver; // // Constructors // /** Default constructor. */ public EntityResolver2Wrapper() {} /** Wraps the specified SAX entity resolver. */ public EntityResolver2Wrapper(EntityResolver2 entityResolver) { setEntityResolver(entityResolver); } // <init>(EntityResolver2) // // Public methods // /** Sets the SAX entity resolver (EntityResolver2). */ public void setEntityResolver(EntityResolver2 entityResolver) { fEntityResolver = entityResolver; } // setEntityResolver(EntityResolver2) /** Returns the SAX entity resolver (EntityResolver2). */ public EntityResolver2 getEntityResolver() { return fEntityResolver; } // getEntityResolver():EntityResolver2 // // ExternalSubsetResolver methods // /** * <p>Locates an external subset for documents which do not explicitly * provide one. If no external subset is provided, this method should * return <code>null</code>.</p> * * @param grammarDescription a description of the DTD * * @throws XNIException Thrown on general error. * @throws IOException Thrown if resolved entity stream cannot be * opened or some other i/o error occurs. */ public XMLInputSource getExternalSubset(XMLDTDDescription grammarDescription) throws XNIException, IOException { if (fEntityResolver != null) { String name = grammarDescription.getRootName(); String baseURI = grammarDescription.getBaseSystemId(); // Resolve using EntityResolver2 try { InputSource inputSource = fEntityResolver.getExternalSubset(name, baseURI); return (inputSource != null) ? createXMLInputSource(inputSource, baseURI) : null; } // error resolving external subset catch (SAXException e) { Exception ex = e.getException(); if (ex == null) { ex = e; } throw new XNIException(ex); } } // unable to resolve external subset return null; } // getExternalSubset(XMLDTDDescription):XMLInputSource // // XMLEntityResolver methods // /** * Resolves an external parsed entity. If the entity cannot be * resolved, this method should return null. * * @param resourceIdentifier contains the physical co-ordinates of the resource to be resolved * * @throws XNIException Thrown on general error. * @throws IOException Thrown if resolved entity stream cannot be * opened or some other i/o error occurs. */ public XMLInputSource resolveEntity(XMLResourceIdentifier resourceIdentifier) throws XNIException, IOException { if (fEntityResolver != null) { String pubId = resourceIdentifier.getPublicId(); String sysId = resourceIdentifier.getExpandedSystemId(); String baseURI = resourceIdentifier.getBaseSystemId(); String name = null; if (resourceIdentifier instanceof XMLDTDDescription) { name = "[dtd]"; } else if (resourceIdentifier instanceof XMLEntityDescription) { name = ((XMLEntityDescription) resourceIdentifier).getEntityName(); } // When all of the parameters are null, the user's entity resolver // can do nothing about it. We'd better not bother calling it. // This happens when the resourceIdentifier is a GrammarDescription, // which describes a schema grammar of some namespace, but without // any schema location hint. -Sg if (pubId == null && sysId == null && baseURI == null && name == null) { return null; } // Resolve using EntityResolver2 try { InputSource inputSource = fEntityResolver.resolveEntity(name, pubId, baseURI, sysId); return (inputSource != null) ? createXMLInputSource(inputSource, baseURI) : null; } // error resolving entity catch (SAXException e) { Exception ex = e.getException(); if (ex == null) { ex = e; } throw new XNIException(ex); } } // unable to resolve entity return null; } // resolveEntity(XMLResourceIdentifier):XMLInputSource /** * Creates an XMLInputSource from a SAX InputSource. */ private XMLInputSource createXMLInputSource(InputSource source, String baseURI) { String publicId = source.getPublicId(); String systemId = source.getSystemId(); String baseSystemId = baseURI; InputStream byteStream = source.getByteStream(); Reader charStream = source.getCharacterStream(); String encoding = source.getEncoding(); XMLInputSource xmlInputSource = new XMLInputSource(publicId, systemId, baseSystemId); xmlInputSource.setByteStream(byteStream); xmlInputSource.setCharacterStream(charStream); xmlInputSource.setEncoding(encoding); return xmlInputSource; } // createXMLInputSource(InputSource,String):XMLInputSource // TODO: Remove temporary EntityResolver2 interface when // the real one becomes available. /** * <p>EntityResolver2 like interface to be removed once * the real interface (org.xml.sax.ext.EntityResolver2) is available.</p> * * @author Michael Glavassevich, IBM * * @version $Id: EntityResolver2Wrapper.java,v 1.1 2004/04/25 03:25:07 mrglavas Exp $ */ public interface EntityResolver2 extends EntityResolver { public InputSource getExternalSubset(String name, String baseURI) throws SAXException, IOException; public InputSource resolveEntity(String name, String publicId, String baseURI, String systemId) throws SAXException, IOException; } } --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
