associationrulesserviceapibuild.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 Carsten Weisse
  * @author Michael Thess
  * @version 1.0
  */
package com.prudsys.pdm.Examples;

import java.io.FileWriter;

import com.prudsys.pdm.Adapters.ServiceAPI.LookupService;
import com.prudsys.pdm.Adapters.ServiceAPI.ServiceAlgorithmParameter;
import com.prudsys.pdm.Adapters.ServiceAPI.XelopesServiceImpl;
import com.prudsys.pdm.Core.MiningModel;
import com.prudsys.pdm.Utils.PmmlUtils;

/**
 * Builds same association rule model like 'AssociationRulesBuild'
 * but using the Service API. Writes the model to the same
 * PMML file 'AssociationRulesModel.xml'.
 */
public class AssociationRulesServiceAPIBuild extends BasisExample
{

  /**
   * Empty constructor.
   */
  public AssociationRulesServiceAPIBuild()
  {
  }

  /**
   * Run the example of this class.
   *
   * @throws Exception error while example is running
   */
  public void runExample() throws Exception {

    // Create XELOPES Service Implementation object:
    XelopesServiceImpl xsi = new XelopesServiceImpl();

    // Want test string:
    String testString = xsi.getTestString();
    System.out.println("-->Test string: " + testString);

    // Want supported functions:
    String[] suppFunc = xsi.getSupportedFunctions();
    System.out.print("-->Supported functions: ");
    if (suppFunc != null)
      for (int i = 0; i < suppFunc.length; i++)
        System.out.print(suppFunc[i] + " ");
    System.out.println();

    // Want all supported algorithms:
    String[] suppAlg = xsi.getAllSupportedAlgorithms();
    System.out.print("-->Supported algorithms: ");
    if (suppAlg != null)
      for (int i = 0; i < suppAlg.length; i++)
        System.out.print(suppAlg[i] + " ");
    System.out.println();

    // Want all supported association rules algorithms:
    String[] suppAssAlg = xsi.getSupportedAlgorithms(
                                MiningModel.ASSOCIATION_RULES_ALGORITHM );
    System.out.print("-->Supported association rule algorithms: ");
    if (suppAssAlg != null)
      for (int i = 0; i < suppAssAlg.length; i++)
        System.out.print(suppAssAlg[i] + " ");
    System.out.println();

    // Want all algorithm parameters of algorithm 'AprioriSimple':
    String selectAlgo = suppAssAlg[0];    // general approach
    selectAlgo        = "AprioriSimple";  // want 'AprioriSimple'
    ServiceAlgorithmParameter[] algPar = xsi.getAlgorithmParameters(selectAlgo);
    System.out.println("-->Parameters of algorithm '" + selectAlgo + "':");
    if (algPar != null) {
      for (int i = 0; i < algPar.length; i++)
        System.out.println("     name: " + algPar[i].getName() +
                               ", value: " + algPar[i].getValue() +
                               ", type: " + algPar[i].getType() +
                               ", descript: " + algPar[i].getDescription() +
                               ", domain: " + algPar[i].getDomain() +
                               ", status: " + algPar[i].getStatus() +
                               ", ID: " + algPar[i].getID() +
                               ", childIDs: " + algPar[i].getChildIDs() );
    };

    // Want Service API data sources available:
    String[] dataSources = xsi.getDataSources();
    System.out.print("-->Data sources for association rules: ");
    if (dataSources != null)
      for (int i = 0; i < dataSources.length; i++)
        System.out.print(dataSources[i] + " ");
    System.out.println();

    // Want meta data of first data source:
    String dataSource = "transact";
    String dsMeta = xsi.getDataSourceMetaData( dataSource );
    System.out.println("-->Meta data of data source '" + dataSource + "':");
    System.out.print(dsMeta);
    System.out.println();

    // Run association rules algorithm and obtain result as PMML string:
    System.out.println("-->Build model by service: ");
    String sourceName = dataSource;
    LookupService.setSAPValue(algPar, "minimumSupport", "0.5");
    LookupService.setSAPValue(algPar, "minimumConfidence", "0.3");
    LookupService.setSAPValue(algPar, "itemIdName", "itemId");
    LookupService.setSAPValue(algPar, "transactionIdName", "transactId");
    LookupService.setSAPValue(algPar, "maximumItemSize", "4");
    String pmmlString = xsi.buildModelService(selectAlgo, algPar, sourceName);

    // Write result into PMML file:
    FileWriter writer = new FileWriter("data/pmml/AssociationRulesModel.xml");
    writer.write( pmmlString );
    writer.flush();

    // Show in browser:
    if (debug == 2) PmmlUtils.openPmmlBrowser("AssociationRulesModel.xml");
  }


  /**
   * Simple example of building an association rules model
   * using the Service API.
   *
   * @param args arguments (ignored)
   */
  public static void main(String[] args) {

    try {
      new AssociationRulesServiceAPIBuild().runExample();
    }
    catch (Exception ex) {
      ex.printStackTrace();
    }
  }
}