xelopesservice.java

一个数据挖掘软件ALPHAMINERR的整个过程的JAVA版源代码

/*
 *    This program is free software; you can redistribute it and/or modify
 *    it under the terms of the GNU General Public License as published by
 *    the Free Software Foundation; either version 2 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 General Public License for more details.
 *
 *    You should have received a copy of the GNU General Public License
 *    along with this program; if not, write to the Free Software
 *    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

 /**
  * Title: XELOPES Data Mining Library
  * Description: The XELOPES library is an open platform-independent and data-source-independent library for Embedded Data Mining.
  * Copyright: Copyright (c) 2002 Prudential Systems Software GmbH
  * Company: ZSoft (www.zsoft.ru), Prudsys (www.prudsys.com)
  * @author Valentine Stepanenko ([e-mail])
  * @author Victor Borichev
  * @version 1.1
  */

package com.prudsys.pdm.Adapters.ServiceAPI;

import java.rmi.Remote;
import java.rmi.RemoteException;

/**
 * Service interface to call XELOPES functions from a server
 * like web services. (Can also be used as simplified
 * standalone interface.)
 */
public interface XelopesService extends Remote
{
  /**
   * Returns test string.
   *
   * @return test string
   * @throws RemoteException could not return test string
   */
  public String getTestString() throws RemoteException;

  /**
   * Returns all model functions that are supported by this service.
   *
   * @return all functions supported
   * @throws RemoteException something went wrong
   */
  public String[] getSupportedFunctions() throws RemoteException;

  /**
   * Returns all model algorithms that are supported by this service.
   *
   * @return all algorithms supported
   * @throws RemoteException something went wrong
   */
  public String[] getAllSupportedAlgorithms() throws RemoteException;

  /**
   * Returns all algorithms supported for a given function class.
   *
   * @param functionName given function class
   * @return algorithms belonging to this class supported
   * @throws RemoteException
   */
  public String[] getSupportedAlgorithms(String functionName) throws RemoteException;

  /**
   * Returns all algorithm parameters for a given algorithm. Covers all
   * parameters from mining settings, mining algorithm specification, and
   * mining automation assignment.
   *
   * @param algorithmName name of the algorithm
   * @return service algorithm parameters supported by this algorithm
   * @throws RemoteException something went wrong
   */
  public ServiceAlgorithmParameter[] getAlgorithmParameters(String algorithmName) throws RemoteException;

  /**
   * Returns names of all data sources available.
   *
   * @return names of all data sources available
   * @throws RemoteException something went wrong
   */
  public String[] getDataSources() throws RemoteException;

  /**
   * Returns meta data for a given data source as PMML string.
   *
   * @param sourceName name of data source
   * @return PMML document with data dictionary of data source
   * @throws RemoteException method not supported
   */
  public String getDataSourceMetaData(String sourceName) throws RemoteException;

  /**
   * Builds mining model by the service and returns the model as
   * PMML string.
   *
   * @param algorithm algorithm name
   * @param parameters algorithm parameters
   * @param sourceName name of data source
   * @return PMML document with mining model as string
   * @throws RemoteException cannot build model
   */
  public String buildModelService(String algorithm, ServiceAlgorithmParameter[] parameters, String sourceName) throws RemoteException;

  /**
   * Applies mining model (given as PMML string) by the service and returns the
   * array of double values from the application of the model to all vectors
   * of the data source.
   *
   * @param model mining model as PMML string
   * @param sourceName name of data source where the model is applied
   * @return values of model application to all data source vectors
   * @throws RemoteException cannot apply model to data source
   */
  public double[] applyModelFunctionService(String model, String sourceName) throws RemoteException;
}