/* * $Id: Transformer.java,v 1.2 2003/12/02 21:38:02 dalibor Exp $ * Copyright (C) 2001 Andrew Selkirk * Copyright (C) 2001 David Brownell * * This file is part of GNU JAXP, a library. * * GNU JAXP is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * GNU JAXP is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA * * As a special exception, if you link this library with other files to * produce an executable, this library does not by itself cause the * resulting executable to be covered by the GNU General Public License. * This exception does not however invalidate any other reasons why the * executable file might be covered by the GNU General Public License. */ package javax.xml.transform; // Imports import java.util.Properties; /** * Apply a transformation from a source, populating a result. * Transformers may be reused, but not concurrently. * * @author Andrew Selkirk, David Brownell * @version 1.0 */ public abstract class Transformer { //------------------------------------------------------------- // Initialization --------------------------------------------- //------------------------------------------------------------- /** Default constructor, for use only by subclasses. */ protected Transformer() { } // Transformer() //------------------------------------------------------------- // Methods ---------------------------------------------------- //------------------------------------------------------------- /** * Clears all parameter settings. * @see #setParameter */ public abstract void clearParameters(); /** Returns the error handler used as documents are transformed. */ public abstract ErrorListener getErrorListener(); /** * Returns a copy of the transformer's non-default output properties. * That is, properties set in the stylesheet or through * methods on this class are not set. * @see OutputKeys * @see #setOutputProperties */ public abstract Properties getOutputProperties(); /** * Returns the value of a property applying to this transform. * Values returned by this method are only those that have * been set explicitly. * @see OutputKeys * @see #setOutputProperty */ public abstract String getOutputProperty(String name) throws IllegalArgumentException; /** * Returns the value of a parameter passed to this transform. * These are primarily for use access within transformations * and extensions. * @see #setParameter */ public abstract Object getParameter(String name); /** Returns the resolver applied to documents being transformed. */ public abstract URIResolver getURIResolver(); /** Assigns the error handler used as documents are transformed. */ public abstract void setErrorListener(ErrorListener listener) throws IllegalArgumentException; /** * Assigns a set of output properties, as if made by multiple * calls to {@link #setOutputProperty}. * @see OutputKeys * @param outputformat set of properties, or null to reset all * properties to their default values */ public abstract void setOutputProperties(Properties outputformat) throws IllegalArgumentException; /** * Assigns the value of a transformation property, affecting * generation of output (mostly text syntax). Parameters include * those defined by the xslt:output element. Default settings may * be explicitly overridden. * @see OutputKeys * @see #getOutputProperty * @see #setOutputProperties * @param name an XML name, or a namespace-scoped XML name * encoded as {uri}localName. * @param value associated with the name */ public abstract void setOutputProperty(String name, String value) throws IllegalArgumentException; /** * Assigns the value of a parameter passed to this transform. * These are primarily for use access within transformations * and extensions. * @see #getParameter * @see #clearParameters * @param name an XML name, or a namespace-scoped XML name * encoded as {uri}localName. * @param value associated with the name */ public abstract void setParameter(String name, Object value); /** Assigns the resolver applied to documents being transformed. */ public abstract void setURIResolver(URIResolver resolver); /** Apply the appropriate transformation */ public abstract void transform(Source source, Result result) throws TransformerException; } // Transformer
