1   /*
    2    * Licensed to the Apache Software Foundation (ASF) under one or more
    3    * contributor license agreements.  See the NOTICE file distributed with
    4    * this work for additional information regarding copyright ownership.
    5    * The ASF licenses this file to You under the Apache License, Version 2.0
    6    * (the "License"); you may not use this file except in compliance with
    7    * the License.  You may obtain a copy of the License at
    8    *
    9    *     http://www.apache.org/licenses/LICENSE-2.0
   10    *
   11    * Unless required by applicable law or agreed to in writing, software
   12    * distributed under the License is distributed on an "AS IS" BASIS,
   13    * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   14    * See the License for the specific language governing permissions and
   15    * limitations under the License.
   16    */
   17   
   18   // $Id: TemplatesHandler.java 446598 2006-09-15 12:55:40Z jeremias $
   19   
   20   package javax.xml.transform.sax;
   21   
   22   import javax.xml.transform;
   23   
   24   import org.xml.sax.ContentHandler;
   25   
   26   /**
   27    * A SAX ContentHandler that may be used to process SAX
   28    * parse events (parsing transformation instructions) into a Templates object.
   29    *
   30    * <p>Note that TemplatesHandler does not need to implement LexicalHandler.</p>
   31    */
   32   public interface TemplatesHandler extends ContentHandler {
   33   
   34       /**
   35        * When a TemplatesHandler object is used as a ContentHandler
   36        * for the parsing of transformation instructions, it creates a Templates object,
   37        * which the caller can get once the SAX events have been completed.
   38        *
   39        * @return The Templates object that was created during
   40        * the SAX event process, or null if no Templates object has
   41        * been created.
   42        *
   43        */
   44       public Templates getTemplates();
   45   
   46       /**
   47        * Set the base ID (URI or system ID) for the Templates object
   48        * created by this builder.  This must be set in order to
   49        * resolve relative URIs in the stylesheet.  This must be
   50        * called before the startDocument event.
   51        *
   52        * @param systemID Base URI for this stylesheet.
   53        */
   54       public void setSystemId(String systemID);
   55   
   56       /**
   57        * Get the base ID (URI or system ID) from where relative
   58        * URLs will be resolved.
   59        * @return The systemID that was set with {@link #setSystemId}.
   60        */
   61       public String getSystemId();
   62   }