Package com.storedobject.chart

Class Event

java.lang.Object

com.storedobject.chart.Event

public final class Event
extends Object

Represents an event that occurs in a chart. A ChartEvent encapsulates the type of the event, the ID of the part of the chart related to the event, and optionally, any additional data related to the event.

Author:

Syam

Constructor Summary

Constructors

Constructor	Description
Event(SOChart soChart, EventType type, Object userData)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addData(String key, Object data)	Adds a key-value pair to the additional data associated with the chart event.
Map<String,Object>	getData()	Retrieves the additional data associated with the event.
SOChart	getSOChart()	Retrieves the SOChart instance associated with this chart event.
EventType	getType()	Retrieves the type of the chart event.
Object	getUserData()	Retrieves the user-specific data associated with the event.
void	setData(Map<String,Object> data)	Sets the additional data associated with the event.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

Event

public Event(SOChart soChart,
 EventType type,
 Object userData)

Constructor.

Parameters:

soChart - The SOChart instance associated with the event.

type - The type of the event as a ChartEventType.

userData - The user-specific data associated with the event.

Method Details

getSOChart

public SOChart getSOChart()

Retrieves the SOChart instance associated with this chart event.

Returns:

The SOChart instance linked to this event.

getType

public EventType getType()

Retrieves the type of the chart event.

Returns:

The type of the chart event as a ChartEventType.

getData

public Map<String,Object> getData()

Retrieves the additional data associated with the event.

Note: The associated data depends on the type of event and event category.

Returns:

The data associated with the event.

addData

public void addData(String key,
 Object data)

Adds a key-value pair to the additional data associated with the chart event. If the data map is not initialized, it will create a new one before adding the entry.

Parameters:

key - The key representing the data entry.

data - The value associated with the key.

toString

public String toString()

Overrides:

toString in class Object

setData

public void setData(Map<String,Object> data)

Sets the additional data associated with the event.

Parameters:

data - The data to be associated with the event.

getUserData

public Object getUserData()

Retrieves the user-specific data associated with the event.

Returns:

The user-specific data as an Object.