Source for org.jfree.xml.writer.XmlWriteHandler

   1: /* ========================================================================
   2:  * JCommon : a free general purpose class library for the Java(tm) platform
   3:  * ========================================================================
   4:  *
   5:  * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.
   6:  * 
   7:  * Project Info:  http://www.jfree.org/jcommon/index.html
   8:  *
   9:  * This library is free software; you can redistribute it and/or modify it 
  10:  * under the terms of the GNU Lesser General Public License as published by 
  11:  * the Free Software Foundation; either version 2.1 of the License, or 
  12:  * (at your option) any later version.
  13:  *
  14:  * This library is distributed in the hope that it will be useful, but 
  15:  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
  16:  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
  17:  * License for more details.
  18:  *
  19:  * You should have received a copy of the GNU Lesser General Public
  20:  * License along with this library; if not, write to the Free Software
  21:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 
  22:  * USA.  
  23:  *
  24:  * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
  25:  * in the United States and other countries.]
  26:  * 
  27:  * --------------------
  28:  * XmlWriteHandler.java
  29:  * --------------------
  30:  * (C) Copyright 2003-2005, by Thomas Morgner and Contributors.
  31:  *
  32:  * Original Author:  Thomas Morgner;
  33:  * Contributor(s):   David Gilbert (for Object Refinery Limited);
  34:  *
  35:  * $Id: XmlWriteHandler.java,v 1.3 2005/10/18 13:35:06 mungady Exp $
  36:  *
  37:  * Changes (from 26-Nov-2003)
  38:  * --------------------------
  39:  * 26-Nov-2003 : Added standard header and Javadocs (DG);
  40:  *
  41:  */
  42: 
  43: package org.jfree.xml.writer;
  44: 
  45: import java.io.IOException;
  46: 
  47: /**
  48:  * The interface that must be supported by all XML write handlers.
  49:  */
  50: public interface XmlWriteHandler {
  51: 
  52:     /**
  53:      * Returns the root handler for this write handler. The root handler
  54:      * will be used to resolve the child handlers.
  55:      * 
  56:      * @return the root handler.
  57:      */
  58:     public RootXmlWriteHandler getRootHandler();
  59: 
  60:     /**
  61:      * Sets the root handler.
  62:      * 
  63:      * @param rootHandler  the root handler.
  64:      */
  65:     public void setRootHandler(RootXmlWriteHandler rootHandler);
  66: 
  67:     /**
  68:      * Performs the writing of a single object.
  69:      *
  70:      * @param tagName  the tag name for the generated xml element.
  71:      * @param object  the object to be written.
  72:      * @param writer  the writer.
  73:      * @param mPlexAttribute  the multiplexer selector attribute name.
  74:      * @param mPlexValue the multiplexers attribute value corresponding to this
  75:      * object type.
  76:      * 
  77:      * @throws IOException if an IOError occured.
  78:      * @throws XMLWriterException if an XmlDefinition error occured.
  79:      */
  80:     public void write(String tagName, Object object, XMLWriter writer,
  81:                       String mPlexAttribute, String mPlexValue)
  82:         throws IOException, XMLWriterException;
  83: 
  84: }