/*
* 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.elementfactory;
import java.awt.Color;
import java.awt.geom.Rectangle2D;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import org.pentaho.reporting.engine.classic.core.AttributeNames;
import org.pentaho.reporting.engine.classic.core.Element;
import org.pentaho.reporting.engine.classic.core.ElementAlignment;
import org.pentaho.reporting.engine.classic.core.filter.DataRowDataSource;
import org.pentaho.reporting.engine.classic.core.filter.DateFormatFilter;
import org.pentaho.reporting.engine.classic.core.filter.types.DateFieldType;
import org.pentaho.reporting.engine.classic.core.filter.types.LegacyType;
import org.pentaho.reporting.engine.classic.core.function.FormulaExpression;
import org.pentaho.reporting.engine.classic.core.style.ElementStyleKeys;
import org.pentaho.reporting.engine.classic.core.style.FontDefinition;
/**
* The date format factory can be used to create date/time text elements. These text elements have special abilities to
* format date/time values.
* <p/>
* Once the desired properties are set, the factory can be reused to create similiar text elements.
*
* @author Thomas Morgner
*/
public class DateFieldElementFactory extends TextFieldElementFactory {
/**
* The date format instance used to format date values in the text element.
*/
private DateFormat format;
/**
* The cell format for the excel export.
*/
private String excelCellFormat;
/**
* Creates a new date field element factory.
*/
public DateFieldElementFactory() {
}
/**
* Returns the excel export cell format.
*
* @return the excel cell format.
*/
public String getExcelCellFormat() {
return excelCellFormat;
}
/**
* Defines a special cell format that should be used when exporting the report into Excel workbooks.
*
* @param excelCellFormat
* the excel cell format
*/
public void setExcelCellFormat( final String excelCellFormat ) {
this.excelCellFormat = excelCellFormat;
}
/**
* Returns the date format used for all generated text elements. The date format is shared among all generated
* elements.
*
* @return the date format used in this factory.
*/
public DateFormat getFormat() {
return format;
}
/**
* Defines the date format used for all generated text elements. The date format is shared among all generated
* elements.
*
* @param format
* the date format used in this factory.
*/
public void setFormat( final DateFormat format ) {
this.format = format;
}
/**
* Returns the format string of the used date format. This method will return null, if the current date format is no
* instance of SimpleDateFormat.
*
* @return the formatstring of the date format instance.
*/
public String getFormatString() {
if ( getFormat() instanceof SimpleDateFormat ) {
final SimpleDateFormat decFormat = (SimpleDateFormat) getFormat();
return decFormat.toPattern();
}
return null;
}
/**
* Defines the format string of the used date format. This method will replace the date format instance of this
* factory. If the format string is null, the default format string of the current locale is used.
*
* @param formatString
* the formatstring of the date format instance.
*/
public void setFormatString( final String formatString ) {
if ( formatString == null ) {
setFormat( null );
} else {
setFormat( new SimpleDateFormat( formatString ) );
}
}
/**
* Creates the date text element based on the defined settings. Undefined properties will not be set in the generated
* element.
*
* @return the generated date text element
* @see org.pentaho.reporting.engine.classic.core.elementfactory.ElementFactory#createElement()
*/
public Element createElement() {
final Element element = new Element();
if ( format instanceof SimpleDateFormat || format == null ) {
element.setElementType( new DateFieldType() );
if ( getFieldname() != null ) {
element.setAttribute( AttributeNames.Core.NAMESPACE, AttributeNames.Core.FIELD, getFieldname() );
}
if ( getFormula() != null ) {
final FormulaExpression formulaExpression = new FormulaExpression();
formulaExpression.setFormula( getFormula() );
element.setAttributeExpression( AttributeNames.Core.NAMESPACE, AttributeNames.Core.VALUE, formulaExpression );
}
if ( format != null ) {
final SimpleDateFormat simpleDateFormat = (SimpleDateFormat) format;
final String formatString = simpleDateFormat.toPattern();
element.setAttribute( AttributeNames.Core.NAMESPACE, AttributeNames.Core.FORMAT_STRING, formatString );
}
element.setAttribute( AttributeNames.Core.NAMESPACE, AttributeNames.Core.NULL_VALUE, getNullString() );
} else {
element.setElementType( new LegacyType() );
final DateFormatFilter dataSource = new DateFormatFilter();
if ( format != null ) {
dataSource.setFormatter( format );
}
final DataRowDataSource dds = new DataRowDataSource();
if ( getFormula() != null ) {
dds.setFormula( getFormula() );
} else {
dds.setDataSourceColumnName( getFieldname() );
}
dataSource.setDataSource( dds );
if ( getNullString() != null ) {
dataSource.setNullValue( getNullString() );
}
element.setDataSource( dataSource );
}
applyElementName( element );
applyStyle( element.getStyle() );
element.getStyle().setStyleProperty( ElementStyleKeys.EXCEL_DATA_FORMAT_STRING, getExcelCellFormat() );
return element;
}
/**
* Creates a new {@link Element} containing a date filter structure.
*
* @param name
* the name of the new element
* @param bounds
* the bounds of the new element
* @param paint
* the text color of this text element
* @param alignment
* the horizontal text alignment.
* @param font
* the font for this element
* @param nullString
* the text used when the value of this element is <code>null</code>
* @param format
* the SimpleDateFormat-formatstring used to format the date
* @param field
* the fieldname to retrieve values from
* @return a report element for displaying a java.util.Date value.
* @throws NullPointerException
* if bounds, format or field are <code>null</code>
* @throws IllegalArgumentException
* if the given alignment is invalid
* @deprecated Use a more fine-grained approach to define this element by using the element-factory directly.
*/
public static Element createDateElement( final String name, final Rectangle2D bounds, final Color paint,
final ElementAlignment alignment, final FontDefinition font, final String nullString, final String format,
final String field ) {
return createDateElement( name, bounds, paint, alignment, null, font, nullString, format, field );
}
/**
* Creates a new {@link Element} containing a date filter structure.
*
* @param name
* the name of the new element
* @param bounds
* the bounds of the new element
* @param paint
* the text color of this text element
* @param alignment
* the horizontal text alignment
* @param valign
* the vertical text alignment
* @param font
* the font for this element
* @param nullString
* the text used when the value of this element is <code>null</code>
* @param format
* the SimpleDateFormat-formatstring used to format the date
* @param field
* the fieldname to retrieve values from
* @return a report element for displaying a java.util.Date value.
* @throws NullPointerException
* if bounds, format or field are <code>null</code>
* @throws IllegalArgumentException
* if the given alignment is invalid
* @deprecated Use a more fine-grained approach to define this element by using the element-factory directly.
*/
public static Element createDateElement( final String name, final Rectangle2D bounds, final Color paint,
final ElementAlignment alignment, final ElementAlignment valign, final FontDefinition font,
final String nullString, final String format, final String field ) {
final DateFieldElementFactory factory = new DateFieldElementFactory();
factory.setX( new Float( bounds.getX() ) );
factory.setY( new Float( bounds.getY() ) );
factory.setMinimumWidth( new Float( bounds.getWidth() ) );
factory.setMinimumHeight( new Float( bounds.getHeight() ) );
factory.setName( name );
factory.setColor( paint );
factory.setHorizontalAlignment( alignment );
factory.setVerticalAlignment( valign );
if ( font != null ) {
factory.setFontName( font.getFontName() );
factory.setFontSize( new Integer( font.getFontSize() ) );
factory.setBold( ElementFactory.getBooleanValue( font.isBold() ) );
factory.setItalic( ElementFactory.getBooleanValue( font.isItalic() ) );
factory.setEncoding( font.getFontEncoding( font.getFontEncoding( null ) ) );
factory.setUnderline( ElementFactory.getBooleanValue( font.isUnderline() ) );
factory.setStrikethrough( ElementFactory.getBooleanValue( font.isStrikeThrough() ) );
factory.setEmbedFont( ElementFactory.getBooleanValue( font.isEmbeddedFont() ) );
}
factory.setNullString( nullString );
factory.setFormatString( format );
factory.setFieldname( field );
return factory.createElement();
}
/**
* Creates a new {@link Element} containing a date filter structure.
*
* @param name
* the name of the new element
* @param bounds
* the bounds of the new element
* @param paint
* the text color of this text element
* @param alignment
* the horizontal text alignment
* @param font
* the font for this element
* @param nullString
* the text used when the value of this element is <code>null</code>
* @param format
* the SimpleDateFormat used to format the date
* @param field
* the fieldname to retrieve values from
* @return a report element for displaying a java.util.Date value.
* @throws NullPointerException
* if bounds, name, format or field are <code>null</code>
* @throws IllegalArgumentException
* if the given alignment is invalid
* @deprecated Use a more fine-grained approach to define this element by using the element-factory directly.
*/
public static Element createDateElement( final String name, final Rectangle2D bounds, final Color paint,
final ElementAlignment alignment, final FontDefinition font, final String nullString, final DateFormat format,
final String field ) {
return createDateElement( name, bounds, paint, alignment, null, font, nullString, format, field );
}
/**
* Creates a new TextElement containing a date filter structure.
*
* @param name
* the name of the new element
* @param bounds
* the bounds of the new element
* @param paint
* the text color of this text element
* @param alignment
* the horizontal text alignment.
* @param valign
* the vertical text alignment
* @param font
* the font for this element
* @param nullString
* the text used when the value of this element is null
* @param format
* the SimpleDateFormat used to format the date
* @param field
* the fieldname to retrieve values from
* @return a report element for displaying a java.util.Date value.
* @throws NullPointerException
* if bounds, name, format or field are null
* @throws IllegalArgumentException
* if the given alignment is invalid
* @deprecated Use a more fine-grained approach to define this element by using the element-factory directly.
*/
public static Element createDateElement( final String name, final Rectangle2D bounds, final Color paint,
final ElementAlignment alignment, final ElementAlignment valign, final FontDefinition font,
final String nullString, final DateFormat format, final String field ) {
final DateFieldElementFactory factory = new DateFieldElementFactory();
factory.setX( new Float( bounds.getX() ) );
factory.setY( new Float( bounds.getY() ) );
factory.setMinimumWidth( new Float( bounds.getWidth() ) );
factory.setMinimumHeight( new Float( bounds.getHeight() ) );
factory.setName( name );
factory.setColor( paint );
factory.setHorizontalAlignment( alignment );
factory.setVerticalAlignment( valign );
if ( font != null ) {
factory.setFontName( font.getFontName() );
factory.setFontSize( new Integer( font.getFontSize() ) );
factory.setBold( ElementFactory.getBooleanValue( font.isBold() ) );
factory.setItalic( ElementFactory.getBooleanValue( font.isItalic() ) );
factory.setEncoding( font.getFontEncoding( font.getFontEncoding( null ) ) );
factory.setUnderline( ElementFactory.getBooleanValue( font.isUnderline() ) );
factory.setStrikethrough( ElementFactory.getBooleanValue( font.isStrikeThrough() ) );
factory.setEmbedFont( ElementFactory.getBooleanValue( font.isEmbeddedFont() ) );
}
factory.setNullString( nullString );
factory.setFormat( format );
factory.setFieldname( field );
return factory.createElement();
}
}