AbstractElementReadHandler.java example

Explorer
pentaho-reporting-master
/*
 * This program is free software; you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License, version 2.1 as published by the Free Software
 * Foundation.
 *
 * You should have received a copy of the GNU Lesser General Public License along with this
 * program; if not, you can obtain a copy at http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
 * or from the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * This program 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.
 *
 * Copyright (c) 2001 - 2013 Object Refinery Ltd, Pentaho Corporation and Contributors..  All rights reserved.
 */

package org.pentaho.reporting.engine.classic.core.modules.parser.simple.readhandlers;

import java.awt.Color;
import java.util.ArrayList;
import java.util.HashMap;

import org.pentaho.reporting.engine.classic.core.AttributeNames;
import org.pentaho.reporting.engine.classic.core.Element;
import org.pentaho.reporting.engine.classic.core.elementfactory.ElementFactory;
import org.pentaho.reporting.engine.classic.core.function.Expression;
import org.pentaho.reporting.engine.classic.core.modules.parser.base.PropertyAttributes;
import org.pentaho.reporting.engine.classic.core.modules.parser.base.ReportElementReadHandler;
import org.pentaho.reporting.engine.classic.core.modules.parser.base.ReportParserUtil;
import org.pentaho.reporting.engine.classic.core.modules.parser.base.common.AbstractPropertyXmlReadHandler;
import org.pentaho.reporting.engine.classic.core.modules.parser.base.common.StyleExpressionHandler;
import org.pentaho.reporting.engine.classic.core.style.BorderStyle;
import org.pentaho.reporting.engine.classic.core.style.ElementStyleSheet;
import org.pentaho.reporting.engine.classic.core.style.StyleKey;
import org.pentaho.reporting.libraries.xmlns.common.ParserUtil;
import org.pentaho.reporting.libraries.xmlns.parser.XmlReadHandler;
import org.xml.sax.SAXException;

/**
 * @noinspection HardCodedStringLiteral
 */
public abstract class AbstractElementReadHandler extends AbstractPropertyXmlReadHandler implements
    ReportElementReadHandler {

  /**
   * Literal text for an XML attribute.
   */
  public static final String FONT_NAME_ATT = "fontname";

  /**
   * Literal text for an XML attribute.
   */
  public static final String FONT_STYLE_ATT = "fontstyle";

  /**
   * Literal text for an XML attribute.
   */
  public static final String FONT_SIZE_ATT = "fontsize";

  /**
   * Literal text for an XML attribute value.
   */
  public static final String FS_BOLD = "fsbold";

  /**
   * Literal text for an XML attribute value.
   */
  public static final String FS_ITALIC = "fsitalic";

  /**
   * Literal text for an XML attribute value.
   */
  public static final String FS_UNDERLINE = "fsunderline";

  /**
   * Literal text for an XML attribute value.
   */
  public static final String FS_STRIKETHR = "fsstrikethr";

  /**
   * Literal text for an XML attribute value.
   */
  public static final String FS_EMBEDDED = "font-embedded";

  /**
   * Literal text for an XML attribute value.
   */
  public static final String FS_ENCODING = "font-encoding";

  /**
   * Literal text for an XML attribute value.
   */
  public static final String LINEHEIGHT = "line-height";

  /**
   * Literal text for an XML attribute.
   */
  public static final String NAME_ATT = "name";

  /**
   * Literal text for an XML attribute.
   */
  public static final String ALIGNMENT_ATT = "alignment";

  /**
   * Literal text for an XML attribute.
   */
  public static final String VALIGNMENT_ATT = "vertical-alignment";

  /**
   * Literal text for an XML attribute.
   */
  public static final String COLOR_ATT = "color";

  /**
   * Literal text for an XML attribute.
   */
  public static final String FIELDNAME_ATT = "fieldname";

  /**
   * Literal text for an XML attribute.
   */
  public static final String FUNCTIONNAME_ATT = "function";

  /**
   * Literal text for an XML attribute.
   */
  public static final String NULLSTRING_ATT = "nullstring";
  private static final String DYNAMIC_ATT = "dynamic";
  private static final String VISIBLE_ATT = "visible";
  private static final String HREF_ATT = "href";
  private static final String HREF_WINDOW_ATT = "href-window";
  public static final String STYLE_CLASS_ATT = "styleClass";

  private Element element;
  private String styleClass;
  private ArrayList<StyleExpressionHandler> styleExpressionHandlers;

  protected AbstractElementReadHandler() {
    styleExpressionHandlers = new ArrayList<StyleExpressionHandler>();
  }

  protected abstract ElementFactory getElementFactory();

  /**
   * Starts parsing.
   *
   * @param atts
   *          the attributes.
   * @throws org.xml.sax.SAXException
   *           if there is a parsing error.
   */
  protected void startParsing( final PropertyAttributes atts ) throws SAXException {
    final ElementFactory factory = getElementFactory();
    factory.setName( atts.getValue( getUri(), AbstractElementReadHandler.NAME_ATT ) );
    styleClass = atts.getValue( getUri(), AbstractElementReadHandler.STYLE_CLASS_ATT );

    final Color color =
        ReportParserUtil.parseColor( atts.getValue( getUri(), AbstractElementReadHandler.COLOR_ATT ), null );
    factory.setColor( color );

    final String posX = atts.getValue( getUri(), "x" );
    if ( posX != null ) {
      factory.setX( ReportParserUtil.parseRelativeFloat( posX, "Attribute 'x' not valid", getLocator() ) );
    }

    final String posY = atts.getValue( getUri(), "y" );
    if ( posY != null ) {
      factory.setY( ReportParserUtil.parseRelativeFloat( posY, "Attribute 'y' not valid", getLocator() ) );
    }

    final String width = atts.getValue( getUri(), "width" );
    if ( width != null ) {
      factory
          .setMinimumWidth( ReportParserUtil.parseRelativeFloat( width, "Attribute 'width' not valid", getLocator() ) );
    }

    final String height = atts.getValue( getUri(), "height" );
    if ( height != null ) {
      factory.setMinimumHeight( ReportParserUtil.parseRelativeFloat( height, "Attribute 'height' not valid",
          getLocator() ) );
    }

    final String useMinChunkWidth = atts.getValue( getUri(), "use-min-chunkwidth" );
    if ( useMinChunkWidth != null ) {
      factory.setUseMinChunkWidth( ReportParserUtil.parseBoolean( useMinChunkWidth, getLocator() ) );
    }

    final String dynamicValue = atts.getValue( getUri(), AbstractElementReadHandler.DYNAMIC_ATT );
    if ( dynamicValue != null ) {
      final Boolean dynamic = ParserUtil.parseBoolean( dynamicValue, getLocator() );
      factory.setDynamicHeight( dynamic );
    }

    final String visibleValue = atts.getValue( getUri(), AbstractElementReadHandler.VISIBLE_ATT );
    if ( visibleValue != null ) {
      final boolean value = ParserUtil.parseBoolean( visibleValue, true );
      factory.setVisible( ( value ) ? Boolean.TRUE : Boolean.FALSE );
    }

    final String href = atts.getValue( getUri(), AbstractElementReadHandler.HREF_ATT );
    if ( href != null ) {
      factory.setHRefTarget( href );
    }

    final String hrefWindow = atts.getValue( getUri(), AbstractElementReadHandler.HREF_WINDOW_ATT );
    if ( hrefWindow != null ) {
      factory.setHRefWindow( hrefWindow );
    }
    final String hrefTitle = atts.getValue( getUri(), "href-title" );
    if ( hrefTitle != null ) {
      factory.setHRefTitle( hrefTitle );
    }

    final String avoidBreaks = atts.getValue( getUri(), "avoid-pagebreaks" );
    if ( avoidBreaks != null ) {
      final boolean value = ParserUtil.parseBoolean( avoidBreaks, true );
      factory.setAvoidPagebreaks( ( value ) ? Boolean.TRUE : Boolean.FALSE );
    }

    final String overflowX = atts.getValue( getUri(), "overflow-x" );
    if ( overflowX != null ) {
      final boolean value = ParserUtil.parseBoolean( overflowX, false );
      factory.setOverflowX( ( value ) ? Boolean.TRUE : Boolean.FALSE );
    }

    final String overflowY = atts.getValue( getUri(), "overflow-y" );
    if ( overflowY != null ) {
      final boolean value = ParserUtil.parseBoolean( overflowY, false );
      factory.setOverflowY( ( value ) ? Boolean.TRUE : Boolean.FALSE );
    }

    final String widows = atts.getValue( getUri(), "widows" );
    if ( widows != null ) {
      factory.setWidows( ReportParserUtil.parseInteger( widows, getLocator() ) );
    }

    final String orphans = atts.getValue( getUri(), "orpans" );
    if ( orphans != null ) {
      factory.setOrphans( ReportParserUtil.parseInteger( orphans, getLocator() ) );
    }

    final String padding = atts.getValue( getUri(), "padding" );
    if ( padding != null ) {
      factory.setPadding( ReportParserUtil.parseFloat( padding, getLocator() ) );
    }

    final String paddingTop = atts.getValue( getUri(), "padding-top" );
    if ( paddingTop != null ) {
      factory.setPaddingTop( ReportParserUtil.parseFloat( paddingTop, getLocator() ) );
    }

    final String paddingLeft = atts.getValue( getUri(), "padding-left" );
    if ( paddingLeft != null ) {
      factory.setPaddingLeft( ReportParserUtil.parseFloat( paddingLeft, getLocator() ) );
    }

    final String paddingBottom = atts.getValue( getUri(), "padding-bottom" );
    if ( paddingBottom != null ) {
      factory.setPaddingBottom( ReportParserUtil.parseFloat( paddingBottom, getLocator() ) );
    }

    final String paddingRight = atts.getValue( getUri(), "padding-right" );
    if ( paddingRight != null ) {
      factory.setPaddingRight( ReportParserUtil.parseFloat( paddingRight, getLocator() ) );
    }

    final String attr = atts.getValue( getUri(), "background-color" );
    factory.setBackgroundColor( ReportParserUtil.parseColor( attr, null ) );

    final String borderColor = atts.getValue( getUri(), "border-color" );
    factory.setBorderColor( ReportParserUtil.parseColor( borderColor, null ) );
    final String borderColorTop = atts.getValue( getUri(), "border-top-color" );
    factory.setBorderTopColor( ReportParserUtil.parseColor( borderColorTop, null ) );
    final String borderColorLeft = atts.getValue( getUri(), "border-left-color" );
    factory.setBorderLeftColor( ReportParserUtil.parseColor( borderColorLeft, null ) );
    final String borderColorBottom = atts.getValue( getUri(), "border-bottom-color" );
    factory.setBorderBottomColor( ReportParserUtil.parseColor( borderColorBottom, null ) );
    final String borderColorRight = atts.getValue( getUri(), "border-right-color" );
    factory.setBorderRightColor( ReportParserUtil.parseColor( borderColorRight, null ) );
    final String borderColorBreak = atts.getValue( getUri(), "border-break-color" );
    factory.setBorderBreakColor( ReportParserUtil.parseColor( borderColorBreak, null ) );

    final String borderWidth = atts.getValue( getUri(), "border-width" );
    if ( borderWidth != null ) {
      factory.setBorderWidth( ReportParserUtil.parseFloat( borderWidth, getLocator() ) );
    }
    final String borderWidthTop = atts.getValue( getUri(), "border-top-width" );
    if ( borderWidthTop != null ) {
      factory.setBorderTopWidth( ReportParserUtil.parseFloat( borderWidthTop, getLocator() ) );
    }

    final String borderWidthLeft = atts.getValue( getUri(), "border-left-width" );
    if ( borderWidthLeft != null ) {
      factory.setBorderLeftWidth( ReportParserUtil.parseFloat( borderWidthLeft, getLocator() ) );
    }

    final String borderWidthBottom = atts.getValue( getUri(), "border-bottom-width" );
    if ( borderWidthBottom != null ) {
      factory.setBorderBottomWidth( ReportParserUtil.parseFloat( borderWidthBottom, getLocator() ) );
    }

    final String borderWidthRight = atts.getValue( getUri(), "border-right-width" );
    if ( borderWidthRight != null ) {
      factory.setBorderRightWidth( ReportParserUtil.parseFloat( borderWidthRight, getLocator() ) );
    }
    final String borderWidthBreak = atts.getValue( getUri(), "border-break-width" );
    if ( borderWidthBreak != null ) {
      factory.setBorderBreakWidth( ReportParserUtil.parseFloat( borderWidthBreak, getLocator() ) );
    }

    final String borderStyle = atts.getValue( getUri(), "border-style" );
    factory.setBorderStyle( parseBorderStyle( borderStyle ) );
    final String borderStyleTop = atts.getValue( getUri(), "border-top-style" );
    factory.setBorderTopStyle( parseBorderStyle( borderStyleTop ) );
    final String borderStyleLeft = atts.getValue( getUri(), "border-left-style" );
    factory.setBorderLeftStyle( parseBorderStyle( borderStyleLeft ) );
    final String borderStyleBottom = atts.getValue( getUri(), "border-bottom-style" );
    factory.setBorderBottomStyle( parseBorderStyle( borderStyleBottom ) );
    final String borderStyleRight = atts.getValue( getUri(), "border-right-style" );
    factory.setBorderRightStyle( parseBorderStyle( borderStyleRight ) );
    final String borderStyleBreak = atts.getValue( getUri(), "border-break-style" );
    factory.setBorderBreakStyle( parseBorderStyle( borderStyleBreak ) );

    factory.setHorizontalAlignment( ReportParserUtil.parseHorizontalElementAlignment( atts.getValue( getUri(),
        AbstractElementReadHandler.ALIGNMENT_ATT ), getLocator() ) );
    factory.setVerticalAlignment( ReportParserUtil.parseVerticalElementAlignment( atts.getValue( getUri(),
        AbstractElementReadHandler.VALIGNMENT_ATT ), getLocator() ) );

    final String borderRadiusWidth = atts.getValue( getUri(), "border-radius-width" );
    if ( borderRadiusWidth != null ) {
      factory.setBorderRadiusWidth( ReportParserUtil.parseFloat( borderRadiusWidth, getLocator() ) );
    }
    final String borderRadiusHeight = atts.getValue( getUri(), "border-radius-height" );
    if ( borderRadiusHeight != null ) {
      factory.setBorderRadiusHeight( ReportParserUtil.parseFloat( borderRadiusHeight, getLocator() ) );
    }
    final String borderTopLeftRadiusWidth = atts.getValue( getUri(), "border-top-left-radius-width" );
    if ( borderTopLeftRadiusWidth != null ) {
      factory.setBorderTopLeftRadiusWidth( ReportParserUtil.parseFloat( borderTopLeftRadiusWidth, getLocator() ) );
    }
    final String borderTopLeftRadiusHeight = atts.getValue( getUri(), "border-top-left-radius-height" );
    if ( borderTopLeftRadiusHeight != null ) {
      factory.setBorderTopLeftRadiusHeight( ReportParserUtil.parseFloat( borderTopLeftRadiusHeight, getLocator() ) );
    }
    final String borderTopRightRadiusWidth = atts.getValue( getUri(), "border-top-right-radius-width" );
    if ( borderTopRightRadiusWidth != null ) {
      factory.setBorderTopRightRadiusWidth( ReportParserUtil.parseFloat( borderTopRightRadiusWidth, getLocator() ) );
    }
    final String borderTopRightRadiusHeight = atts.getValue( getUri(), "border-top-right-radius-height" );
    if ( borderTopRightRadiusHeight != null ) {
      factory.setBorderTopRightRadiusHeight( ReportParserUtil.parseFloat( borderTopRightRadiusHeight, getLocator() ) );
    }
    final String borderBottomLeftRadiusWidth = atts.getValue( getUri(), "border-bottom-left-radius-width" );
    if ( borderBottomLeftRadiusWidth != null ) {
      factory.setBorderBottomLeftRadiusWidth( ReportParserUtil.parseFloat( borderBottomLeftRadiusWidth, getLocator() ) );
    }
    final String borderBottomLeftRadiusHeight = atts.getValue( getUri(), "border-bottom-left-radius-height" );
    if ( borderBottomLeftRadiusHeight != null ) {
      factory
          .setBorderBottomLeftRadiusHeight( ReportParserUtil.parseFloat( borderBottomLeftRadiusHeight, getLocator() ) );
    }
    final String borderBottomRightRadiusWidth = atts.getValue( getUri(), "border-bottom-right-radius-width" );
    if ( borderBottomRightRadiusWidth != null ) {
      factory
          .setBorderBottomRightRadiusWidth( ReportParserUtil.parseFloat( borderBottomRightRadiusWidth, getLocator() ) );
    }
    final String borderBottomRightRadiusHeight = atts.getValue( getUri(), "border-bottom-right-radius-height" );
    if ( borderBottomRightRadiusHeight != null ) {
      factory.setBorderBottomRightRadiusHeight( ReportParserUtil.parseFloat( borderBottomRightRadiusHeight,
          getLocator() ) );
    }
  }

  private BorderStyle parseBorderStyle( final String value ) {
    if ( BorderStyle.DASHED.toString().equals( value ) ) {
      return BorderStyle.DASHED;
    }
    if ( BorderStyle.DOT_DASH.toString().equals( value ) ) {
      return BorderStyle.DOT_DASH;
    }
    if ( BorderStyle.DOT_DOT_DASH.toString().equals( value ) ) {
      return BorderStyle.DOT_DOT_DASH;
    }
    if ( BorderStyle.DOTTED.toString().equals( value ) ) {
      return BorderStyle.DOTTED;
    }
    if ( BorderStyle.DOUBLE.toString().equals( value ) ) {
      return BorderStyle.DOUBLE;
    }
    if ( BorderStyle.GROOVE.toString().equals( value ) ) {
      return BorderStyle.GROOVE;
    }
    if ( BorderStyle.HIDDEN.toString().equals( value ) ) {
      return BorderStyle.HIDDEN;
    }
    if ( BorderStyle.INSET.toString().equals( value ) ) {
      return BorderStyle.INSET;
    }
    if ( BorderStyle.OUTSET.toString().equals( value ) ) {
      return BorderStyle.OUTSET;
    }
    if ( BorderStyle.RIDGE.toString().equals( value ) ) {
      return BorderStyle.RIDGE;
    }
    if ( BorderStyle.SOLID.toString().equals( value ) ) {
      return BorderStyle.SOLID;
    }
    if ( BorderStyle.NONE.toString().equals( value ) ) {
      return BorderStyle.NONE;
    }
    return null;
  }

  protected XmlReadHandler getHandlerForChild( final String uri, final String tagName, final PropertyAttributes attrs )
    throws SAXException {
    if ( isSameNamespace( uri ) == false ) {
      return null;
    }

    if ( "style-expression".equals( tagName ) ) {
      final StyleExpressionHandler handler = new StyleExpressionHandler();
      styleExpressionHandlers.add( handler );
      return handler;
    }
    return null;
  }

  /**
   * Done parsing.
   *
   * @throws org.xml.sax.SAXException
   *           if there is a parsing error.
   */
  protected void doneParsing() throws SAXException {
    element = getElementFactory().createElement();
    element.setAttribute( AttributeNames.Core.NAMESPACE, AttributeNames.Core.SOURCE, getRootHandler().getSource() );

    handleInheritedStyle( styleClass );

    for ( int i = 0; i < styleExpressionHandlers.size(); i++ ) {
      final StyleExpressionHandler handler = styleExpressionHandlers.get( i );
      final StyleKey key = handler.getKey();
      if ( handler.getKey() != null ) {
        final Expression expression = handler.getExpression();
        element.setStyleExpression( key, expression );
      }
    }
    super.doneParsing();
  }

  protected void handleInheritedStyle( final String styleClass ) {
    if ( styleClass != null ) {
      final HashMap<String, ElementStyleSheet> report =
          (HashMap<String, ElementStyleSheet>) getRootHandler().getHelperObject(
              ReportParserUtil.HELPER_OBJ_LEGACY_STYLES );
      if ( report != null ) {
        final ElementStyleSheet existingStyleSheet = report.get( styleClass );
        if ( existingStyleSheet != null ) {
          element.getStyle().addDefault( existingStyleSheet );
        }
      }
    }
  }

  public Element getElement() {
    return element;
  }

  /**
   * Returns the object for this element or null, if this element does not create an object.
   *
   * @return the object.
   */
  public Object getObject() {
    return element;
  }
}