/*
 * 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.data;

import java.util.Collection;
import java.util.List;
import java.util.stream.Collectors;

import nz.org.riskscape.engine.IdentifiedCollection;
import nz.org.riskscape.engine.pipeline.ExecutionContext;
import nz.org.riskscape.problem.ResultOrProblems;

public interface BookmarkResolvers extends IdentifiedCollection<BookmarkResolver> {

  /**
   * Resolves a {@link Bookmark} without doing any error checking beyond asserting that a {@link BookmarkResolver}
   * appears to be able to access the data behind this {@link Bookmark}.
   */
  ResultOrProblems<ResolvedBookmark> resolve(Bookmark bookmark, ExecutionContext context);

  /**
   * Resolves a {@link Bookmark} and fetches the data from the {@link ResolvedBookmark}.
   * @param bookmark to resolve
   * @param context to bind any bookmark parameters with
   * @return the result of {@link ResolvedBookmark#getData(Class)}, or empty if the data
   * can not be accessed from the {@link ResolvedBookmark}.  Any problems will be wrapped with a foundWith problem with
   * the bookmark as context
   */
  <T> ResultOrProblems<T> getData(
      Bookmark bookmark,
      ExecutionContext context,
      Class<T> requiredType
  );

  /**
   * Alternative to getData that returns the {@link ResolvedBookmark} rather than the given data.  The data is still
   * accessed, and any errors fetching it will be returned instead of the ResolvedBookmark.
   * @return Any problems will be wrapped with a foundWith problem with the bookmark as context
   */
  ResultOrProblems<ResolvedBookmark> resolveAndValidate(
      Bookmark bookmark, ExecutionContext context, Class<?> requiredType);

  /**
   * @return A list of all the supported bookmark formats
   */
  // TODO this is a temporary solution until the IdentifiedCollection<Format> supports input formats
  default List<String> getSupportedFormats() {
    return getAll().stream()
      .map(BookmarkResolver::getFormats)
      .flatMap(Collection::stream)
      .collect(Collectors.toList());
  }
}
