|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.processmining.analysis.recommendation.contrib.RecommendationContributor
public abstract class RecommendationContributor
An instance abstraction is an entity which, based on a specific subset of information available to it, can calculate a set of recommendations for a provided query.
Typically a recommendation contributor will cluster a set of somewhat comparable process instances, and return recommendations based on their common characteristics.
Field Summary | |
---|---|
protected LogAbstractionFactory |
logAbstractionFactory
logAbstractor that takes care of the abstraction of the entire log, as well as any offered query |
protected java.util.List<LogAbstraction> |
logAbstractions
logAbstractor that takes care of the abstraction of the entire log, as well as any offered query |
protected ProcessInstanceScale |
scale
The scale which is used to calculate the weight of this contributor based on the contained process instances' weights as their sum. |
Constructor Summary | |
---|---|
RecommendationContributor()
|
Method Summary | |
---|---|
abstract RecommendationResult |
generateFilteredRecommendations(RecommendationQuery query,
java.lang.String process)
|
RecommendationResult |
generateRecommendations(RecommendationQuery query,
java.lang.String process)
This method calculates this instance's contributions to a specified query, i.e. |
abstract java.lang.String |
getHtmlDescription()
Gets a description of this plugin in HTML. |
abstract java.lang.String |
getName()
Gets the name of this plugin. |
ProcessInstanceScale |
getScale()
|
void |
initialize(LogReader log,
ProcessInstanceScale scale)
|
void |
setScale(ProcessInstanceScale aScale)
Sets the scale used for weighing this contributor based on the contained process instances. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected ProcessInstanceScale scale
protected java.util.List<LogAbstraction> logAbstractions
protected LogAbstractionFactory logAbstractionFactory
Constructor Detail |
---|
public RecommendationContributor()
Method Detail |
---|
public ProcessInstanceScale getScale()
public void setScale(ProcessInstanceScale aScale)
aScale
- a process instance scale.public void initialize(LogReader log, ProcessInstanceScale scale) throws NoFactoryException
NoFactoryException
public RecommendationResult generateRecommendations(RecommendationQuery query, java.lang.String process)
query
- The query to which recommendations are inquired.process
- The process name the query refers to
RecommendationResult
container.public abstract RecommendationResult generateFilteredRecommendations(RecommendationQuery query, java.lang.String process)
public abstract java.lang.String getName()
getName
in interface Plugin
public abstract java.lang.String getHtmlDescription()
html
, head
and
body
tags should not be used.
This HTML page is displayed in the help system or as context sensitive help.
The HTML body can be stored in an external file in the /lib/documentation/ sub
folder and in this case it can be obtained by calling PluginDocumentationLoader.load(this)
getHtmlDescription
in interface Plugin
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |