root/src/jomdoc/trunk/src/jomdoc/org/omdoc/jomdoc/util/resolver/JOMDocURIResolver.java

/*
 * JOMDoc - A Java library for OMDoc documents (http://omdoc.org/jomdoc).
 *
 * Original author    Dimitar Misev <d.misev@jacobs-university.de>
 * Web                http://kwarc.info/dmisev/
 * Created            Feb 4, 2010, 10:40:40 AM
 *
 * Filename           $Id$
 * Revision           $Revision$
 * Last modified on   $Date$
 *               by   $Author$
 *
 * Copyright (C) 2007,2008 the KWARC group (http://kwarc.info)
 * Licensed under the GNU Public License v3 (GPL3).
 * For other licensing contact Michael Kohlhase <m.kohlhase@jacobs-university.de>
 */
package org.omdoc.jomdoc.util.resolver;

import java.io.InputStream;
import java.net.URI;
import javax.xml.transform.URIResolver;
import nu.xom.Document;
import nu.xom.Element;
import org.omdoc.jomdoc.lang.OMDocDocument;
import org.omdoc.jomdoc.lang.OMDocElement;
import org.omdoc.jomdoc.util.types.Pair;
import org.w3c.dom.ls.LSResourceResolver;

/**
 * Throughout JOMDoc this interface is used to resolve URIs.
 * <p>
 * {@link LSResourceResolver} is used in RelaxNG schema validation of OMDoc
 * Documents, while {@link URIResolver} is used in the XSLT transformation.
 *
 * @author <a href="mailto:d.misev@jacobs-university.de">Dimitar Misev</a>
 */
public interface JOMDocURIResolver extends URIResolver, LSResourceResolver {

    /**
     * @return a pair (A, B) where A is InputStream to location <code>href</code>
     * with respect to <code>base</code>, and B is the absolute URI to A.
     */
    Pair<? extends InputStream, URI> resolveInputStream(String href, String base) throws ResolveException;

    /**
     * @return the content at location <code>href</code> with respect to <code>base</code>
     * as XOM Document.
     */
    Document resolveDocument(String href, String base) throws ResolveException;

    /**
     * @return the content at location <code>href</code> with respect to <code>base</code>
     * as XOM Element.
     */
    Element resolveElement(String href, String base) throws ResolveException;

    /**
     * @return the content at location <code>href</code> with respect to <code>base</code>
     * as OMDocDocument.
     */
    OMDocDocument resolveOMDocDocument(String href, String base) throws ResolveException;

    /**
     * @return the content at location <code>href</code> with respect to <code>base</code>
     * as OMDocElement.
     */
    OMDocElement resolveOMDocElement(String href, String base) throws ResolveException;

    /**
     * @return true if the the schema in the given <code>uri</code> is supported
     * by this resolver, false if it's not or the uri doesn't have a schema part.
     */
    boolean isSchemaSupported(String uri);

    /**
     * @return true if the the schema in the given <code>uri</code> is supported
     * by this resolver, false if it's not or the uri doesn't have a schema part.
     */
    boolean isSchemaSupported(String href, String base, boolean log);
}