/*
 * RiskScape™ Copyright New Zealand Institute for Earth Science Limited
 * (Earth Sciences New Zealand) is distributed for research purposes only
 * under the terms of AGPLv3.
 *
 * RiskScape™ Copyright 2026 New Zealand Institute for Earth Science
 * Limited (Earth Sciences New Zealand). All rights reserved. Source code
 * available under the AGPLv3.
 * 
 * This program is free software: you can redistribute it and/or modify it under
 *  the terms of the GNU Affero 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 for RESEARCH PURPOSES ONLY, in the hope that it will
 * be useful for research and education initiatives.
 * 
 * If you are not a researcher, or you are a researcher who wishes to use this
 * program on terms other than AGPLv3 (including those who wish to restrict the
 * distribution of any source code created using this program), please contact:
 * https://riskscape.org.nz
 * 
 * This program is distributed WITHOUT ANY WARRANTY; without even the implied
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Affero General Public License for more details.  You should have received a copy
 * of the GNU Affero General Public License along with this program.  If not, see
 * <http://www.gnu.org/licenses/>.
 * 
 * By way of summary only, under the AGPLv3:
 *     • Permissions of this strongest copyleft license are conditioned
 *       on making available complete source code of licensed works and
 *       modifications, which include larger works using a licensed work,
 *       under the same license.
 *     • Copyright and license notices must be preserved.
 *     • Contributors provide an express grant of patent rights.
 *     • When a modified version is used to provide a service over a
 *       network, the complete source code of the modified version must be made
 *       available.
 */
package nz.org.riskscape.engine.model;

import java.util.List;
import java.util.Optional;

import nz.org.riskscape.engine.bind.BoundParameters;
import nz.org.riskscape.engine.pipeline.ExecutionContext;
import nz.org.riskscape.engine.pipeline.Pipeline;
import nz.org.riskscape.engine.pipeline.RealizedPipeline;
import nz.org.riskscape.problem.ResultOrProblems;

/**
 * Represents the new style of Riskscape model. A model fits into a predefined
 * framework that defines how it will behave. The user can then configure
 * parameters that customize how the model behaves. The underlying
 * data-processing work that the model actually carries out is achieved using a
 * {@link Pipeline}.
 */
public interface Model {

  /**
   * @return what sort of {@link ModelFramework} was used to build this model.
   */
  ModelFramework getFramework();

  /**
   * @return the configurable parameters that will be applied to the model when it is run.  Note these parameters
   * are subservient to the framework parameters that were used to create the model - change the framework parameters
   * will likely result in a totally different set of model parameters.
   */
  BoundParameters getBoundParameters();

  /**
   * Returns the parameters used by the {@link ModelFramework} to build this model
   * (e.g. "template = default"). These parameters are so central to the model
   * that it doesn't really make sense to override them at all, once the user has
   * defined them.
   */
  BoundParameters getFrameworkParameters();

  /**
   * Returns a view the model's bound parameters (e.g. the data in {@link #getBoundParameters()}), but as
   * {@link ModelParameter}s, which contains more detailed metadata.
   *
   * This view of the data is typically used for building user interfaces and validation, whereas the boundParameters
   * version is there as reference for what was bound, but they should both contain the same set of parameter names.
   *
   * Thinking ahead, I suspect we might want to introduce a RealizedModel class, that is returned from
   * {@link #realize(ExecutionContext)}, and that version can return the model's parameters.
   */
  List<? extends ModelParameter> getModelParameters();

  /**
   * @return the ModelParameter that matches the given name
   */
  default Optional<? extends ModelParameter> getModelParameter(String parameterName) {
    return getModelParameters().stream()
        .filter(mp -> mp.getParameter().getName().equals(parameterName))
        .findFirst();
  }

  /**
   * Produces an executable pipeline that will 'run' the model and produce
   * results.
   *
   * @return a {@link RealizedPipeline} that can be executed, or a list of
   *         Problems that occurred during realization.
   */
  ResultOrProblems<RealizedPipeline> realize(ExecutionContext context);

}
