1/*
2 * reserved comment block
3 * DO NOT REMOVE OR ALTER!
4 */
5/*
6 * Licensed to the Apache Software Foundation (ASF) under one or more
7 * contributor license agreements.  See the NOTICE file distributed with
8 * this work for additional information regarding copyright ownership.
9 * The ASF licenses this file to You under the Apache License, Version 2.0
10 * (the "License"); you may not use this file except in compliance with
11 * the License.  You may obtain a copy of the License at
12 *
13 *      http://www.apache.org/licenses/LICENSE-2.0
14 *
15 * Unless required by applicable law or agreed to in writing, software
16 * distributed under the License is distributed on an "AS IS" BASIS,
17 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 * See the License for the specific language governing permissions and
19 * limitations under the License.
20 */
21
22package com.sun.org.apache.xalan.internal.xsltc;
23
24
25/**
26 * @author Morten Jorgensen
27 */
28public interface DOMCache {
29
30    /**
31     * This method is responsible for:
32     *
33     * (1) building the DOMImpl tree
34     *
35     *      Parser  _parser = new Parser();
36     *      DOMImpl _dom = new DOMImpl();
37     *      _parser.setDocumentHandler(_dom.getBuilder());
38     *      _parser.setDTDHandler(_dom.getBuilder());
39     *      _parser.parse(uri);
40     *
41     * (2) giving the translet an early opportunity to extract anything from
42     *     the DOMImpl that it would like
43     *
44     *      translet.documentPrepass(_dom);
45     *
46     * (3) setting the document URI:
47     *
48     *      _dom.setDocumentURI(uri);
49     *
50     * @param baseURI The base URI used by the document call.
51     * @param href The href argument passed to the document function.
52     * @param translet A reference to the translet requesting the document
53     */
54    public DOM retrieveDocument(String baseURI, String href, Translet translet);
55
56}
57