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