org.askalon.graph.chart
Interface XMLEventChart

All Superinterfaces:

Chart, Cleanable, OrderedChart, SectionChart, XYXMLChart

public interface XMLEventChart
extends XYXMLChart, OrderedChart

Interface for the xml-event chart, which supports to add events from multiple sources with a timestamp, to link events and add additional attributes for descriptions.
In this chart the Y-axis represents the sources that generate events and the X-axis stands for the time at which an event is generated. If events are connected to each other, this is indicated by an connecting line.

Author:

Georg Schild and Franz Endstrasser

Method Summary

void	addAttribute(int section, String event, String key, String value) Adds an attribute to an event, that will be shown in the events description.
void	addEvent(int section, String event_id, long timestamp, Map<String,String> attributes) Adds a new event from a source at a certain timestamp, adding (optional) attributes for descriptions.
void	addLink(int source_section, String source_id, int dest_section, String dest_id) Adds a link from an event of the entity source to an event of the entity dest.
Map<String,String>	getAttributes(int section, String event) Gets a copy of the attributes of the chosen node
boolean	isArrowsShown() Returns whether the arrows are shown or hidden by the chart.
boolean	isGradientLinks() Gets to current coloring mode of event links.
void	removeEventSource(int section) Removes one source (entity) with all its events and links.
void	setArrowsShown(boolean b) Enables/disables the arrow-view of the chart.
void	setGradientLinks(boolean b) Sets the color of links to gradient mode, where the link-lines are colored using a gradient color from the sources color to the destination color.

Methods inherited from interface org.askalon.graph.chart.XYXMLChart

getLinkLineWidth, getNodeType, setLinkLineWidth, setNodeType

Methods inherited from interface org.askalon.graph.chart.SectionChart

getSectionColor, getSectionCount, getSectionName, isVisible, setSectionColor, setSectionName, setVisible

Methods inherited from interface org.askalon.graph.chart.Chart

getChartConfiguration, getChartMenu, getChartName, getLegend, getUnit, getXAxisText, getYAxisText, isDisableUpdate, isEdgesVisible, refreshConfiguration, resetConfiguration, setChartConfiguration, setDisableUpdate, setEdgesVisible, setUnit, setXAxisText, setYAxisText

Methods inherited from interface org.askalon.graph.chart.base.Cleanable

cleanUp

Methods inherited from interface org.askalon.graph.chart.OrderedChart

decrementOrder, getOrder, incrementOrder, setOrder

Methods inherited from interface org.askalon.graph.chart.SectionChart

getSectionColor, getSectionCount, getSectionName, isVisible, setSectionColor, setSectionName, setVisible

Methods inherited from interface org.askalon.graph.chart.Chart

getChartConfiguration, getChartMenu, getChartName, getLegend, getUnit, getXAxisText, getYAxisText, isDisableUpdate, isEdgesVisible, refreshConfiguration, resetConfiguration, setChartConfiguration, setDisableUpdate, setEdgesVisible, setUnit, setXAxisText, setYAxisText

Methods inherited from interface org.askalon.graph.chart.base.Cleanable

cleanUp

Method Detail

addLink

void addLink(int source_section,
             String source_id,
             int dest_section,
             String dest_id)

Adds a link from an event of the entity source to an event of the entity dest.

Parameters:

source_section - id of the source entity

source_id - id of the source event

dest_section - id of the destination entity

dest_id - id of the destination event

addEvent

void addEvent(int section,
              String event_id,
              long timestamp,
              Map<String,String> attributes)

Adds a new event from a source at a certain timestamp, adding (optional) attributes for descriptions.

Parameters:

section - the section of the source in which this event should be contained

event_id - the id of this new event, will delete old event if already one exists with this id

timestamp - timestamp of the event, determining it's x-position

attributes - (optional) additional attributes for description of the event

addAttribute

void addAttribute(int section,
                  String event,
                  String key,
                  String value)

Adds an attribute to an event, that will be shown in the events description.

Parameters:

section - the section id of the source of this event

event - the id of the event

key - the key for the new attribute

value - the text of the attribute

getAttributes

Map<String,String> getAttributes(int section,
                                 String event)

Gets a copy of the attributes of the chosen node

Parameters:

section -

event -

Returns:

attributes of chosen node

removeEventSource

void removeEventSource(int section)

Removes one source (entity) with all its events and links.

Parameters:

section - the id of the source which should be removed

setGradientLinks

void setGradientLinks(boolean b)

Sets the color of links to gradient mode, where the link-lines are colored using a gradient color from the sources color to the destination color.

Parameters:

b - true to enable gradients, false to use black colored links

See Also:

isGradientLinks()

isGradientLinks

boolean isGradientLinks()

Gets to current coloring mode of event links.

Returns:

true if links use a gradient for their coloring

See Also:

setGradientLinks(boolean)

setArrowsShown

void setArrowsShown(boolean b)

Enables/disables the arrow-view of the chart. If the value is set to true, links between events are visualised as arrows.

Parameters:

b - true to show arrows, false to hide the arrows

See Also:

isArrowsShown()

isArrowsShown

boolean isArrowsShown()

Returns whether the arrows are shown or hidden by the chart.

Returns:

true if the arrows visible, false if they aren't