package net.sf.saxon.query;
import net.sf.saxon.trans.XPathException;
import javax.xml.transform.stream.StreamSource;
import java.io.Serializable;
/**
* This interface defines a ModuleURIResolver. This takes a module URI and a set of
* module location hints as input, and returns a StreamSource representing the text of the query,
* and containing its base URI.
* <p>
* The system supplies a StandardModuleURIResolver but this can be overridden by a user-supplied
* ModuleURIResolver.
* @author Michael H. Kay
*/
public interface ModuleURIResolver extends Serializable {
/**
* Resolve a module URI and associated location hints.
* @param moduleURI The module namespace URI of the module to be imported; or null when
* loading a non-library module.
* @param baseURI The base URI of the module containing the "import module" declaration;
* null if no base URI is known
* @param locations The set of URIs specified in the "at" clause of "import module",
* which serve as location hints for the module
* @return an array of StreamSource objects each identifying the contents of a module to be
* imported. Each StreamSource must contain a
* non-null absolute System ID which will be used as the base URI of the imported module,
* and either an InputSource or a Reader representing the text of the module. The method
* may also return null, in which case the system attempts to resolve the URI using the
* standard module URI resolver.
* @throws XPathException if the module cannot be located, and if delegation to the default
* module resolver is not required.
*/
public StreamSource[] resolve(String moduleURI, String baseURI, String[] locations) throws XPathException;
}
//
// The contents of this file are subject to the Mozilla Public License Version 1.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.mozilla.org/MPL/
//
// Software distributed under the License is distributed on an "AS IS" basis,
// WITHOUT WARRANTY OF ANY KIND, either express or implied.
// See the License for the specific language governing rights and limitations under the License.
//
// The Original Code is: all this file.
//
// The Initial Developer of the Original Code is Michael H. Kay
//
// Portions created by (your name) are Copyright (C) (your legal entity). All Rights Reserved.
//
// Contributor(s): none.
//
|