/*
* 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 - 2009 Object Refinery Ltd, Pentaho Corporation and Contributors.. All rights reserved.
*/
package org.pentaho.reporting.engine.classic.core.filter.templates;
import org.pentaho.reporting.engine.classic.core.Element;
import org.pentaho.reporting.engine.classic.core.filter.AnchorFilter;
import org.pentaho.reporting.engine.classic.core.filter.DataRowDataSource;
import org.pentaho.reporting.engine.classic.core.function.ExpressionRuntime;
/**
* The anchor-field template provides the default field for assigning anchors to an location within the document.
*
* @author Thomas Morgner
* @deprecated the Anchor-Field has been deprecated. Use the style-key "anchor" instead.
*/
public class AnchorFieldTemplate extends AbstractTemplate
{
/**
* The data-row data source.
*/
private DataRowDataSource dataRowDataSource;
/**
* A string filter.
*/
private AnchorFilter anchorFilter;
/**
* Creates a new string field template.
*/
public AnchorFieldTemplate()
{
dataRowDataSource = new DataRowDataSource();
anchorFilter = new AnchorFilter();
anchorFilter.setDataSource(dataRowDataSource);
}
/**
* Returns the field name.
*
* @return The field name.
*/
public String getField()
{
return dataRowDataSource.getDataSourceColumnName();
}
/**
* Sets the field name.
*
* @param field the field name.
*/
public void setField(final String field)
{
dataRowDataSource.setDataSourceColumnName(field);
}
/**
* Returns the formula used to compute the value of the data source.
*
* @return the formula.
*/
public String getFormula()
{
return dataRowDataSource.getFormula();
}
/**
* Defines the formula used to compute the value of this data source.
*
* @param formula the formula for the data source.
*/
public void setFormula(final String formula)
{
dataRowDataSource.setFormula(formula);
}
/**
* Returns the current value for the data source.
*
* @param runtime the expression runtime that is used to evaluate formulas and expressions when computing the value of
* this filter.
* @param element
* @return the value.
*/
public Object getValue(final ExpressionRuntime runtime, final Element element)
{
return anchorFilter.getValue(runtime, element);
}
/**
* Clones the template.
*
* @return the clone.
* @throws CloneNotSupportedException this should never happen.
*/
public Object clone()
throws CloneNotSupportedException
{
final AnchorFieldTemplate template = (AnchorFieldTemplate) super.clone();
template.anchorFilter = (AnchorFilter) anchorFilter.clone();
template.dataRowDataSource = (DataRowDataSource) template.anchorFilter.getDataSource();
return template;
}
/**
* Returns the datarow data source used in this template.
*
* @return the datarow data source.
*/
protected DataRowDataSource getDataRowDataSource()
{
return dataRowDataSource;
}
}