templatehandler.java

来自「swing编写的库存管理程序。毕业设计类」· Java 代码 · 共 244 行

/**
 * ========================================
 * JFreeReport : a free Java report library
 * ========================================
 *
 * Project Info:  http://www.jfree.org/jfreereport/index.html
 * Project Lead:  Thomas Morgner;
 *
 * (C) Copyright 2000-2003, by Simba Management Limited and Contributors.
 *
 * This library is free software; you can redistribute it and/or modify it under the terms
 * of the GNU Lesser General Public License as published by the Free Software Foundation;
 * either version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License along with this
 * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 * --------------------
 * TemplateHandler.java
 * --------------------
 * (C)opyright 2003, by Thomas Morgner and Contributors.
 *
 * Original Author:  Thomas Morgner;
 * Contributor(s):   David Gilbert (for Simba Management Limited);
 *
 * $Id: TemplateHandler.java,v 1.7 2003/08/25 14:29:32 taqua Exp $
 *
 * Changes
 * -------
 * 21-Feb-2003 : Added standard header and Javadocs (DG);
 *
 */

package org.jfree.report.modules.parser.ext;

import org.jfree.report.modules.parser.base.CommentHandler;
import org.jfree.report.modules.parser.base.CommentHintPath;
import org.jfree.report.modules.parser.base.ReportParser;
import org.jfree.report.modules.parser.ext.factory.templates.TemplateDescription;
import org.jfree.xml.ParseException;
import org.jfree.xml.factory.objects.ObjectDescription;
import org.xml.sax.Attributes;
import org.xml.sax.SAXException;

/**
 * A template handler. A template is a predefined usecase for some DataSources.
 *
 * @see org.jfree.report.filter.templates.Template
 * @author Thomas Morgner.
 */
public class TemplateHandler extends AbstractExtReportParserHandler
{
  /** The compound object tag. */
  public static final String COMPOUND_OBJECT_TAG = "compound-object";

  /** The basic object tag. */
  public static final String BASIC_OBJECT_TAG = "basic-object";

  /** A basic object handler. */
  private BasicObjectHandler basicFactory;

  /** The parameter name. */
  private String parameterName;

  /** The template description. */
  private TemplateDescription template;

  /**
   * The comment hint path is used to store xml comments in the
   * report builder hints collection.
   */
  private CommentHintPath commentPath;

  /**
   * Creates a new template handler. The handler will be deactivated when the
   * finishTag was reached on endElement.
   *
   * @param parser  the parser.
   * @param finishTag  the finish tag.
   * @param template  the template description.
   * @param path the path on where to search for ext-parser comments
   * in the report builder hints.
   */
  public TemplateHandler(final ReportParser parser, final String finishTag,
                         final TemplateDescription template, final CommentHintPath path)
  {
    super(parser, finishTag);
    if (template == null)
    {
      throw new NullPointerException("Template is null");
    }

    this.template = template;
    this.commentPath = path.getInstance();
  }

  /**
   * Callback to indicate that an XML element start tag has been read by the parser.
   *
   * @param tagName  the tag name.
   * @param attrs  the attributes.
   *
   * @throws SAXException if a parser error occurs or the validation failed.
   */
  public void startElement(final String tagName, final Attributes attrs) throws SAXException
  {
    if (tagName.equals(BASIC_OBJECT_TAG))
    {
      parameterName = attrs.getValue("name");
      if (parameterName == null)
      {
        throw new ParseException("Attribute 'name' is missing.", getParser().getLocator());
      }
      final ObjectDescription od = getTemplate();
      Class parameter = od.getParameterDefinition(parameterName);
      if (parameter == null)
      {
        throw new ParseException("No such parameter '" + parameterName + "' in template. ",
            getParser().getLocator());
      }
      final String overrideClassName = attrs.getValue("class");
      if (overrideClassName != null)
      {
        try
        {
          parameter = getClass().getClassLoader().loadClass(overrideClassName);
        }
        catch (Exception e)
        {
          throw new ParseException("Attribute 'class' is invalid.", e, getParser().getLocator());
        }
      }

      final CommentHintPath path = commentPath.getInstance();
      path.addName(parameterName);
      addComment(path, CommentHandler.OPEN_TAG_COMMENT);
      basicFactory = new BasicObjectHandler(getReportParser(), tagName, parameter, path);
      getParser().pushFactory(basicFactory);
    }
    else if (tagName.equals(COMPOUND_OBJECT_TAG))
    {
      parameterName = attrs.getValue("name");
      if (parameterName == null)
      {
        throw new ParseException("Attribute 'name' is missing.", getParser().getLocator());
      }
      final ObjectDescription od = getTemplate();
      Class parameter = od.getParameterDefinition(parameterName);
      if (parameter == null)
      {
        throw new ParseException("No such parameter: " + parameterName, getParser().getLocator());
      }
      final String overrideClassName = attrs.getValue("class");
      if (overrideClassName != null)
      {
        try
        {
          parameter = getClass().getClassLoader().loadClass(overrideClassName);
        }
        catch (Exception e)
        {
          throw new ParseException("Attribute 'class' is invalid.", e, getParser().getLocator());
        }
      }

      final CommentHintPath path = commentPath.getInstance();
      path.addName(parameterName);
      addComment(path, CommentHandler.OPEN_TAG_COMMENT);
      basicFactory = new CompoundObjectHandler(getReportParser(), tagName, parameter, path);
      getParser().pushFactory(basicFactory);
    }
    else
    {
      throw new SAXException("Invalid TagName: " + tagName + ", expected one of: "
          + COMPOUND_OBJECT_TAG + ", " + BASIC_OBJECT_TAG + ". ");
    }
  }

  /**
   * Callback to indicate that some character data has been read.
   *
   * @param ch  the character array.
   * @param start  the start index for the characters.
   * @param length  the length of the character sequence.
   *
   * @throws SAXException if a parser error occurs or the validation failed.
   */
  public void characters(final char[] ch, final int start, final int length) throws SAXException
  {
    // ignore ...
  }

  /**
   * Callback to indicate that an XML element end tag has been read by the parser.
   *
   * @param tagName  the tag name.
   *
   * @throws SAXException if a parser error occurs or the validation failed.
   */
  public void endElement(final String tagName) throws SAXException
  {
    if ((tagName.equals(BASIC_OBJECT_TAG))
        || (tagName.equals(COMPOUND_OBJECT_TAG)))
    {
      final Object o = basicFactory.getValue();
      if (o == null)
      {
        throw new ParseException("Parameter value is null", getParser().getLocator());
      }
      getTemplate().setParameter(parameterName, o);
      final CommentHintPath path = commentPath.getInstance();
      path.addName(parameterName);
      addComment(path, CommentHandler.CLOSE_TAG_COMMENT);
      basicFactory = null;
    }
    else if (tagName.equals(getFinishTag()))
    {
      getParser().popFactory().endElement(tagName);
    }
    else
    {
      throw new SAXException("Invalid TagName: " + tagName + ", expected one of: "
          + getFinishTag() + ", "
          + COMPOUND_OBJECT_TAG + ", "
          + BASIC_OBJECT_TAG + ". ");
    }
  }

  /**
   * Returns the template description.
   *
   * @return The template description.
   */
  public TemplateDescription getTemplate()
  {
    return template;
  }
}