org.eclipse.birt.chart.model.data
Interface SeriesDefinition

All Superinterfaces:

org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier

All Known Implementing Classes:

SeriesDefinitionImpl

public interface SeriesDefinition

extends org.eclipse.emf.ecore.EObject

A representation of the model object 'Series Definition'. This type represents design-time definition for a series.

The following features are supported:

• Query
• Series Palette
• Series Definitions
• Format Specifier
• Series
• Grouping
• Sorting

See Also:

DataPackage.getSeriesDefinition()

Field Summary

static SeriesDefinition[]

EMPTY_ARRAY

Method Summary

Series	getDesignTimeSeries()
FormatSpecifier	getFormatSpecifier() Returns the value of the 'Format Specifier' containment reference.
SeriesGrouping	getGrouping() Returns the value of the 'Grouping' containment reference.
Query	getQuery() Returns the value of the 'Query' containment reference.
java.util.ArrayList	getRunTimeSeries()
org.eclipse.emf.common.util.EList	getSeries() Returns the value of the 'Series' containment reference list.
org.eclipse.emf.common.util.EList	getSeriesDefinitions() Returns the value of the 'Series Definitions' containment reference list.
Palette	getSeriesPalette() Returns the value of the 'Series Palette' containment reference.
SortOption	getSorting() Returns the value of the 'Sorting' attribute.
boolean	isSetSorting() Returns whether the value of the ' Sorting' attribute is set.
void	setFormatSpecifier(FormatSpecifier value) Sets the value of the 'Format Specifier' containment reference.
void	setGrouping(SeriesGrouping value) Sets the value of the 'Grouping' containment reference.
void	setQuery(Query value) Sets the value of the 'Query' containment reference.
void	setSeriesPalette(Palette value) Sets the value of the 'Series Palette' containment reference.
void	setSorting(SortOption value) Sets the value of the 'Sorting' attribute.
void	unsetSorting() Unsets the value of the 'Sorting' attribute.

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Field Detail

EMPTY_ARRAY

public static final SeriesDefinition[] EMPTY_ARRAY

Method Detail

getQuery

public Query getQuery()

Returns the value of the 'Query' containment reference.

Returns:

the value of the 'Query' containment reference.

See Also:

setQuery(Query), DataPackage.getSeriesDefinition_Query()

setQuery

public void setQuery(Query value)

Sets the value of the 'Query' containment reference.

Parameters:

value - the new value of the 'Query' containment reference.

See Also:

getQuery()

getSeriesPalette

public Palette getSeriesPalette()

Returns the value of the 'Series Palette' containment reference. Gets the palette associated with the series definiton instance. This palette will be used to determine the sequence of colors for the series that are represented by this definition.

Returns:

the value of the 'Series Palette' containment reference.

See Also:

setSeriesPalette(Palette), DataPackage.getSeriesDefinition_SeriesPalette()

setSeriesPalette

public void setSeriesPalette(Palette value)

Sets the value of the 'Series Palette' containment reference.

Parameters:

value - the new value of the 'Series Palette' containment reference.

See Also:

getSeriesPalette()

getSeriesDefinitions

public org.eclipse.emf.common.util.EList getSeriesDefinitions()

Returns the value of the 'Series Definitions' containment reference list. The list contents are of type SeriesDefinition.

Returns:

the value of the 'Series Definitions' containment reference list.

See Also:

DataPackage.getSeriesDefinition_SeriesDefinitions()

getFormatSpecifier

public FormatSpecifier getFormatSpecifier()

Returns the value of the 'Format Specifier' containment reference.

Returns:

the value of the 'Format Specifier' containment reference.

See Also:

setFormatSpecifier(FormatSpecifier), DataPackage.getSeriesDefinition_FormatSpecifier()

setFormatSpecifier

public void setFormatSpecifier(FormatSpecifier value)

Sets the value of the 'Format Specifier' containment reference.

Parameters:

value - the new value of the 'Format Specifier' containment reference.

See Also:

getFormatSpecifier()

getSeries

public org.eclipse.emf.common.util.EList getSeries()

Returns the value of the 'Series' containment reference list. The list contents are of type Series. Holds all the series for the chart.

Returns:

the value of the 'Series' containment reference list.

See Also:

DataPackage.getSeriesDefinition_Series()

getGrouping

public SeriesGrouping getGrouping()

Returns the value of the 'Grouping' containment reference. Defines if and how the series data is to be grouped for display. This should only be applied to Base Series.

Returns:

the value of the 'Grouping' containment reference.

See Also:

setGrouping(SeriesGrouping), DataPackage.getSeriesDefinition_Grouping()

setGrouping

public void setGrouping(SeriesGrouping value)

Sets the value of the 'Grouping' containment reference.

Parameters:

value - the new value of the 'Grouping' containment reference.

See Also:

getGrouping()

getSorting

public SortOption getSorting()

Returns the value of the 'Sorting' attribute. The default value is "Ascending". The literals are from the enumeration SortOption. Defines if and how the series data is to be sorted for display. This should only be applied to Base Series.

Returns:

the value of the 'Sorting' attribute.

See Also:

SortOption, isSetSorting(), unsetSorting(), setSorting(SortOption), DataPackage.getSeriesDefinition_Sorting()

setSorting

public void setSorting(SortOption value)

Sets the value of the 'Sorting' attribute.

Parameters:

value - the new value of the 'Sorting' attribute.

See Also:

SortOption, isSetSorting(), unsetSorting(), getSorting()

unsetSorting

public void unsetSorting()

Unsets the value of the 'Sorting' attribute.

See Also:

isSetSorting(), getSorting(), setSorting(SortOption)

isSetSorting

public boolean isSetSorting()

Returns whether the value of the ' Sorting' attribute is set.

Returns:

whether the value of the 'Sorting' attribute is set.

See Also:

unsetSorting(), getSorting(), setSorting(SortOption)

getDesignTimeSeries

public Series getDesignTimeSeries()

Returns:

The design-time series associated with the series definition

getRunTimeSeries

public java.util.ArrayList getRunTimeSeries()

Returns:

The runtime-time series' associated with the series definition