/**
 * DataCleaner (community edition)
 * Copyright (C) 2014 Neopost - Customer Information Management
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * This program 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 this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */
package org.datacleaner.monitor.scheduling.model;

import java.io.Serializable;
import java.util.Date;

/**
 * Represents the basic information about an execution. Can be used as a key for
 * retrieving more information in an {@link ExecutionLog} object.
 */
public class ExecutionIdentifier implements Serializable, Comparable<ExecutionIdentifier> {

    private static final long serialVersionUID = 1L;

    private String _resultId;
    private TriggerType _triggerType;
    private Date _jobBeginDate;
    private ExecutionStatus _executionStatus;

    public ExecutionIdentifier() {
        this(null, null);
    }

    public ExecutionIdentifier(final String resultId) {
        this(resultId, null);
        _executionStatus = ExecutionStatus.UNKNOWN;
    }

    protected ExecutionIdentifier(final String resultId, final TriggerType triggerType) {
        _resultId = resultId;
        _triggerType = triggerType;
        _executionStatus = ExecutionStatus.PENDING;
    }

    public boolean isFinished() {
        final boolean runningOrUnkown = _executionStatus == null || _executionStatus == ExecutionStatus.RUNNING
                || _executionStatus == ExecutionStatus.PENDING || _executionStatus == ExecutionStatus.UNKNOWN;
        return !runningOrUnkown;
    }

    public String getResultId() {
        return _resultId;
    }

    public void setResultId(final String resultId) {
        _resultId = resultId;
    }

    /**
     * Gets the trigger type of this execution. Note that this trigger type
     * MIGHT NOT be the same as the TriggerType in the Schedule of the job (
     * {@link ExecutionLog#getSchedule()}), since the execution might be
     * manually triggered while also having a defined schedule.
     *
     * @return
     */
    public TriggerType getTriggerType() {
        return _triggerType;
    }

    public void setTriggerType(final TriggerType triggerType) {
        _triggerType = triggerType;
    }

    public Date getJobBeginDate() {
        return _jobBeginDate;
    }

    public void setJobBeginDate(final Date jobBeginDate) {
        _jobBeginDate = jobBeginDate;
    }

    public ExecutionStatus getExecutionStatus() {
        return _executionStatus;
    }

    public void setExecutionStatus(final ExecutionStatus executionStatus) {
        _executionStatus = executionStatus;
    }

    @Override
    public String toString() {
        return "ExecutionIdentifier[begin=" + _jobBeginDate + ", status=" + _executionStatus + "]";
    }

    @Override
    public int compareTo(final ExecutionIdentifier o) {
        if (o == null) {
            return 1;
        }
        if (o == this) {
            return 0;
        }

        if (_jobBeginDate != null) {
            final Date otherJobBeginDate = o.getJobBeginDate();
            if (otherJobBeginDate == null) {
                return 1;
            }
            final int diff = _jobBeginDate.compareTo(otherJobBeginDate);
            if (diff != 0) {
                return diff;
            }
        }

        if (_resultId != null) {
            final String otherResultId = o.getResultId();
            if (otherResultId == null) {
                return 1;
            }
            final int diff = _resultId.compareTo(otherResultId);
            if (diff != 0) {
                return diff;
            }
        }

        if (_executionStatus != null) {
            final ExecutionStatus otherExecutionStatus = o.getExecutionStatus();
            if (otherExecutionStatus == null) {
                return 1;
            }
            final int diff = _executionStatus.compareTo(otherExecutionStatus);
            if (diff != 0) {
                return diff;
            }
        }

        if (_triggerType != null) {
            final TriggerType otherTriggerType = o.getTriggerType();
            if (otherTriggerType == null) {
                return 1;
            }
            final int diff = _triggerType.compareTo(otherTriggerType);
            if (diff != 0) {
                return diff;
            }
        }

        return 0;
    }
}