org.apache.lens.ml.algo.api.MLDriver Maven / Gradle / Ivy

Go to download
/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.lens.ml.algo.api;

import java.util.List;

import org.apache.lens.api.LensConf;
import org.apache.lens.api.LensException;

/**
 * The Interface MLDriver.
 */
public interface MLDriver {

  /**
   * Checks if is algo supported.
   *
   * @param algo the algo
   * @return true, if is algo supported
   */
  boolean isAlgoSupported(String algo);

  /**
   * Gets the algo instance.
   *
   * @param algo the algo
   * @return the algo instance
   * @throws LensException the lens exception
   */
  MLAlgo getAlgoInstance(String algo) throws LensException;

  /**
   * Inits the.
   *
   * @param conf the conf
   * @throws LensException the lens exception
   */
  void init(LensConf conf) throws LensException;

  /**
   * Start.
   *
   * @throws LensException the lens exception
   */
  void start() throws LensException;

  /**
   * Stop.
   *
   * @throws LensException the lens exception
   */
  void stop() throws LensException;

  List getAlgoNames();
}