/*
 * This file is part of ELKI:
 * Environment for Developing KDD-Applications Supported by Index-Structures
 *
 * Copyright (C) 2017
 * 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 de.lmu.ifi.dbs.elki.distance.distancefunction;

import de.lmu.ifi.dbs.elki.database.query.distance.DatabaseDistanceQuery;
import de.lmu.ifi.dbs.elki.database.relation.Relation;

/**
 * Abstract super class for distance functions needing a database context.
 * 
 * @author Elke Achtert
 * @since 0.4.0
 * 
 * @apiviz.has AbstractDatabaseDistanceFunction.Instance
 * @apiviz.excludeSubtypes
 * 
 * @param <O> the type of DatabaseObject to compute the distances in between
 */
public abstract class AbstractDatabaseDistanceFunction<O> implements DistanceFunction<O> {
  /**
   * Constructor.
   */
  public AbstractDatabaseDistanceFunction() {
    super();
  }

  @Override
  public boolean isMetric() {
    return false;
  }

  @Override
  public boolean isSymmetric() {
    return true;
  }

  /**
   * The actual instance bound to a particular database.
   * 
   * @author Erich Schubert
   */
  abstract public static class Instance<O> implements DatabaseDistanceQuery<O> {
    /**
     * Relation to query.
     */
    protected final Relation<O> relation;

    /**
     * Parent distance
     */
    protected final DistanceFunction<? super O> parent;

    /**
     * Constructor.
     * 
     * @param relation Data relation
     * @param parent Parent distance
     */
    public Instance(Relation<O> relation, DistanceFunction<? super O> parent) {
      super();
      this.relation = relation;
      this.parent = parent;
    }

    @Override
    public Relation<? extends O> getRelation() {
      return relation;
    }

    @Override
    public DistanceFunction<? super O> getDistanceFunction() {
      return parent;
    }
  }
}