ilog.views.chart.servlet

Class IlvAbstractChartHitmapInfoGenerator

java.lang.Object

ilog.views.chart.servlet.IlvAbstractChartHitmapInfoGenerator

All Implemented Interfaces:

IlvHitmapInfoGenerator

Direct Known Subclasses:

IlvAbstractChartNavigationInfoGenerator, IlvAbstractChartTooltipInfoGenerator

public abstract class IlvAbstractChartHitmapInfoGenerator
extends Object
implements IlvHitmapInfoGenerator

This class is the superclass of all classes that generate hitmap information for Charts.

To create new types of information to regions in the hitmap, create a subclass of this class, extend the IlvChartHitmapDefinition.createHitmapInfoGenerator(String, IlvChartHitmap) method, and include the new info type in the IlvHitmapConstants.HIT_INFO parameter of a request.

Since:

JViews 8.8

Constructor Summary

Constructors

Constructor and Description
IlvAbstractChartHitmapInfoGenerator(IlvChartHitmap hitmap) Creates an instance, bound to a given hitmap.

Method Summary

Modifier and Type	Method and Description
String	buildInformation(String infoType) Builds the hitmap information as a string in JSON format.
protected IlvChartHitmap	getHitmap() Returns the already filled IlvChartHitmap.
protected abstract String	getRegionInfo(int region, String infoType) Gets the individual information for a region.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvAbstractChartHitmapInfoGenerator

public IlvAbstractChartHitmapInfoGenerator(IlvChartHitmap hitmap)

Creates an instance, bound to a given hitmap.

Parameters:

hitmap - An already filled IlvChartHitmap.

Method Detail

getHitmap

protected IlvChartHitmap getHitmap()

Returns the already filled IlvChartHitmap.

buildInformation

public String buildInformation(String infoType)

Builds the hitmap information as a string in JSON format. This String object will be returned to client side through the http response.

Specified by:

buildInformation in interface IlvHitmapInfoGenerator

Returns:

The hitmap information of the given type, containing the region infos for all regions and that type.

getRegionInfo

protected abstract String getRegionInfo(int region,
                                        String infoType)

Gets the individual information for a region. The information for the region is a JSON array string.

Parameters:

region - The index denoting a region, an integer in the range 1 .. hitmap.getRegionsCount().

infoType - the hitmap information type.

Returns:

the information for the region.