|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.processmining.analysis.recommendation.SingleProcessAcceptor
org.processmining.analysis.recommendation.LogBasedRecommendation
public class LogBasedRecommendation
Title:
Description:
Copyright: Copyright (c) 2004
Company:
Constructor Summary | |
---|---|
LogBasedRecommendation()
|
Method Summary | |
---|---|
protected javax.swing.JComponent |
analyse(LogReader log)
analyse |
java.lang.String |
getHtmlDescription()
Gets a description of this plugin in HTML. |
java.lang.String |
getName()
Gets the name of this plugin. |
RecommendationResult |
getRecommendation(RecommendationQuery query)
This is the main query method, which can be used to retrieve recommendations for specific queries. |
void |
signalPickedResult(RecommendationResult recommendationResult,
int _int)
This method may be used to let the recommendation provider know, which of the provided results has been picked by the requesting party finally. |
void |
signalPickedResult(RecommendationResult result,
Recommendation picked)
This method may be used to let the recommendation provider know, which of the provided results has been picked by the requesting party finally. |
Methods inherited from class org.processmining.analysis.recommendation.SingleProcessAcceptor |
---|
analyse, getInputItems, isOneProcess |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LogBasedRecommendation()
Method Detail |
---|
protected javax.swing.JComponent analyse(LogReader log)
analyse
in class SingleProcessAcceptor
log
- LogReader
public java.lang.String getHtmlDescription()
Plugin
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
public java.lang.String getName()
Plugin
getName
in interface Plugin
public RecommendationResult getRecommendation(RecommendationQuery query) throws java.io.IOException, java.lang.Exception
RecommendationProvider
This is the main query method, which can be used to retrieve recommendations for specific queries. All communication and encoding of parameters can be assumed to be performed in subclasses implementing this interface.
Note: This method may block for an unspecified time, including network
transport and resolving the query on the provider side. Use this method in a separate
thread if you wish your application to remain responsive.
Also note that the query can fail, both due to transmission errors (which will yield
an IOException
, and due to the provider's inability to resolve the query
(i.e., an error occurred while handling the issued request, signaled by an ordinary
Exception
being thrown; or, the query did not yield any usable result,
which results in a null
response value.
getRecommendation
in interface RecommendationProvider
query
- The query for recommendations.
null
, of no result could be obtained (may also be empty result list).
java.io.IOException
- Signals an error due to network transport problems.
java.lang.Exception
- Signals an error in the recommendation provider implementation.public void signalPickedResult(RecommendationResult recommendationResult, int _int)
RecommendationProvider
This method may be used to let the recommendation provider know, which of the provided results has been picked by the requesting party finally. The provider will use this information for logging purposes, or to improve future results.
signalPickedResult
in interface RecommendationProvider
recommendationResult
- The result set which has been delivered earlier on._int
- Index of the result which has been picked for usage in the result set.
If the given index is negative, the semantics are that the requesting party has picked
neither of the provided recommendations, i.e. ignored them or found them not useful.public void signalPickedResult(RecommendationResult result, Recommendation picked)
RecommendationProvider
This method may be used to let the recommendation provider know, which of the provided results has been picked by the requesting party finally. The provider will use this information for logging purposes, or to improve future results.
signalPickedResult
in interface RecommendationProvider
result
- The result set which has been delivered earlier on.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |