Save This Page
Home » openjdk-7 » javax » xml » transform » sax » [javadoc | source]
    1   /*
    2    * Copyright 2000-2005 Sun Microsystems, Inc.  All Rights Reserved.
    3    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
    4    *
    5    * This code is free software; you can redistribute it and/or modify it
    6    * under the terms of the GNU General Public License version 2 only, as
    7    * published by the Free Software Foundation.  Sun designates this
    8    * particular file as subject to the "Classpath" exception as provided
    9    * by Sun in the LICENSE file that accompanied this code.
   10    *
   11    * This code is distributed in the hope that it will be useful, but WITHOUT
   12    * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
   13    * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
   14    * version 2 for more details (a copy is included in the LICENSE file that
   15    * accompanied this code).
   16    *
   17    * You should have received a copy of the GNU General Public License version
   18    * 2 along with this work; if not, write to the Free Software Foundation,
   19    * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   20    *
   21    * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
   22    * CA 95054 USA or visit www.sun.com if you need additional information or
   23    * have any questions.
   24    */
   25   
   26   package javax.xml.transform.sax;
   27   
   28   import javax.xml.transform;
   29   
   30   import org.xml.sax.ContentHandler;
   31   
   32   /**
   33    * A SAX ContentHandler that may be used to process SAX
   34    * parse events (parsing transformation instructions) into a Templates object.
   35    *
   36    * <p>Note that TemplatesHandler does not need to implement LexicalHandler.</p>
   37    */
   38   public interface TemplatesHandler extends ContentHandler {
   39   
   40       /**
   41        * When a TemplatesHandler object is used as a ContentHandler
   42        * for the parsing of transformation instructions, it creates a Templates object,
   43        * which the caller can get once the SAX events have been completed.
   44        *
   45        * @return The Templates object that was created during
   46        * the SAX event process, or null if no Templates object has
   47        * been created.
   48        *
   49        */
   50       public Templates getTemplates();
   51   
   52       /**
   53        * Set the base ID (URI or system ID) for the Templates object
   54        * created by this builder.  This must be set in order to
   55        * resolve relative URIs in the stylesheet.  This must be
   56        * called before the startDocument event.
   57        *
   58        * @param systemID Base URI for this stylesheet.
   59        */
   60       public void setSystemId(String systemID);
   61   
   62       /**
   63        * Get the base ID (URI or system ID) from where relative
   64        * URLs will be resolved.
   65        * @return The systemID that was set with {@link #setSystemId}.
   66        */
   67       public String getSystemId();
   68   }

Save This Page
Home » openjdk-7 » javax » xml » transform » sax » [javadoc | source]