ilog.views.chart.servlet

Class IlvDefaultIMapDefinition

java.lang.Object

ilog.views.chart.servlet.IlvIMapDefinition

ilog.views.chart.servlet.IlvDefaultIMapDefinition

public class IlvDefaultIMapDefinition
extends IlvIMapDefinition

The IlvDefaultIMapDefinition class can be used to generate image maps by specifying an association between data sets and area attributes.

Since:

JViews 5.0

Field Summary

Fields inherited from class ilog.views.chart.servlet.IlvIMapDefinition

DATASET_MAP, POINT_MAP

Constructor Summary

Constructors

Constructor and Description
IlvDefaultIMapDefinition(IlvDataSet[] dataSets, IlvIMapAttributes[] attr) Initializes a definition to generate areas for all the points of the specified data sets.
IlvDefaultIMapDefinition(IlvDataSet[] dataSets, IlvIMapAttributes[][] attr) Initializes a definition to generate areas for all the points of the specified data sets.
IlvDefaultIMapDefinition(IlvDataSet dataSet, IlvIMapAttributes attr) Initializes a definition to generate areas for all the points of the specified data sets.
IlvDefaultIMapDefinition(IlvDataSetPoint[] dataPoints, IlvIMapAttributes[] attr) Initializes a definition to generate areas for the specified data points.
IlvDefaultIMapDefinition(Map<?,? extends IlvIMapAttributes> itemsAttributes) Initializes a definition to generate areas for the specified legend items or tree model nodes.

Method Summary

Modifier and Type	Method and Description
IlvIMapAttributes	getAttributes(IlvDataSetPoint dp) Returns the area attributes for the specified point.
IlvIMapAttributes	getAttributes(IlvLegendItem item) Returns the area attributes for the specified legend item.
IlvIMapAttributes	getAttributes(IlvTreeListModel model, TreePath path) Returns the area attributes for the specified tree model element.
boolean	mustGenerate(IlvChartRenderer r) Indicates whether areas should be generated for the specified renderer.
void	setLegendItemAttributes(Map<IlvLegendItem,? extends IlvIMapAttributes> itemsAttributes) Sets the legend items attributes for this area definition.
void	setTreeNodeAttributes(Map<Object,? extends IlvIMapAttributes> nodesAttributes) Sets the tree node attributes for this area definition.

Methods inherited from class ilog.views.chart.servlet.IlvIMapDefinition

getCircleRadius, getType, isChartOrigin, setChartOrigin, setCircleRadius

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvDefaultIMapDefinition

public IlvDefaultIMapDefinition(IlvDataSet dataSet,
                                IlvIMapAttributes attr)

Initializes a definition to generate areas for all the points of the specified data sets. The type of the definition is IlvIMapDefinition.DATASET_MAP.

Parameters:

dataSet - The considered data set.

attr - The attributes for all the data points.

IlvDefaultIMapDefinition

public IlvDefaultIMapDefinition(IlvDataSet[] dataSets,
                                IlvIMapAttributes[] attr)

Initializes a definition to generate areas for all the points of the specified data sets. The type of the definition is IlvIMapDefinition.DATASET_MAP.

Parameters:

dataSets - The considered data sets.

attr - The attributes for the data points. Each element in the array represents the attribute for all the points of the corresponding data set in the dataSets parameter.

Throws:

IllegalArgumentException - If dataSets and attr do not have the same length.

IlvDefaultIMapDefinition

public IlvDefaultIMapDefinition(IlvDataSet[] dataSets,
                                IlvIMapAttributes[][] attr)

Initializes a definition to generate areas for all the points of the specified data sets. The type of the definition is IlvIMapDefinition.POINT_MAP.

Parameters:

dataSets - The considered data sets.

attr - The attributes for the data points, specified in a two-dimensional array:

• The outer index represents the data set index in the dataSets parameter.
• The inner index represents the data point index within the data set.

Throws:

IllegalArgumentException - If the dataSets and attr do not have the same length, or if the inner dimensions of attr do not match the number of data points in the corresponding data set.

IlvDefaultIMapDefinition

public IlvDefaultIMapDefinition(IlvDataSetPoint[] dataPoints,
                                IlvIMapAttributes[] attr)

Initializes a definition to generate areas for the specified data points. The type of the definition is IlvIMapDefinition.POINT_MAP.

Parameters:

dataPoints - The considered data points.

attr - The attributes for the data points.

Throws:

IllegalArgumentException - If the dataPoints and attr do not have the same length.

IlvDefaultIMapDefinition

public IlvDefaultIMapDefinition(Map<?,? extends IlvIMapAttributes> itemsAttributes)

Initializes a definition to generate areas for the specified legend items or tree model nodes.

Parameters:

itemsAttributes - A Map containing the area attributes as an object-attributes binding. This map is not copied.

Since:

JViews 5.5

Method Detail

setTreeNodeAttributes

public void setTreeNodeAttributes(Map<Object,? extends IlvIMapAttributes> nodesAttributes)

Sets the tree node attributes for this area definition.

Parameters:

nodesAttributes - A Map containing the area attributes as a node-attributes binding. This map is not copied.

Since:

JViews 7.5

setLegendItemAttributes

public void setLegendItemAttributes(Map<IlvLegendItem,? extends IlvIMapAttributes> itemsAttributes)

Sets the legend items attributes for this area definition.

Parameters:

itemsAttributes - A Map containing the area attributes as an item-attributes binding. This map is not copied.

Since:

JViews 5.5

mustGenerate

public boolean mustGenerate(IlvChartRenderer r)

Indicates whether areas should be generated for the specified renderer.

Specified by:

mustGenerate in class IlvIMapDefinition

getAttributes

public IlvIMapAttributes getAttributes(IlvDataSetPoint dp)

Returns the area attributes for the specified point.

Specified by:

getAttributes in class IlvIMapDefinition

getAttributes

public IlvIMapAttributes getAttributes(IlvTreeListModel model,
                                       TreePath path)

Returns the area attributes for the specified tree model element.

Specified by:

getAttributes in class IlvIMapDefinition

Parameters:

model - The tree model.

path - A tree path starting at the tree model root and ending at the specific tree model node.

Since:

JViews 7.5

getAttributes

public IlvIMapAttributes getAttributes(IlvLegendItem item)

Returns the area attributes for the specified legend item.

Specified by:

getAttributes in class IlvIMapDefinition

Since:

JViews 5.5