Home » xml-commons-external-1.4.01-src » javax » xml » transform » sax » [javadoc | source]

    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: TransformerHandler.java 446598 2006-09-15 12:55:40Z jeremias $
   19   
   20   package javax.xml.transform.sax;
   21   
   22   import javax.xml.transform.Result;
   23   import javax.xml.transform.Transformer;
   24   
   25   import org.xml.sax.ContentHandler;
   26   import org.xml.sax.DTDHandler;
   27   import org.xml.sax.ext.LexicalHandler;
   28   
   29   /**
   30    * A TransformerHandler
   31    * listens for SAX ContentHandler parse events and transforms
   32    * them to a Result.
   33    */
   34   public interface TransformerHandler
   35       extends ContentHandler, LexicalHandler, DTDHandler {
   36   
   37       /**
   38        * <p>Set  the <code>Result</code> associated with this
   39        * <code>TransformerHandler</code> to be used for the transformation.</p>
   40        *
   41        * @param result A <code>Result</code> instance, should not be
   42        *   <code>null</code>.
   43        *
   44        * @throws IllegalArgumentException if result is invalid for some reason.
   45        */
   46       public void setResult(Result result) throws IllegalArgumentException;
   47   
   48       /**
   49        * Set the base ID (URI or system ID) from where relative
   50        * URLs will be resolved.
   51        * @param systemID Base URI for the source tree.
   52        */
   53       public void setSystemId(String systemID);
   54   
   55       /**
   56        * Get the base ID (URI or system ID) from where relative
   57        * URLs will be resolved.
   58        * @return The systemID that was set with {@link #setSystemId}.
   59        */
   60       public String getSystemId();
   61   
   62       /**
   63        * <p>Get the <code>Transformer</code> associated with this handler, which
   64        * is needed in order to set parameters and output properties.</p>
   65        * 
   66        * @return <code>Transformer</code> associated with this
   67        *   <code>TransformerHandler</code>.
   68        */
   69       public Transformer getTransformer();
   70   }

Home » xml-commons-external-1.4.01-src » javax » xml » transform » sax » [javadoc | source]