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