org.eclipse.birt.chart.model.attribute.DataPoint Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.birt.runtime Show documentation
A component of the BIRT runtime
There is a newer version: 4.6.0-20160607
Show newest version
/***********************************************************************
 * Copyright (c) 2004 Actuate Corporation.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 * Actuate Corporation - initial API and implementation
 ***********************************************************************/

package org.eclipse.birt.chart.model.attribute;

import org.eclipse.birt.chart.model.IChartObject;
import org.eclipse.emf.common.util.EList;

/**
 *  A representation of the model object 'Data Point'. 
 *
 * 
 * DataPoint holds the settings for establishing the label text of a series' datapoints.
 * 			
 * 
 *
 * 
 * The following features are supported:
 * 

 *   {@link org.eclipse.birt.chart.model.attribute.DataPoint#getComponents Components}
 *   {@link org.eclipse.birt.chart.model.attribute.DataPoint#getPrefix Prefix}
 *   {@link org.eclipse.birt.chart.model.attribute.DataPoint#getSuffix Suffix}
 *   {@link org.eclipse.birt.chart.model.attribute.DataPoint#getSeparator Separator}
 * 
 * 
 *
 * @see org.eclipse.birt.chart.model.attribute.AttributePackage#getDataPoint()
 * @model extendedMetaData="name='DataPoint' kind='elementOnly'"
 * @extends IChartObject
 * @generated
 */
public interface DataPoint extends IChartObject
{

	/**
	 * Returns the value of the 'Components' containment reference list. The list contents are of
	 * type {@link org.eclipse.birt.chart.model.attribute.DataPointComponent}.   
	 * 
	 * Specifies the components (values) being shown in the data label.
	 * 
	 * 
	 * 
	 * @return the value of the 'Components' containment reference list.
	 * @see org.eclipse.birt.chart.model.attribute.AttributePackage#getDataPoint_Components()
	 * @model type="org.eclipse.birt.chart.model.attribute.DataPointComponent" containment="true" resolveProxies="false"
	 *        required="true"
	 * @generated
	 */
	EList getComponents( );

	/**
	 * Returns the value of the 'Prefix' attribute.
	 *  
	 * 
	 * Attribute "Prefix" specifies the prefix of the label text.
	 * 					
	 * 
	 * @return the value of the 'Prefix' attribute.
	 * @see #setPrefix(String)
	 * @see org.eclipse.birt.chart.model.attribute.AttributePackage#getDataPoint_Prefix()
	 * @model dataType="org.eclipse.emf.ecore.xml.type.String" required="true"
	 *        extendedMetaData="kind='element' name='Prefix'"
	 * @generated
	 */
	String getPrefix( );

	/**
	 * Sets the value of the '{@link org.eclipse.birt.chart.model.attribute.DataPoint#getPrefix Prefix}' attribute.
	 *  
	 * @param value the new value of the 'Prefix' attribute.
	 * @see #getPrefix()
	 * @generated
	 */
	void setPrefix( String value );

	/**
	 * Returns the value of the 'Suffix' attribute.
	 *  
	 * 
	 * Attribute "Suffix" specifies the prefix of the label text.
	 * 					
	 * 
	 * @return the value of the 'Suffix' attribute.
	 * @see #setSuffix(String)
	 * @see org.eclipse.birt.chart.model.attribute.AttributePackage#getDataPoint_Suffix()
	 * @model dataType="org.eclipse.emf.ecore.xml.type.String" required="true"
	 *        extendedMetaData="kind='element' name='Suffix'"
	 * @generated
	 */
	String getSuffix( );

	/**
	 * Sets the value of the '{@link org.eclipse.birt.chart.model.attribute.DataPoint#getSuffix Suffix}' attribute.
	 *  
	 * @param value the new value of the 'Suffix' attribute.
	 * @see #getSuffix()
	 * @generated
	 */
	void setSuffix( String value );

	/**
	 * Returns the value of the 'Separator' attribute.   
	 * 
	 * Specifies the separator used in the data label.
	 * 
	 * 
	 * 
	 * @return the value of the 'Separator' attribute.
	 * @see #setSeparator(String)
	 * @see org.eclipse.birt.chart.model.attribute.AttributePackage#getDataPoint_Separator()
	 * @model unique="false" dataType="org.eclipse.emf.ecore.xml.type.String" required="true"
	 * @generated
	 */
	String getSeparator( );

	/**
	 * Sets the value of the '{@link org.eclipse.birt.chart.model.attribute.DataPoint#getSeparator Separator}' attribute.
	 *  
	 * @param value the new value of the 'Separator' attribute.
	 * @see #getSeparator()
	 * @generated
	 */
	void setSeparator( String value );

	/**
	 * @generated
	 */
	DataPoint copyInstance( );

} // DataPoint