001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one
003     * or more contributor license agreements. See the NOTICE file
004     * distributed with this work for additional information
005     * regarding copyright ownership. The ASF licenses this file
006     * to you under the Apache License, Version 2.0 (the  "License");
007     * you may not use this file except in compliance with the License.
008     * You may obtain a copy of the License at
009     *
010     *     http://www.apache.org/licenses/LICENSE-2.0
011     *
012     * Unless required by applicable law or agreed to in writing, software
013     * distributed under the License is distributed on an "AS IS" BASIS,
014     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015     * See the License for the specific language governing permissions and
016     * limitations under the License.
017     */
018    /*
019     * $Id: DOMCache.java 468648 2006-10-28 07:00:06Z minchau $
020     */
021    
022    package org.apache.xalan.xsltc;
023    
024    
025    /**
026     * @author Morten Jorgensen
027     */
028    public interface DOMCache {
029    
030        /**
031         * This method is responsible for:
032         *
033         * (1) building the DOMImpl tree
034         *
035         *      Parser  _parser = new Parser();
036         *      DOMImpl _dom = new DOMImpl();
037         *      _parser.setDocumentHandler(_dom.getBuilder());
038         *      _parser.setDTDHandler(_dom.getBuilder());
039         *      _parser.parse(uri);
040         *
041         * (2) giving the translet an early opportunity to extract anything from
042         *     the DOMImpl that it would like
043         *
044         *      translet.documentPrepass(_dom);
045         *
046         * (3) setting the document URI:
047         *
048         *      _dom.setDocumentURI(uri);
049         * 
050         * @param baseURI The base URI used by the document call.
051         * @param href The href argument passed to the document function.
052         * @param translet A reference to the translet requesting the document
053         */
054        public DOM retrieveDocument(String baseURI, String href, Translet translet);
055    
056    }