/*
 * This file is part of ELKI:
 * Environment for Developing KDD-Applications Supported by Index-Structures
 *
 * Copyright (C) 2022
 * ELKI Development Team
 *
 * 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 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 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/>.
 */
package elki.parallel.processor;

import elki.database.ids.DBIDRef;
import elki.parallel.Executor;

/**
 * Class to represent a processor factory.
 * 
 * @author Erich Schubert
 * @since 0.7.0
 * 
 * @has - - - Instance
 */
public interface Processor {
  /**
   * Create an instance. May be called multiple times, for example for multiple
   * threads.
   * 
   * @param executor Job executor
   * @return Instance
   */
  Instance instantiate(Executor executor);

  /**
   * Invoke cleanup.
   * 
   * @param inst Instance to cleanup.
   */
  void cleanup(Instance inst);

  /**
   * Instance.
   * 
   * @author Erich Schubert
   */
  interface Instance {
    /**
     * Process ("map") a single object
     * 
     * @param id Object to map.
     */
    void map(DBIDRef id);
  }
}