org.processmining.operationalsupport.client

Class SessionHandle<M,R,L,P,E>

java.lang.Object

org.processmining.operationalsupport.client.SessionHandle<M,R,L,P,E>

Type Parameters:

M - Modeling langauge

R - Result type

L - Query language

P - Projection type

E - Evaluator type

public class SessionHandle<M,R,L,P,E>
extends java.lang.Object

High-level interface. Takes care of connection/disconnecting automatically, but you should call close when you are done. A session can be reconnected until any query function has been called with the done parameter set to true.

Author:

mwesterg

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PORT

Constructor Summary

Constructors

Constructor and Description
SessionHandle(java.lang.String host, int port, QueryLanguage<R,L,P,E> queryLanguage, java.util.Map<java.lang.String,?> properties)

Method Summary

Modifier and Type	Method and Description
void	addAllEvents(org.deckfour.xes.model.XTrace events)
void	addEvent(org.deckfour.xes.model.XEvent event)
void	addModelLanguage(Language<?> language)
void	addModelLanguage(java.lang.String mimeType)
void	addProperties(java.util.Map<java.lang.String,?> properties)
void	addProperty(java.lang.String key, java.lang.Object value) Set a property; this need to be called for all properties before a connection is made (i.e., before any query method is called).
void	addQueryLanguage(QueryLanguage<?,?,?,?> langauge)
void	addQueryLanguage(java.lang.String mimeType)
void	close()
ResponseSet<Prediction<R>>	compare(L query, P projection, org.deckfour.xes.model.XLog availableItems)
ResponseSet<Prediction<R>>	compare(L query, P projection, org.deckfour.xes.model.XLog availableItems, boolean done)
<RR,LL,PP,EE> ResponseSet<Prediction<RR>>	compare(QueryLanguage<RR,LL,PP,EE> queryLanguage, LL query, PP projection, org.deckfour.xes.model.XLog availableItems)
<RR,LL,PP,EE> ResponseSet<Prediction<RR>>	compare(QueryLanguage<RR,LL,PP,EE> queryLanguage, LL query, PP projection, org.deckfour.xes.model.XLog availableItems, boolean done)
void	connect()
static <M> SessionHandle<M,?,?,?,?>	create()
static <M,R,L,P,E> SessionHandle<M,R,L,P,E>	create(QueryLanguage<R,L,P,E> queryLanguage)
static <M,R,L,P,E> SessionHandle<M,R,L,P,E>	create(QueryLanguage<R,L,P,E> queryLanguage, java.util.Map<java.lang.String,?> properties)
static <M> SessionHandle<M,?,?,?,?>	create(java.lang.String host, int port)
static <M> SessionHandle<M,?,?,?,?>	create(java.lang.String host, int port, java.util.Map<java.lang.String,?> properties)
static <M,R,L,P,E> SessionHandle<M,R,L,P,E>	create(java.lang.String host, int port, QueryLanguage<R,L,P,E> queryLanguage)
static <M,R,L,P,E> SessionHandle<M,R,L,P,E>	create(java.lang.String host, int port, QueryLanguage<R,L,P,E> queryLanguage, java.util.Map<java.lang.String,?> properties)
SessionHandle<M,R,L,P,E>	createCopy()
static org.deckfour.xes.model.XLog	createLog()
static org.deckfour.xes.model.XEvent	createSingleEvent(java.lang.String name, org.deckfour.xes.extension.std.XLifecycleExtension.StandardModel transition)
static org.deckfour.xes.model.XLog	createSingleEventLog(java.lang.String name, org.deckfour.xes.extension.std.XLifecycleExtension.StandardModel transition)
static org.deckfour.xes.model.XTrace	createSingleEventTrace(java.lang.String name, org.deckfour.xes.extension.std.XLifecycleExtension.StandardModel transition)
static void	main(java.lang.String[] args)
ResponseSet<Prediction<R>>	predict(L query, P projection, org.deckfour.xes.model.XLog availableItems)
ResponseSet<Prediction<R>>	predict(L query, P projection, org.deckfour.xes.model.XLog availableItems, boolean done)
<RR,LL,PP,EE> ResponseSet<Prediction<RR>>	predict(QueryLanguage<RR,LL,PP,EE> queryLanguage, LL query, PP projection, org.deckfour.xes.model.XLog availableItems)
<RR,LL,PP,EE> ResponseSet<Prediction<RR>>	predict(QueryLanguage<RR,LL,PP,EE> queryLanguage, LL query, PP projection, org.deckfour.xes.model.XLog availableItems, boolean done)
ResponseSet<Recommendation<R>>	recommend(L query, P projection, E evaluator, org.deckfour.xes.model.XLog availableItems)
ResponseSet<Recommendation<R>>	recommend(L query, P projection, E evaluator, org.deckfour.xes.model.XLog availableItems, boolean done)
<RR,LL,PP,EE> ResponseSet<Recommendation<RR>>	recommend(QueryLanguage<RR,LL,PP,EE> queryLanguage, LL query, PP projection, EE evaluator, org.deckfour.xes.model.XLog availableItems)
<RR,LL,PP,EE> ResponseSet<Recommendation<RR>>	recommend(QueryLanguage<RR,LL,PP,EE> queryLanguage, LL query, PP projection, EE evaluator, org.deckfour.xes.model.XLog availableItems, boolean done)
void	setDone()
void	setModel(Language<? extends M> modelingLanguage, M model)
ResponseSet<R>	simple(L query, org.deckfour.xes.model.XLog availableItems)
ResponseSet<R>	simple(L query, org.deckfour.xes.model.XLog availableItems, boolean done)
<LL,RR> ResponseSet<RR>	simple(QueryLanguage<RR,LL,?,?> queryLanguage, LL query, org.deckfour.xes.model.XLog availableItems)
<LL,RR> ResponseSet<RR>	simple(QueryLanguage<RR,LL,?,?> queryLanguage, LL query, org.deckfour.xes.model.XLog availableItems, boolean done)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

Constant Field Values

Constructor Detail

SessionHandle

public SessionHandle(java.lang.String host,
                     int port,
                     QueryLanguage<R,L,P,E> queryLanguage,
                     java.util.Map<java.lang.String,?> properties)
              throws java.net.UnknownHostException

Parameters:

host -

port -

queryLanguage -

properties -

Throws:

java.net.UnknownHostException

Method Detail

create

public static <M> SessionHandle<M,?,?,?,?> create()
                                           throws java.net.UnknownHostException

Throws:

java.net.UnknownHostException

See Also:

with all parameters

create

public static <M,R,L,P,E> SessionHandle<M,R,L,P,E> create(QueryLanguage<R,L,P,E> queryLanguage)
                                                   throws java.net.UnknownHostException

Throws:

java.net.UnknownHostException

See Also:

with all parameters

create

public static <M,R,L,P,E> SessionHandle<M,R,L,P,E> create(QueryLanguage<R,L,P,E> queryLanguage,
                                                          java.util.Map<java.lang.String,?> properties)
                                                   throws java.net.UnknownHostException

Throws:

java.net.UnknownHostException

See Also:

with all parameters

create

public static <M> SessionHandle<M,?,?,?,?> create(java.lang.String host,
                                                  int port)
                                           throws java.net.UnknownHostException

Throws:

java.net.UnknownHostException

See Also:

with all parameters

create

public static <M> SessionHandle<M,?,?,?,?> create(java.lang.String host,
                                                  int port,
                                                  java.util.Map<java.lang.String,?> properties)
                                           throws java.net.UnknownHostException

Throws:

java.net.UnknownHostException

See Also:

with all parameters

create

public static <M,R,L,P,E> SessionHandle<M,R,L,P,E> create(java.lang.String host,
                                                          int port,
                                                          QueryLanguage<R,L,P,E> queryLanguage)
                                                   throws java.net.UnknownHostException

Throws:

java.net.UnknownHostException

See Also:

with all parameters

create

public static <M,R,L,P,E> SessionHandle<M,R,L,P,E> create(java.lang.String host,
                                                          int port,
                                                          QueryLanguage<R,L,P,E> queryLanguage,
                                                          java.util.Map<java.lang.String,?> properties)
                                                   throws java.net.UnknownHostException

Type Parameters:

M - modeling lanaguage class

R - response langauge class

L - query langauge class

Parameters:

host - host running OSS

port - port on which OSS is running (defualt 1202)

queryLanguage - query language (defines and )

properties - extra properties to put in initial session

Returns:

a session handle matching given parameters

Throws:

java.net.UnknownHostException - if the OSS cannot be contacted on the given host

createLog

public static org.deckfour.xes.model.XLog createLog()

createSingleEvent

public static org.deckfour.xes.model.XEvent createSingleEvent(java.lang.String name,
                                                              org.deckfour.xes.extension.std.XLifecycleExtension.StandardModel transition)

Parameters:

name -

transition -

Returns:

createSingleEventLog

public static org.deckfour.xes.model.XLog createSingleEventLog(java.lang.String name,
                                                               org.deckfour.xes.extension.std.XLifecycleExtension.StandardModel transition)

Parameters:

name -

transition -

Returns:

createSingleEventTrace

public static org.deckfour.xes.model.XTrace createSingleEventTrace(java.lang.String name,
                                                                   org.deckfour.xes.extension.std.XLifecycleExtension.StandardModel transition)

Parameters:

name -

transition -

Returns:

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException,
                        InvocationException,
                        SessionClosedException

Parameters:

args -

Throws:

java.io.IOException

InvocationException

SessionClosedException

addAllEvents

public void addAllEvents(org.deckfour.xes.model.XTrace events)
                  throws InvocationException

Parameters:

events -

Throws:

InvocationException

addEvent

public void addEvent(org.deckfour.xes.model.XEvent event)
              throws InvocationException

Parameters:

event -

Throws:

InvocationException

addModelLanguage

public void addModelLanguage(Language<?> language)

addModelLanguage

public void addModelLanguage(java.lang.String mimeType)

addProperties

public void addProperties(java.util.Map<java.lang.String,?> properties)

addProperty

public void addProperty(java.lang.String key,
                        java.lang.Object value)

Set a property; this need to be called for all properties before a connection is made (i.e., before any query method is called).

Parameters:

key -

value -

addQueryLanguage

public void addQueryLanguage(QueryLanguage<?,?,?,?> langauge)

addQueryLanguage

public void addQueryLanguage(java.lang.String mimeType)

close

public void close()
           throws java.io.IOException,
                  InvocationException

Throws:

java.io.IOException

InvocationException

compare

public ResponseSet<Prediction<R>> compare(L query,
                                          P projection,
                                          org.deckfour.xes.model.XLog availableItems)
                                   throws java.io.IOException,
                                          InvocationException,
                                          SessionClosedException

Parameters:

query -

availableItems -

Returns:

Throws:

java.io.IOException

InvocationException

SessionClosedException

compare

public ResponseSet<Prediction<R>> compare(L query,
                                          P projection,
                                          org.deckfour.xes.model.XLog availableItems,
                                          boolean done)
                                   throws java.io.IOException,
                                          InvocationException,
                                          SessionClosedException

Parameters:

query -

projection -

availableItems -

done -

Returns:

Throws:

java.io.IOException

InvocationException

SessionClosedException

compare

public <RR,LL,PP,EE> ResponseSet<Prediction<RR>> compare(QueryLanguage<RR,LL,PP,EE> queryLanguage,
                                                         LL query,
                                                         PP projection,
                                                         org.deckfour.xes.model.XLog availableItems)
                                                  throws java.io.IOException,
                                                         InvocationException,
                                                         SessionClosedException

Type Parameters:

RR -

LL -

Parameters:

queryLanguage -

query -

availableItems -

Returns:

Throws:

java.io.IOException

InvocationException

SessionClosedException

compare

public <RR,LL,PP,EE> ResponseSet<Prediction<RR>> compare(QueryLanguage<RR,LL,PP,EE> queryLanguage,
                                                         LL query,
                                                         PP projection,
                                                         org.deckfour.xes.model.XLog availableItems,
                                                         boolean done)
                                                  throws java.io.IOException,
                                                         InvocationException,
                                                         SessionClosedException

Type Parameters:

RR -

LL -

MM -

Parameters:

queryLanguage -

query -

projection -

availableItems -

done -

Returns:

Throws:

java.io.IOException

InvocationException

SessionClosedException

connect

public void connect()
             throws java.io.IOException,
                    InvocationException,
                    SessionClosedException

Throws:

java.io.IOException

InvocationException

SessionClosedException

createCopy

public SessionHandle<M,R,L,P,E> createCopy()
                                    throws java.net.UnknownHostException

Throws:

java.net.UnknownHostException

predict

public ResponseSet<Prediction<R>> predict(L query,
                                          P projection,
                                          org.deckfour.xes.model.XLog availableItems)
                                   throws java.io.IOException,
                                          InvocationException,
                                          SessionClosedException

Parameters:

query -

projection -

availableItems -

Returns:

Throws:

java.io.IOException

InvocationException

SessionClosedException

predict

public ResponseSet<Prediction<R>> predict(L query,
                                          P projection,
                                          org.deckfour.xes.model.XLog availableItems,
                                          boolean done)
                                   throws java.io.IOException,
                                          InvocationException,
                                          SessionClosedException

Parameters:

query -

availableItems -

done -

Returns:

Throws:

java.io.IOException

InvocationException

SessionClosedException

predict

public <RR,LL,PP,EE> ResponseSet<Prediction<RR>> predict(QueryLanguage<RR,LL,PP,EE> queryLanguage,
                                                         LL query,
                                                         PP projection,
                                                         org.deckfour.xes.model.XLog availableItems)
                                                  throws java.io.IOException,
                                                         InvocationException,
                                                         SessionClosedException

Type Parameters:

RR -

LL -

PP -

Parameters:

queryLanguage -

query -

projection -

availableItems -

Returns:

Throws:

java.io.IOException

InvocationException

SessionClosedException

predict

public <RR,LL,PP,EE> ResponseSet<Prediction<RR>> predict(QueryLanguage<RR,LL,PP,EE> queryLanguage,
                                                         LL query,
                                                         PP projection,
                                                         org.deckfour.xes.model.XLog availableItems,
                                                         boolean done)
                                                  throws java.io.IOException,
                                                         InvocationException,
                                                         SessionClosedException

Type Parameters:

RR -

LL -

Parameters:

queryLanguage -

query -

availableItems -

done -

Returns:

Throws:

java.io.IOException

InvocationException

SessionClosedException

recommend

public ResponseSet<Recommendation<R>> recommend(L query,
                                                P projection,
                                                E evaluator,
                                                org.deckfour.xes.model.XLog availableItems)
                                         throws java.io.IOException,
                                                InvocationException,
                                                SessionClosedException

Throws:

java.io.IOException

InvocationException

SessionClosedException

recommend

public ResponseSet<Recommendation<R>> recommend(L query,
                                                P projection,
                                                E evaluator,
                                                org.deckfour.xes.model.XLog availableItems,
                                                boolean done)
                                         throws java.io.IOException,
                                                InvocationException,
                                                SessionClosedException

Throws:

java.io.IOException

InvocationException

SessionClosedException

recommend

public <RR,LL,PP,EE> ResponseSet<Recommendation<RR>> recommend(QueryLanguage<RR,LL,PP,EE> queryLanguage,
                                                               LL query,
                                                               PP projection,
                                                               EE evaluator,
                                                               org.deckfour.xes.model.XLog availableItems)
                                                        throws java.io.IOException,
                                                               InvocationException,
                                                               SessionClosedException

Throws:

java.io.IOException

InvocationException

SessionClosedException

recommend

public <RR,LL,PP,EE> ResponseSet<Recommendation<RR>> recommend(QueryLanguage<RR,LL,PP,EE> queryLanguage,
                                                               LL query,
                                                               PP projection,
                                                               EE evaluator,
                                                               org.deckfour.xes.model.XLog availableItems,
                                                               boolean done)
                                                        throws java.io.IOException,
                                                               InvocationException,
                                                               SessionClosedException

Type Parameters:

RR -

LL -

PP -

Parameters:

queryLanguage -

query -

projection -

availableItems -

done -

Returns:

Throws:

java.io.IOException

InvocationException

SessionClosedException

setDone

public void setDone()

setModel

public void setModel(Language<? extends M> modelingLanguage,
                     M model)

simple

public ResponseSet<R> simple(L query,
                             org.deckfour.xes.model.XLog availableItems)
                      throws java.io.IOException,
                             InvocationException,
                             SessionClosedException

Throws:

java.io.IOException

InvocationException

SessionClosedException

simple

public ResponseSet<R> simple(L query,
                             org.deckfour.xes.model.XLog availableItems,
                             boolean done)
                      throws java.io.IOException,
                             InvocationException,
                             SessionClosedException

Throws:

java.io.IOException

InvocationException

SessionClosedException

simple

public <LL,RR> ResponseSet<RR> simple(QueryLanguage<RR,LL,?,?> queryLanguage,
                                      LL query,
                                      org.deckfour.xes.model.XLog availableItems)
                               throws java.io.IOException,
                                      InvocationException,
                                      SessionClosedException

Throws:

java.io.IOException

InvocationException

SessionClosedException

simple

public <LL,RR> ResponseSet<RR> simple(QueryLanguage<RR,LL,?,?> queryLanguage,
                                      LL query,
                                      org.deckfour.xes.model.XLog availableItems,
                                      boolean done)
                               throws java.io.IOException,
                                      InvocationException,
                                      SessionClosedException

Throws:

java.io.IOException

InvocationException

SessionClosedException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object