org.processmining.operationalsupport.provider

Interface Provider

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

AbstractProvider, RandomProvider, TestProvider

public interface Provider
extends java.io.Serializable

Providers must implement this. You may benefit from using AbstractProvider as base. Implementations should not store intermediate values locally, but use the provided session, as they may be invoked with several sessions. Preferably, providers should not make the methods defined in this interface synchronized (as they may take long to execute, but are accessed by many independent threads), but rather use a more fine-grained locking mechanism (e.g., synchronize on a shared data-structure and only around accesses).

If providers need to access a Session between invocations, they MUST call the getLock().lock() method on the session prior to any reads/writes. This is not necessary for access inside any call defined in this intertface, as the OSService takes care of locking and unlocking the Session.

Providers must be serializable, and should not refer to GUI resources/threads etc. except using transient fields that will be clear after deserialization. Use a private method readResolve to reestablish transient fields (defined by Java serialization). The writeObject and writeObject methods are NOT used for serialization in ProM.

Author:

mwesterg

Method Summary

Modifier and Type	Method and Description
boolean	accept(Session session, java.util.List<java.lang.String> modelLanguages, java.util.List<java.lang.String> queryLanguages, java.lang.Object model)
<R,L,P> Prediction<R>	comparison(Session session, org.deckfour.xes.model.XLog availableItems, java.lang.String language, L query, P projection, boolean done)
void	destroy(Session session)
java.lang.String	getName()
OSService	getOwner()
<R,L,P> Prediction<R>	predict(Session session, org.deckfour.xes.model.XLog availableItems, java.lang.String language, L query, P projection, boolean done)
<R,L,P,E> Recommendation<R>	recommend(Session session, org.deckfour.xes.model.XLog availableItems, java.lang.String language, L query, P projection, E evaluator, boolean done)
<R,L> R	simple(Session session, org.deckfour.xes.model.XLog availableItems, java.lang.String language, L query, boolean done)
void	updateTrace(Session session, org.deckfour.xes.model.XTrace trace) Called whenever new events arrive to allow incremental update without having to handle all queries.

Method Detail

accept

boolean accept(Session session,
               java.util.List<java.lang.String> modelLanguages,
               java.util.List<java.lang.String> queryLanguages,
               java.lang.Object model)

comparison

<R,L,P> Prediction<R> comparison(Session session,
                                 org.deckfour.xes.model.XLog availableItems,
                                 java.lang.String language,
                                 L query,
                                 P projection,
                                 boolean done)
                          throws java.lang.Exception

Throws:

java.lang.Exception

destroy

void destroy(Session session)

getName

java.lang.String getName()

getOwner

OSService getOwner()

predict

<R,L,P> Prediction<R> predict(Session session,
                              org.deckfour.xes.model.XLog availableItems,
                              java.lang.String language,
                              L query,
                              P projection,
                              boolean done)
                       throws java.lang.Exception

Throws:

java.lang.Exception

recommend

<R,L,P,E> Recommendation<R> recommend(Session session,
                                      org.deckfour.xes.model.XLog availableItems,
                                      java.lang.String language,
                                      L query,
                                      P projection,
                                      E evaluator,
                                      boolean done)
                               throws java.lang.Exception

Throws:

java.lang.Exception

simple

<R,L> R simple(Session session,
               org.deckfour.xes.model.XLog availableItems,
               java.lang.String language,
               L query,
               boolean done)
        throws java.lang.Exception

Throws:

java.lang.Exception

updateTrace

void updateTrace(Session session,
                 org.deckfour.xes.model.XTrace trace)

Called whenever new events arrive to allow incremental update without having to handle all queries. Can be called after accept and before any query and destroy. Only called with non-null, non-empty trace.

Parameters:

trace -