org.yawlfoundation.yawl.cost.log

Class Annotator

java.lang.Object

org.yawlfoundation.yawl.cost.log.Annotator

public class Annotator
extends java.lang.Object

Annotates the events an XES formatted log with corresponding cost information where applicable.

Author:

Michael Adams

Created/Last Date:

27/10/11

Constructor Summary

Constructors

Constructor and Description
Annotator() Constructs a new Annotator
Annotator(java.lang.String unannotatedLog) Constructs a new Annotator with the log specified

Method Summary

Modifier and Type	Method and Description
java.lang.String	annotate() Annotates a log with applicable cost data
java.lang.String	annotate(java.lang.String unannotatedLog) Annotates a log with applicable cost data
void	setSpecID(YSpecificationID id) Sets the specification id for this log
void	setUnannotatedLog(java.lang.String unannotatedLog) Sets the unannotated log

Methods inherited from class java.lang.Object

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

Constructor Detail

Annotator

public Annotator()

Constructs a new Annotator

Annotator

public Annotator(java.lang.String unannotatedLog)

Constructs a new Annotator with the log specified

Parameters:

unannotatedLog - an XES log to annotate with cost data

Method Detail

setUnannotatedLog

public void setUnannotatedLog(java.lang.String unannotatedLog)

Sets the unannotated log

Parameters:

unannotatedLog - an XES log to annotate with cost data

setSpecID

public void setSpecID(YSpecificationID id)

Sets the specification id for this log

Parameters:

id - the specification id

annotate

public java.lang.String annotate(java.lang.String unannotatedLog)
                          throws java.lang.IllegalStateException

Annotates a log with applicable cost data

Parameters:

unannotatedLog - an XES log to annotate with cost data

Returns:

the cost-data annotated log

Throws:

java.lang.IllegalStateException - if the unannotatedLog is null or has an invalid format

annotate

public java.lang.String annotate()
                          throws java.lang.IllegalStateException

Annotates a log with applicable cost data

Returns:

the cost-data annotated log

Throws:

java.lang.IllegalStateException - if the unannotatedLog is null (i.e. has not been previously set via the relevant constructor or mutator) or has an invalid format