org.yawlfoundation.yawl.engine.instance.CaseInstance.java Source code

Introduction

Here is the source code for org.yawlfoundation.yawl.engine.instance.CaseInstance.java

Source

/*
 * Copyright (c) 2004-2012 The YAWL Foundation. All rights reserved.
 * The YAWL Foundation is a collaboration of individuals and
 * organisations who are committed to improving workflow technology.
 *
 * This file is part of YAWL. YAWL is free software: you can
 * redistribute it and/or modify it under the terms of the GNU Lesser
 * General Public License as published by the Free Software Foundation.
 *
 * YAWL is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
 * Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with YAWL. If not, see <http://www.gnu.org/licenses/>.
 */

package org.yawlfoundation.yawl.engine.instance;

import org.jdom2.Element;
import org.yawlfoundation.yawl.engine.YSpecificationID;
import org.yawlfoundation.yawl.engine.YWorkItem;
import org.yawlfoundation.yawl.util.JDOMUtil;
import org.yawlfoundation.yawl.util.StringUtil;
import org.yawlfoundation.yawl.logging.YLogDataItemList;

import java.text.SimpleDateFormat;
import java.util.Collection;
import java.util.Hashtable;
import java.util.Map;

/**
 * Author: Michael Adams
 * Creation Date: 11/11/2008
 */
public class CaseInstance implements YInstance {

    private String caseID;
    private YSpecificationID specID;
    private String caseParams;
    private YLogDataItemList logData;
    private long startTime;
    private Map<String, WorkItemInstance> workitems;

    public CaseInstance() {
        workitems = new Hashtable<String, WorkItemInstance>();
    }

    public CaseInstance(String caseID, YSpecificationID specID, String caseParams, YLogDataItemList logData,
            long startTime) {
        this();
        this.caseID = caseID;
        this.specID = specID;
        this.caseParams = caseParams;
        this.logData = logData;
        setStartTime(startTime);
    }

    public CaseInstance(String xml) {
        this();
        fromXML(xml);
    }

    public CaseInstance(Element instance) {
        this();
        fromXML(instance);
    }

    public String getCaseID() {
        return caseID;
    }

    public void setCaseID(String s) {
        caseID = s;
    }

    public YSpecificationID getSpecID() {
        return specID;
    }

    public void setSpecID(YSpecificationID id) {
        specID = id;
    }

    public String getSpecName() {
        return specID.getUri();
    }

    public String getSpecVersion() {
        return specID.getVersionAsString();
    }

    public String getCaseParams() {
        return caseParams;
    }

    public void setCaseParams(String params) {
        caseParams = params;
    }

    public YLogDataItemList getLogData() {
        return logData;
    }

    public void setLogData(YLogDataItemList data) {
        logData = data;
    }

    public long getStartTime() {
        return startTime;
    }

    public String getStartTimeAsDateString() {
        String result = null;
        if (startTime > 0) {
            result = new SimpleDateFormat("yyyy-MM-dd H:mm:ss").format(startTime);
        }
        return result;
    }

    public String getAgeAsDateString() {
        String result = null;
        if (startTime > 0) {
            result = formatAge(System.currentTimeMillis() - startTime);
        }
        return result;
    }

    /**
    * formats a long time value into a string of the form 'ddd:hh:mm:ss'
    * @param age the time value (in milliseconds)
    * @return the formatted time string
    */
    public String formatAge(long age) {
        long secsPerHour = 60 * 60;
        long secsPerDay = 24 * secsPerHour;
        age = age / 1000; // ignore the milliseconds

        long days = age / secsPerDay;
        age %= secsPerDay;
        long hours = age / secsPerHour;
        age %= secsPerHour;
        long mins = age / 60;
        age %= 60; // seconds leftover
        return String.format("%d:%02d:%02d:%02d", days, hours, mins, age);
    }

    public void setStartTime(long time) {
        if (time <= 0)
            time = System.currentTimeMillis();
        startTime = time;
    }

    public Map<String, WorkItemInstance> getWorkitemMap() {
        return workitems;
    }

    public void setWorkitemMap(Map<String, WorkItemInstance> items) {
        workitems = items;
    }

    public Collection<WorkItemInstance> getWorkItems() {
        return workitems.values();
    }

    public void addWorkItemInstance(WorkItemInstance item) {
        workitems.put(item.getID(), item);
    }

    public void addWorkItemInstance(YWorkItem workitem) {
        addWorkItemInstance(new WorkItemInstance(workitem));
    }

    public WorkItemInstance getWorkItemInstance(String id) {
        return workitems.get(id);
    }

    public String marshalWorkitems() {
        StringBuilder result = new StringBuilder("<workitemInstances>");
        for (WorkItemInstance item : workitems.values()) {
            result.append(item.toXML());
        }
        result.append("</workitemInstances>");
        return result.toString();
    }

    public String toXML() {
        StringBuilder xml = new StringBuilder("<caseInstance>");
        xml.append(StringUtil.wrap(caseID, "caseid"));
        xml.append(StringUtil.wrapEscaped(caseParams, "caseparams"));
        xml.append(StringUtil.wrap(specID.getIdentifier(), "specidentifier"));
        xml.append(StringUtil.wrap(specID.getVersionAsString(), "specversion"));
        xml.append(StringUtil.wrap(specID.getUri(), "specuri"));
        xml.append(StringUtil.wrap(String.valueOf(startTime), "starttime"));
        if (logData != null)
            xml.append(logData.toXML());

        xml.append("</caseInstance>");
        return xml.toString();
    }

    public void fromXML(String xml) {
        fromXML(JDOMUtil.stringToElement(xml));
    }

    public void fromXML(Element instance) {
        if (instance != null) {
            caseID = instance.getChildText("caseid");
            String startStr = instance.getChildText("starttime");
            if (startStr != null)
                startTime = new Long(startStr);
            String params = instance.getChildText("caseparams");
            if (params != null)
                caseParams = JDOMUtil.decodeEscapes(params);
            String specIdentifier = instance.getChildText("specidentifier");
            String specVersion = instance.getChildText("specversion");
            String specURI = instance.getChildText("specuri");
            specID = new YSpecificationID(specIdentifier, specVersion, specURI);
            Element logDataElem = instance.getChild("logdataitemlist");
            if (logDataElem != null) {
                logData = new YLogDataItemList(logDataElem);
            }
        }
    }
}