/*-
 * #%L
 * This file is part of "Apromore Community".
 *
 * Copyright (C) 2015 - 2017 Queensland University of Technology.
 * Copyright (C) 2017 Alireza Ostovar.
 * %%
 * Copyright (C) 2018 - 2020 The University of Melbourne.
 * %%
 * This program 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, either version 3 of the
 * License, or (at your option) any later version.
 *
 * 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 General Lesser Public License for more details.
 *
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * <http://www.gnu.org/licenses/lgpl-3.0.html>.
 * #L%
 */

package org.apromore.service.prodrift;

import org.apromore.prodrift.config.DriftDetectionSensitivity;
import org.apromore.prodrift.model.ProDriftDetectionResult;
import org.deckfour.xes.model.XLog;

/**
 * Interface for the Process Drift Detection Service. Defines all the methods that will do the majority of the work for
 * the Apromore application.
 *
 * @author barca
 */
public interface ProDriftDetectionService {

    /**
     * Detect drifts in the log
     * @param xlog the log
     * @param eventStream eventStream of the xlog
     * @param logFileName log's name
     * @param isEventBased event based or run based
     * @param withGradual detect gradual drift or not
     * @param winSize the window size
     * @param activityCount number of activities in xlog
     * @param isAdwin Fixed window size or Adaptive window size("FWIN" or "ADWIN")
     * @param noiseFilterPercentage noise fitler percentage value
     * @param ddSensitivity Drift detection sensitivity
     * @param withConflict include conflict relation among Alpha+ relations or not
     * @param withCharacterization characterize a drift?
     * @param cummulativeChange cummulative relative relation frequency change explaining a drift
     //* @param engineR Rengine to connect to R

     * @return the ProDriftDetectionResult
     * @throws ProDriftDetectionException if the drift detection failed
     * @throws InterruptedException if the drift detection operation thread is interrupted (canceled)
     */
    ProDriftDetectionResult proDriftDetector(XLog xlog, XLog eventStream, String logFileName, boolean isEventBased,
                                             boolean withGradual, int winSize, int activityCount, boolean isAdwin, float noiseFilterPercentage, DriftDetectionSensitivity ddSensitivity,
                                             boolean withConflict, boolean withCharacterization, int cummulativeChange/*,
                                             Rengine engineR*/) throws ProDriftDetectionException, InterruptedException;


}
