org.yawlfoundation.yawl.cost.log
Class Annotator

java.lang.Object
  extended by org.yawlfoundation.yawl.cost.log.Annotator

public class Annotator
extends 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
Annotator()
          Constructs a new Annotator
Annotator(String unannotatedLog)
          Constructs a new Annotator with the log specified
 
Method Summary
 String annotate()
          Annotates a log with applicable cost data
 String annotate(String unannotatedLog)
          Annotates a log with applicable cost data
 void setSpecID(YSpecificationID id)
          Sets the specification id for this log
 void setUnannotatedLog(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(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(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 String annotate(String unannotatedLog)
                throws 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:
IllegalStateException - if the unannotatedLog is null or has an invalid format

annotate

public String annotate()
                throws IllegalStateException
Annotates a log with applicable cost data

Returns:
the cost-data annotated log
Throws:
IllegalStateException - if the unannotatedLog is null (i.e. has not been previously set via the relevant constructor or mutator) or has an invalid format


Copyright © 2004-2012 The YAWL Foundation.