groupfactory.java

Java的Web报表库

/**
 * ========================================
 * 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.
 *
 * -----------------
 * GroupFactory.java
 * -----------------
 * (C)opyright 2002, 2003, by Thomas Morgner and Contributors.
 *
 * Original Author:  Thomas Morgner;
 * Contributor(s):   David Gilbert (for Simba Management Limited);
 *
 * $Id: GroupFactory.java,v 1.18.2.1 2003/08/24 14:18:10 taqua Exp $
 *
 * Changes
 * -------
 * 10-May-2002 : Initial version
 * 10-Dec-2002 : Fixed errors reported by Checkstyle (DG);
 *
 */

package com.jrefinery.report.io.simple;

import com.jrefinery.report.Group;
import com.jrefinery.report.GroupFooter;
import com.jrefinery.report.GroupHeader;
import com.jrefinery.report.io.ReportParserUtil;
import com.jrefinery.report.targets.style.BandStyleSheet;
import com.jrefinery.report.targets.style.ElementStyleSheet;
import com.jrefinery.report.util.CharacterEntityParser;
import org.jfree.ui.FloatDimension;
import org.jfree.xml.ParseException;
import org.jfree.xml.Parser;
import org.jfree.xml.ParserUtil;
import org.xml.sax.Attributes;
import org.xml.sax.SAXException;

/**
 * This class is a SAX handler for reading groups from a report template file.
 *
 * @author Thomas Morgner
 */
public class GroupFactory extends AbstractReportDefinitionHandler implements ReportDefinitionTags
{
  /** The group under constructiom. */
  private Group currentGroup;

  /** The current text. */
  private StringBuffer currentText;

  /** A font handler. */
  private FontFactory fontFactory;

  /** A character entity parser. */
  private CharacterEntityParser entityParser;

  /**
   * Creates a new handler.
   *
   * @param parser the used parser to coordinate the parsing process.
   * @param finishTag the finish tag, that should trigger the deactivation of this parser.
   * @throws NullPointerException if the finishTag or the parser are null.
   */
  public GroupFactory(final Parser parser, final String finishTag)
  {
    super(parser, finishTag);
    fontFactory = new FontFactory();
    entityParser = CharacterEntityParser.createXMLEntityParser();
  }

  /**
   * Starts an element.
   *
   * @param qName  the element name.
   * @param atts  the element attributes.
   *
   * @throws SAXException if there is a problem parsing the XML.
   */
  public void startElement(final String qName,
                           final Attributes atts) throws SAXException
  {
    final String elementName = qName.toLowerCase().trim();

    // *** GROUP HEADER ***
    if (elementName.equals(GROUP_HEADER_TAG))
    {
      startGroupHeader(atts);
    }
    // *** GROUP FOOTER ***
    else if (elementName.equals(GROUP_FOOTER_TAG))
    {
      startGroupFooter(atts);
    }
    else if (elementName.equals(FIELDS_TAG))
    {
      startFields(atts);
    }
    else if (elementName.equals(FIELD_TAG))
    {
      startField(atts);
    }
    else if (elementName.equals(GROUP_TAG))
    {
      startGroup(atts);
    }
    else
    {
      throw new SAXException("Expected one of: group, groupfooter, groutheader, fields, field. -> "
          + qName);
    }
  }

  /**
   * Starts the fields element.
   *
   * @param atts  the element attributes.
   *
   * @throws SAXException if there is a problem parsing the report template.
   */
  protected void startFields(final Attributes atts)
      throws SAXException
  {
  }

  /**
   * Starts the field element.
   *
   * @param atts  the element attributes.
   *
   * @throws SAXException if there is a problem parsing the report template.
   */
  protected void startField(final Attributes atts)
      throws SAXException
  {
    currentText = new StringBuffer();
  }

  /**
   * Starts the group element.
   *
   * @param atts  the element attributes.
   *
   * @throws SAXException if there is a problem parsing the report template.
   */
  protected void startGroup(final Attributes atts)
      throws SAXException
  {
    final Group group = new Group();
    group.setName(getNameGenerator().generateName(atts.getValue("name")));
    setCurrentGroup(group);
  }

  /**
   * Starts the group header element.
   *
   * @param atts  the element attributes.
   *
   * @throws SAXException if there is a problem parsing the report template.
   */
  protected void startGroupHeader(final Attributes atts)
      throws SAXException

  {
    // get the height...
    final float height = ParserUtil.parseFloat(atts.getValue("height"), 0);
    final boolean pageBreak = ParserUtil.parseBoolean
        (atts.getValue("pagebreak"),
            ParserUtil.parseBoolean(atts.getValue("pagebreak-before-print"), false));
    final boolean pageBreakAfter = ParserUtil.parseBoolean
        (atts.getValue("pagebreak-after-print"), false);
    final boolean repeat = ParserUtil.parseBoolean(atts.getValue(REPEAT_HEADER), false);
    // create the group header...
    final GroupHeader groupHeader = new GroupHeader();
    groupHeader.getStyle().setStyleProperty(ElementStyleSheet.MINIMUMSIZE,
        new FloatDimension(0, height));
    groupHeader.getStyle().setBooleanStyleProperty
        (BandStyleSheet.PAGEBREAK_BEFORE, pageBreak);
    groupHeader.getStyle().setBooleanStyleProperty
        (BandStyleSheet.PAGEBREAK_AFTER, pageBreakAfter);
    groupHeader.getStyle().setBooleanStyleProperty
        (BandStyleSheet.REPEAT_HEADER, repeat);

    final FontFactory.FontInformation fi = fontFactory.createFont(atts);
    FontFactory.applyFontInformation(groupHeader.getStyle(), fi);
    FontFactory.applyFontInformation(groupHeader.getBandDefaults(), fi);

    final String valign = atts.getValue(VALIGNMENT_ATT);
    if (valign != null)
    {
      groupHeader.getBandDefaults().setStyleProperty(ElementStyleSheet.VALIGNMENT,
          ReportParserUtil.parseVerticalElementAlignment(valign));
    }
    final String halign = atts.getValue(ALIGNMENT_ATT);
    if (halign != null)
    {
      groupHeader.getBandDefaults().setStyleProperty(ElementStyleSheet.ALIGNMENT,
          ReportParserUtil.parseHorizontalElementAlignment(halign));
    }

    currentGroup.setHeader(groupHeader);
    getParser().pushFactory(new ElementFactory(getParser(), GROUP_HEADER_TAG, groupHeader));
  }

  /**
   * Starts the group footer element.
   *
   * @param atts  the element attributes.
   *
   * @throws SAXException if there is a problem parsing the report template.
   */
  protected void startGroupFooter(final Attributes atts) throws SAXException
  {
    final boolean pageBreak = ParserUtil.parseBoolean(atts.getValue("pagebreak"),
        ParserUtil.parseBoolean(atts.getValue("pagebreak-before-print"), false));
    final boolean pageBreakAfter = ParserUtil.parseBoolean
        (atts.getValue("pagebreak-after-print"), false);

    // get the height...
    final float height = ParserUtil.parseFloat(atts.getValue("height"), 0);

    // get the default font...
    // create the group footer...
    final GroupFooter groupFooter = new GroupFooter();
    groupFooter.getStyle().setStyleProperty(ElementStyleSheet.MINIMUMSIZE,
        new FloatDimension(0, height));
    groupFooter.getStyle().setBooleanStyleProperty
        (BandStyleSheet.PAGEBREAK_BEFORE, pageBreak);
    groupFooter.getStyle().setBooleanStyleProperty
        (BandStyleSheet.PAGEBREAK_AFTER, pageBreakAfter);

    final FontFactory.FontInformation fi = fontFactory.createFont(atts);
    FontFactory.applyFontInformation(groupFooter.getStyle(), fi);
    FontFactory.applyFontInformation(groupFooter.getBandDefaults(), fi);

    final String valign = atts.getValue(VALIGNMENT_ATT);
    if (valign != null)
    {
      groupFooter.getBandDefaults().setStyleProperty(ElementStyleSheet.VALIGNMENT,
          ReportParserUtil.parseVerticalElementAlignment(valign));
    }
    final String halign = atts.getValue(ALIGNMENT_ATT);
    if (halign != null)
    {
      groupFooter.getBandDefaults().setStyleProperty(ElementStyleSheet.ALIGNMENT,
          ReportParserUtil.parseHorizontalElementAlignment(halign));
    }

    currentGroup.setFooter(groupFooter);
    getParser().pushFactory(new ElementFactory(getParser(), GROUP_FOOTER_TAG, groupFooter));
  }

  /**
   * Receives some (or all) of the text in the current element.
   *
   * @param ch  storage space for the characters.
   * @param start  the first valid character in the array.
   * @param length  the length of the valid data in the array.
   */
  public void characters(final char[] ch, final int start, final int length)
  {
    if (currentText != null)
    {
      this.currentText.append(String.copyValueOf(ch, start, length));
    }
  }

  /**
   * Ends an element.
   *
   * @param qName  the element name.
   *
   * @throws SAXException if there is a problem parsing the XML.
   */
  public void endElement(final String qName)
      throws SAXException
  {
    final String elementName = qName.toLowerCase().trim();
    // *** GROUP HEADER ***
    if (elementName.equals(GROUP_HEADER_TAG))
    {
      endGroupHeader();
    }
    // *** GROUP FOOTER ***
    else if (elementName.equals(GROUP_FOOTER_TAG))
    {
      endGroupFooter();
    }
    else if (elementName.equals(FIELDS_TAG))
    {
      endFields();
    }
    else if (elementName.equals(GROUP_TAG))
    {
      endGroup();
    }
    else if (elementName.equals(FIELD_TAG))
    {
      endField();
    }
    else if (elementName.equals(GROUPS_TAG))
    {
      endGroups();
    }
    else if (elementName.equals(getFinishTag()))
    {
      getParser().popFactory().endElement(qName);
    }
    else
    {
      throw new SAXException("Expected one of: group, groupfooter, groutheader, fields, "
          + "field - but found " + elementName);
    }
  }

  /**
   * Ends the groups element.
   *
   * @throws SAXException if there is a problem parsing the report template.
   */
  protected void endGroups()
      throws SAXException
  {
    getParser().popFactory().endElement(GROUPS_TAG);
  }

  /**
   * Ends the group element.
   *
   * @throws SAXException if there is a problem parsing the report template.
   */
  protected void endGroup()
      throws SAXException
  {
    getReport().addGroup(currentGroup);
    setCurrentGroup(null);
  }

  /**
   * Ends the field element.
   *
   * @throws SAXException if there is a problem parsing the report template.
   */
  protected void endField()
      throws SAXException
  {
    this.currentGroup.addField(entityParser.decodeEntities(currentText.toString()));
    currentText = null;
  }

  /**
   * Ends the fields element.
   *
   * @throws SAXException if there is a problem parsing the report template.
   */
  protected void endFields()
      throws SAXException
  {
  }

  /**
   * Ends the group footer element.
   *
   * @throws SAXException if there is a problem parsing the report template.
   */
  protected void endGroupFooter()
      throws SAXException
  {
  }

  /**
   * Ends the group header element.
   *
   * @throws SAXException if there is a problem parsing the report template.
   */
  protected void endGroupHeader()
      throws SAXException
  {
  }

  /**
   * Sets the current group.
   *
   * @param currentGroup the current group.
   *
   * @throws SAXException if there is a problem parsing the report template.
   */
  public void setCurrentGroup(final Group currentGroup)
      throws SAXException
  {
    if (currentGroup == null && this.currentGroup == null)
    {
      throw new ParseException("Band end before band start?", getLocator());
    }
    if (currentGroup != null && this.currentGroup != null)
    {
      throw new ParseException("Unable to stack a band into an other band", getLocator());
    }

    this.currentGroup = currentGroup;
  }
}