org.processmining.plugins.log.ui.logoverview

Class LogOverviewVisualizer

java.lang.Object

org.processmining.plugins.log.ui.logoverview.LogOverviewVisualizer

All Implemented Interfaces:

org.processmining.framework.util.ui.scalableview.ScalableComponent, org.processmining.framework.util.ui.scalableview.ScalableComponent.UpdateListener, InteractivityManager

public class LogOverviewVisualizer
extends java.lang.Object
implements org.processmining.framework.util.ui.scalableview.ScalableComponent, InteractivityManager, org.processmining.framework.util.ui.scalableview.ScalableComponent.UpdateListener

Nested Class Summary

Nested classes/interfaces inherited from interface org.processmining.framework.util.ui.scalableview.ScalableComponent

org.processmining.framework.util.ui.scalableview.ScalableComponent.UpdateListener

Constructor Summary

Constructors

Constructor and Description
LogOverviewVisualizer()

Method Summary

Modifier and Type	Method and Description
void	addUpdateListener(org.processmining.framework.util.ui.scalableview.ScalableComponent.UpdateListener listener) Adds an updatelistener to this scalable component.
void	exportToFramework(org.deckfour.xes.model.XLog log, java.lang.String name) Export the provided event log instance to the ProM Framework under the specified name.
java.util.List<Filter>	findAvailableFilters() Find all (annotated) filters that implement the Filter interface.
java.util.List<OverviewVisualizationInitializer>	findAvailableInteractiveVisualizations() Find all (annotated) initializers that are provided to initialize the corresponding interactive visualization.
java.util.SortedSet<EID>	getAllTaggedEvents() Get a set of all tagged events.
javax.swing.JComponent	getComponent() Returns the component that will be scaled using getScale and setScale methods Most implementations will actually override JComponent and return this in this method.
InteractiveVisualization	getCurrentView() Get the currently active interactive visualization.
java.util.Set<java.lang.String>	getInstances(java.lang.String tagName) Get a set of instance names available for the specified tag.
org.deckfour.xes.info.XLogInfo	getLogInfo() Get the XLogInfo instance corresponding to the log.
double	getScale() Returns the current scale.
java.util.Map<java.lang.String,java.util.SortedSet<EID>>	getTag(java.lang.String name) Get a tag.
java.util.Map<java.lang.String,java.util.SortedSet<EID>>	getTagOriginals(java.lang.String name) Additional method used to retrieve the original Event IDs.
java.util.Set<java.lang.String>	getTags() Get a set of available tags.
java.util.Map<java.lang.String,java.util.SortedSet<EID>>	getVisible() Retrieve the stored visible elements.
boolean	isTagEnabled(java.lang.String tagName, java.lang.String instanceName) Check if a tag is currently enabled.
void	removeTag(java.lang.String name) Delete an existing tag.
void	removeUpdateListener(org.processmining.framework.util.ui.scalableview.ScalableComponent.UpdateListener listener) Removes an updatelistener from this scalable component.
void	selectView(InteractiveVisualization view) Change the active interactive visualization to the one specified.
void	setScale(double newScale) Sets the current scale.
void	setTag(java.lang.String name, java.util.Map<java.lang.String,java.util.SortedSet<EID>> collection) Set a new tag or overwrite an existing tag.
void	setTagEnabled(java.lang.String tagName, boolean enable) Enable or disable a complete tag (i.e.
void	setTagInstanceEnabled(java.lang.String tagName, java.lang.String instanceName, boolean enable) Enable or disable an instance of a tag.
void	setVisible(java.util.Map<java.lang.String,java.util.SortedSet<EID>> visibleElements) Stores a collection that defines which elements are currently visible in the active visualization to a tag 'Visible'.
javax.swing.JComponent	showLogOverview(org.processmining.contexts.uitopia.UIPluginContext context, org.deckfour.xes.model.XLog source)
void	updated() This method should be called if the component is updated (layout, content, etc.)
void	updateInteractiveViews(boolean logChanged, boolean tagsChanged) Trigger an update of all interactive views.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogOverviewVisualizer

public LogOverviewVisualizer()

Method Detail

showLogOverview

public javax.swing.JComponent showLogOverview(org.processmining.contexts.uitopia.UIPluginContext context,
                                              org.deckfour.xes.model.XLog source)

findAvailableInteractiveVisualizations

public java.util.List<OverviewVisualizationInitializer> findAvailableInteractiveVisualizations()

Find all (annotated) initializers that are provided to initialize the corresponding interactive visualization.

Returns:

Returns a list of OverviewVisualizationInitializers.

findAvailableFilters

public java.util.List<Filter> findAvailableFilters()

Find all (annotated) filters that implement the Filter interface.

Returns:

Returns a list of Filter instances for use in the modification framework.

getCurrentView

public InteractiveVisualization getCurrentView()

Get the currently active interactive visualization.

Returns:

Returns the active interactive visualization.

selectView

public void selectView(InteractiveVisualization view)

Change the active interactive visualization to the one specified.

Parameters:

view - Interactive visualization to be active.

exportToFramework

public void exportToFramework(org.deckfour.xes.model.XLog log,
                              java.lang.String name)

Export the provided event log instance to the ProM Framework under the specified name.

Parameters:

log - The event log to export.

name - The name for the newly created object.

updateInteractiveViews

public void updateInteractiveViews(boolean logChanged,
                                   boolean tagsChanged)

Description copied from interface: InteractivityManager

Trigger an update of all interactive views. Provided parameters specify which types of data have been changed.

Specified by:

updateInteractiveViews in interface InteractivityManager

Parameters:

logChanged - Indicate whether or not the log has been changed. (e.g. by filtering)

tagsChanged - Indicate whether or not tags have been changed.

getVisible

public java.util.Map<java.lang.String,java.util.SortedSet<EID>> getVisible()

Description copied from interface: InteractivityManager

Retrieve the stored visible elements.

Specified by:

getVisible in interface InteractivityManager

Returns:

Returns the collection of instances that define the visible elements.

setVisible

public void setVisible(java.util.Map<java.lang.String,java.util.SortedSet<EID>> visibleElements)

Description copied from interface: InteractivityManager

Stores a collection that defines which elements are currently visible in the active visualization to a tag 'Visible'.

Specified by:

setVisible in interface InteractivityManager

Parameters:

visibleElements - The collection of instances that are currently visible in the visualization.

getTags

public java.util.Set<java.lang.String> getTags()

Description copied from interface: InteractivityManager

Get a set of available tags.

Specified by:

getTags in interface InteractivityManager

Returns:

Set of tag names.

getInstances

public java.util.Set<java.lang.String> getInstances(java.lang.String tagName)

Description copied from interface: InteractivityManager

Get a set of instance names available for the specified tag.

Specified by:

getInstances in interface InteractivityManager

Parameters:

tagName - Name of the tag.

Returns:

Returns a set of instance names.

getTag

public java.util.Map<java.lang.String,java.util.SortedSet<EID>> getTag(java.lang.String name)

Description copied from interface: InteractivityManager

Get a tag.

Specified by:

getTag in interface InteractivityManager

Parameters:

name - Name of the tag.

Returns:

Returns the collection of instances of the tag.

getTagOriginals

public java.util.Map<java.lang.String,java.util.SortedSet<EID>> getTagOriginals(java.lang.String name)

Additional method used to retrieve the original Event IDs. Via this method, the Event IDs will not be converted to the current state of the FilterLog.

Parameters:

name - Name of the tag.

Returns:

Returns the original set of Event IDs for the given tag.

setTag

public void setTag(java.lang.String name,
                   java.util.Map<java.lang.String,java.util.SortedSet<EID>> collection)

Description copied from interface: InteractivityManager

Set a new tag or overwrite an existing tag.

Specified by:

setTag in interface InteractivityManager

Parameters:

name - Name of the tag.

collection - Collection of instances to be tagged.

removeTag

public void removeTag(java.lang.String name)

Description copied from interface: InteractivityManager

Delete an existing tag.

Specified by:

removeTag in interface InteractivityManager

Parameters:

name - Name of the tag.

setTagEnabled

public void setTagEnabled(java.lang.String tagName,
                          boolean enable)

Description copied from interface: InteractivityManager

Enable or disable a complete tag (i.e. all instances of the tag).

Specified by:

setTagEnabled in interface InteractivityManager

Parameters:

tagName - Name of the tag.

enable - Enable (true) or disable (false).

setTagInstanceEnabled

public void setTagInstanceEnabled(java.lang.String tagName,
                                  java.lang.String instanceName,
                                  boolean enable)

Description copied from interface: InteractivityManager

Enable or disable an instance of a tag.

Specified by:

setTagInstanceEnabled in interface InteractivityManager

Parameters:

tagName - Name of the tag.

instanceName - Name of the instance.

enable - Enable (true) or disable (false).

isTagEnabled

public boolean isTagEnabled(java.lang.String tagName,
                            java.lang.String instanceName)

Description copied from interface: InteractivityManager

Check if a tag is currently enabled.

Specified by:

isTagEnabled in interface InteractivityManager

Parameters:

tagName - Name of the tag.

instanceName - Name of the instance.

Returns:

Returns true if the instance of a tag is enabled, or false if it is disabled.

getAllTaggedEvents

public java.util.SortedSet<EID> getAllTaggedEvents()

Description copied from interface: InteractivityManager

Get a set of all tagged events. (Of tags that are currently enabled.)

Specified by:

getAllTaggedEvents in interface InteractivityManager

Returns:

Returns an ordered set of events (Event IDs).

getLogInfo

public org.deckfour.xes.info.XLogInfo getLogInfo()

Description copied from interface: InteractivityManager

Get the XLogInfo instance corresponding to the log.

Specified by:

getLogInfo in interface InteractivityManager

Returns:

Returns the XLogInfo (log summary) for the log.

getComponent

public javax.swing.JComponent getComponent()

Description copied from interface: org.processmining.framework.util.ui.scalableview.ScalableComponent

Returns the component that will be scaled using getScale and setScale methods Most implementations will actually override JComponent and return this in this method.

Specified by:

getComponent in interface org.processmining.framework.util.ui.scalableview.ScalableComponent

Returns:

a component

getScale

public double getScale()

Description copied from interface: org.processmining.framework.util.ui.scalableview.ScalableComponent

Returns the current scale.

Specified by:

getScale in interface org.processmining.framework.util.ui.scalableview.ScalableComponent

Returns:

the current scale as a double

setScale

public void setScale(double newScale)

Description copied from interface: org.processmining.framework.util.ui.scalableview.ScalableComponent

Sets the current scale.

Specified by:

setScale in interface org.processmining.framework.util.ui.scalableview.ScalableComponent

addUpdateListener

public void addUpdateListener(org.processmining.framework.util.ui.scalableview.ScalableComponent.UpdateListener listener)

Description copied from interface: org.processmining.framework.util.ui.scalableview.ScalableComponent

Adds an updatelistener to this scalable component. This listener will be updated as soon as the contents of the component change, i.e. if the component

Specified by:

addUpdateListener in interface org.processmining.framework.util.ui.scalableview.ScalableComponent

removeUpdateListener

public void removeUpdateListener(org.processmining.framework.util.ui.scalableview.ScalableComponent.UpdateListener listener)

Description copied from interface: org.processmining.framework.util.ui.scalableview.ScalableComponent

Removes an updatelistener from this scalable component.

Specified by:

removeUpdateListener in interface org.processmining.framework.util.ui.scalableview.ScalableComponent

updated

public void updated()

Description copied from interface: org.processmining.framework.util.ui.scalableview.ScalableComponent.UpdateListener

This method should be called if the component is updated (layout, content, etc.)

Specified by:

updated in interface org.processmining.framework.util.ui.scalableview.ScalableComponent.UpdateListener