net.sf.jasperreports.components.map.ItemProperty Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jasperreports Show documentation

JasperReports Library

There is a newer version: 6.21.2

/*
 * JasperReports - Free Java Reporting Library.
 * Copyright (C) 2001 - 2016 TIBCO Software Inc. All rights reserved.
 * http://www.jaspersoft.com
 *
 * Unless you have purchased a commercial license agreement from Jaspersoft,
 * the following license terms apply:
 *
 * This program is part of JasperReports.
 *
 * JasperReports 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 3 of the License, or
 * (at your option) any later version.
 *
 * JasperReports 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 JasperReports. If not, see .
 */
package net.sf.jasperreports.components.map;

import net.sf.jasperreports.engine.JRCloneable;
import net.sf.jasperreports.engine.JRExpression;

/**
 * The ItemProperty interface. An item property has a name (required) and a 
 * value provided either in a static way, using the value attribute, 
 * or dynamically, using a value expression.
 * 
 * @author Teodor Danciu ([email protected])
 * @deprecated Replaced by {@link net.sf.jasperreports.components.items.ItemProperty}.
 */
public interface ItemProperty extends JRCloneable
{

	/**
	 * Returns the name of the item property (required).
	 * @return the property name
	 */
	String getName();
	
	/**
	 * Returns the value attribute of the item property. Only 
	 * java.lang.String values are allowed for this attribute.
	 * @return the value attribute
	 */
	String getValue();
	
	/**
	 * Returns a {@link net.sf.jasperreports.engine.JRExpression JRExpression} representing 
	 * the value object for the item property. If present, it overrides the value given by 
	 * the value attribute.
	 * 
	 * @return the value expression
	 */
	JRExpression getValueExpression();
	
}