ilog.views.chart.data

Class IlvDataSetProperty

java.lang.Object

ilog.views.chart.data.IlvDataSetProperty

public class IlvDataSetProperty
extends Object

A class that handles common data set properties. This class defines the following properties:

• XTimeSeries: Describes that the x-series of a data set is a time series.
• YTimeSeries: Describes that the y-series of a data set is a time series.
• category: Describes the category of a data set. This is the normal or minimal distance between consecutive x values.
• index: Corresponds to the index of the data set in its main data source.
• CSSclass: Corresponds to the CSS classes of the data set.
• CSSpseudoClass: Corresponds to the CSS pseudo-classes of the data set.

Each property should be set, unset or retrieved using the corresponding methods of this class.

To set these properties use the IlvDataSet.putProperty(java.lang.Object, java.lang.Object, boolean) method. There is no property change notification, except for the CSSClass and CSSpseudoClass properties.

Since:

JViews 5.0

Method Summary

Modifier and Type	Method and Description
static void	addPseudoClass(IlvDataSet dataSet, String pseudoClass) Adds a pseudo-class to the specified data set.
static Double	getCategory(IlvDataSet dataSet) Returns the value of the Category property for the specified data set.
static String	getCSSClasses(IlvDataSet dataSet) Returns the CSS classes of the specified data set.
static IlvDataSource	getDataSource(IlvDataSet dataSet) Returns the main data source of the specified data set.
static int	getIndex(IlvDataSet dataSet) Deprecated. Since JViews 8.7, this method is deprecated. Better use the method IlvChartRenderer.getDataSetMainIndex(IlvDataSet).
static String[]	getPseudoClasses(IlvDataSet dataSet) Returns the pseudo-classes of the specified data set.
static boolean	isXTimeSeries(IlvDataSet dataSet) Returns the value of the XTimeSeries property for the specified data set.
static boolean	isYTimeSeries(IlvDataSet dataSet) Returns the value of the YTimeSeries property for the specified data set.
static void	removePseudoClass(IlvDataSet dataSet, String pseudoClass) Removes a pseudo-class from the specified data set.
static void	setCategory(IlvDataSet dataSet, Double category) Sets the value of the category property on the specified data set to the given value.
static void	setCSSClasses(IlvDataSet dataSet, String CSSclasses) Sets the CSS classes of the specified data set.
static void	setDataSource(IlvDataSet dataSet, IlvDataSource dataSource) Sets the main data source of the specified data set.
static void	setPseudoClasses(IlvDataSet dataSet, String[] classes) Sets the pseudo-classes of the specified data set.
static void	setXTimeSeries(IlvDataSet dataSet, boolean time) Sets the value of the XTimeSeries property on the specified data set to the given value.
static void	setYTimeSeries(IlvDataSet dataSet, boolean time) Sets the value of the YTimeSeries property on the specified data set to the given value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isXTimeSeries

public static boolean isXTimeSeries(IlvDataSet dataSet)

Returns the value of the XTimeSeries property for the specified data set.

setXTimeSeries

public static void setXTimeSeries(IlvDataSet dataSet,
                                  boolean time)

Sets the value of the XTimeSeries property on the specified data set to the given value.

Throws:

IllegalArgumentException - The specified data set is null.

isYTimeSeries

public static boolean isYTimeSeries(IlvDataSet dataSet)

Returns the value of the YTimeSeries property for the specified data set.

setYTimeSeries

public static void setYTimeSeries(IlvDataSet dataSet,
                                  boolean time)

Sets the value of the YTimeSeries property on the specified data set to the given value.

Throws:

IllegalArgumentException - The specified data set is null.

getCategory

public static Double getCategory(IlvDataSet dataSet)

Returns the value of the Category property for the specified data set. May return null if the data set does not have a category.

setCategory

public static void setCategory(IlvDataSet dataSet,
                               Double category)

Sets the value of the category property on the specified data set to the given value. The category property is the normal or minimal distance between consecutive x values.

Throws:

IllegalArgumentException - The specified data set is null.

getDataSource

public static IlvDataSource getDataSource(IlvDataSet dataSet)

Returns the main data source of the specified data set.

Parameters:

dataSet - The data set.

Returns:

The data source that provides the data set. If the data set is provided by several data sources, the method returns the first one that references this data set.

Since:

JViews 5.5

See Also:

setDataSource(ilog.views.chart.data.IlvDataSet, ilog.views.chart.data.IlvDataSource)

setDataSource

public static void setDataSource(IlvDataSet dataSet,
                                 IlvDataSource dataSource)

Sets the main data source of the specified data set. This method is called automatically when the data set is provided by a subclass of IlvAbstractDataSource. You should use it only to implement the IlvDataSource interface directly.

Parameters:

dataSet - The data set.

dataSource - The data source that owns the data set.

Since:

JViews 5.5

See Also:

getDataSource(ilog.views.chart.data.IlvDataSet), getIndex(ilog.views.chart.data.IlvDataSet)

getIndex

@Deprecated
public static int getIndex(IlvDataSet dataSet)

Deprecated. Since JViews 8.7, this method is deprecated. Better use the method IlvChartRenderer.getDataSetMainIndex(IlvDataSet).

Returns the index of the specified data set in its main data source.

Note: This method returns a result that depends more on the history of this data set that on its position in the chart in which is it currently used. Better use the method IlvChartRenderer.getDataSetMainIndex(IlvDataSet).

Parameters:

dataSet - The data set.

Returns:

The index of the data set, or -1 if it does not belong to a data source.

Since:

JViews 5.5

See Also:

getDataSource(ilog.views.chart.data.IlvDataSet), IlvChartRenderer.getDataSetMainIndex(IlvDataSet)

getCSSClasses

public static String getCSSClasses(IlvDataSet dataSet)

Returns the CSS classes of the specified data set. The CSS classes correspond to a predefined property named CSSclass.

Parameters:

dataSet - The data set.

Returns:

The string representing the CSS classes of the data set, separated by ' ', or null if no CSS class is defined.

Since:

JViews 5.5

See Also:

setCSSClasses(ilog.views.chart.data.IlvDataSet, java.lang.String)

setCSSClasses

public static void setCSSClasses(IlvDataSet dataSet,
                                 String CSSclasses)

Sets the CSS classes of the specified data set. The CSS classes correspond to a predefined property named CSSclass.

Parameters:

dataSet - The data set.

CSSclasses - The string representing the CSS classes, separated by ' '.

Since:

JViews 5.5

See Also:

getCSSClasses(ilog.views.chart.data.IlvDataSet)

getPseudoClasses

public static String[] getPseudoClasses(IlvDataSet dataSet)

Returns the pseudo-classes of the specified data set. The pseudo-classes correspond to a predefined property named CSSpseudoClass.

Parameters:

dataSet - A data set.

Since:

JViews 5.5

See Also:

addPseudoClass(ilog.views.chart.data.IlvDataSet, java.lang.String), removePseudoClass(ilog.views.chart.data.IlvDataSet, java.lang.String), IlvChart.getPseudoClasses(IlvDataSet)

setPseudoClasses

public static void setPseudoClasses(IlvDataSet dataSet,
                                    String[] classes)

Sets the pseudo-classes of the specified data set.

Parameters:

dataSet - The data set whose pseudo-classes are to be set.

classes - An array of strings that identify the pseudo-classes to associate with the data set.

Since:

JViews 5.5

See Also:

addPseudoClass(ilog.views.chart.data.IlvDataSet, java.lang.String), removePseudoClass(ilog.views.chart.data.IlvDataSet, java.lang.String), IlvChart.setPseudoClasses(IlvDataSet, String[])

addPseudoClass

public static void addPseudoClass(IlvDataSet dataSet,
                                  String pseudoClass)

Adds a pseudo-class to the specified data set. Pseudo-classes are used during styling to modify the appearance of a data set depending on some state information. For example, you can specify the following rule in a style sheet:

   series:selected {
     color1: red;
   }
 

This rule will be applied when adding the selected pseudo-class to a data set:

   IlvDataSetProperty.addPseudoClass(dataSet, "selected");
 

Parameters:

dataSet - The data set.

pseudoClass - A string that identifies a pseudo-class to add to the classes already associated with the data set.

Since:

JViews 5.5

See Also:

removePseudoClass(ilog.views.chart.data.IlvDataSet, java.lang.String), getPseudoClasses(ilog.views.chart.data.IlvDataSet), IlvChart.addPseudoClass(IlvDataSet, String)

removePseudoClass

public static void removePseudoClass(IlvDataSet dataSet,
                                     String pseudoClass)

Removes a pseudo-class from the specified data set. Pseudo-classes are used during styling to modify the appearance of a data set depending on some state information.

Parameters:

dataSet - The data set.

pseudoClass - A string that identifies a pseudo-class to remove from the classes associated with the data set.

Since:

JViews 5.5

See Also:

addPseudoClass(ilog.views.chart.data.IlvDataSet, java.lang.String), getPseudoClasses(ilog.views.chart.data.IlvDataSet), IlvChart.removePseudoClass(IlvDataSet, String)