13.2. PMML レガシー呼び出しの Java アプリケーションへの直接組み込み

手順

1. クライアントアプリケーションで、Java プロジェクトの関連クラスパスに以下の依存関係を追加します。

   <!-- Required for the PMML compiler -->
   <dependency>
     <groupId>org.drools</groupId>
     <artifactId>kie-pmml</artifactId>
     <version>${rhpam.version}</version>
   </dependency>
   
   <!-- Required for the KIE public API -->
   <dependency>
     <groupId>org.kie</groupId>
     <artifactId>kie-api</artifactId>
     <version>${rhpam.version}</version>
   </dependencies>
   
   <!-- Required if not using classpath KIE container -->
   <dependency>
     <groupId>org.kie</groupId>
     <artifactId>kie-ci</artifactId>
     <version>${rhpam.version}</version>
   </dependency>

   <version> は、プロジェクトで現在使用している Red Hat Process Automation Manager の Maven アーティファクトバージョンです (例: 7.59.0.Final-redhat-00006)。

   注記

   個別の依存関係に対して Red Hat Process Automation Manager <version> を指定するのではなく、Red Hat Business Automation BOM (bill of materials) の依存関係をプロジェクトの pom.xml ファイルに追加することを検討してください。Red Hat Business Automation BOM は、Red Hat Decision Manager と Red Hat Process Automation Manager の両方に適用されます。BOM ファイルを追加すると、提供される Maven リポジトリーから、推移的依存関係の適切なバージョンがプロジェクトに含められます。

   BOM 依存関係の例:

   <dependency>
     <groupId>com.redhat.ba</groupId>
     <artifactId>ba-platform-bom</artifactId>
     <version>7.12.0.redhat-00008</version>
     <scope>import</scope>
     <type>pom</type>
   </dependency>

   Red Hat Business Automation BOM (Bill of Materials) についての詳細情報は、What is the mapping between RHPAM product and maven library version? を参照してください。

   重要

   レガシー実装を使用するには、kie-pmml-implementation システムプロパティーが legacy として設定されていることを確認します。

2. classpath または ReleaseId から KIE コンテナーを作成します。

   KieServices kieServices = KieServices.Factory.get();
   
   ReleaseId releaseId = kieServices.newReleaseId( "org.acme", "my-kjar", "1.0.0" );
   KieContainer kieContainer = kieServices.newKieContainer( releaseId );

   または、以下のオプションを使用します。

   KieServices kieServices = KieServices.Factory.get();
   
   KieContainer kieContainer = kieServices.getKieClasspathContainer();

3. PMMLRequestData クラスのインスタンスを作成し、PMML モデルをデータセットに適用します。

   public class PMMLRequestData {
       private String correlationId; 1
       private String modelName; 2
       private String source; 3
       private List<ParameterInfo<?>> requestParams; 4
       ...
   }

   1

   特定の要求または結果に関連のあるデータを特定

   2

   要求データに適用する必要のあるモデル名

   3

   要求を生成したセグメントを特定するために、内部で生成された PMMLRequestData オブジェクトが使用

   4

   入力データポイントを送信するデフォルトのメカニズム

4. PMML4Result クラスのインスタンスを作成します。このクラスでは、入力データに PMML ベースルールを適用した結果の出力情報を保持します。

   public class PMML4Result {
       private String correlationId;
       private String segmentationId; 1
       private String segmentId; 2
       private int segmentIndex; 3
       private String resultCode; 4
       private Map<String, Object> resultVariables; 5
       ...
   }

   1

   モデルタイプが MiningModel の場合に使用します。segmentationId は、複数のセグメントを区別化するために使用します。

   2

   segmentationId と併用して、結果を生成したセグメントを特定します。

   3

   セグメントの順番を維持するのに使用します。

   4

   モデルが正常に適用されたかどうかを判断するのに使用します。OK は成功を示します。

   5

   結果の値として代入される変数とそれに関連する値の名前が含まれます。

   通常の getter メソッドに加え、PMML4Result クラスも、結果となる変数の値を直接取得する以下の方法をサポートします。

   public <T> Optional<T> getResultValue(String objName, String objField, Class<T> clazz, Object...params)
   
   public Object getResultValue(String objName, String objField, Object...params)

5. ParameterInfo クラスのインスタンスを作成します。このクラスは、PMMLRequestData クラスの一部として使用する、基本的なデータタイプオブジェクトのラッパーとして機能します。

   public class ParameterInfo<T> { 1
       private String correlationId;
       private String name; 2
       private String capitalizedName;
       private Class<T> type; 3
       private T value; 4
       ...
   }

   1

   多数の異なるタイプを処理するパラメーター化されたクラス

   2

   モデルの入力として想定される変数の名前

   3

   変数の実際のタイプとなるクラス

   4

   変数の実際の値

6. 先ほど作成した対象の PMML クラスインスタンスをもとに PMML モデルを実行します。

   public void executeModel(KieBase kbase,
                            Map<String,Object> variables,
                            String modelName,
                            String correlationId,
                            String modelPkgName) {
       RuleUnitExecutor executor = RuleUnitExecutor.create().bind(kbase);
       PMMLRequestData request = new PMMLRequestData(correlationId, modelName);
       PMML4Result resultHolder = new PMML4Result(correlationId);
       variables.entrySet().forEach( es -> {
           request.addRequestParam(es.getKey(), es.getValue());
       });
   
       DataSource<PMMLRequestData> requestData = executor.newDataSource("request");
       DataSource<PMML4Result> resultData = executor.newDataSource("results");
       DataSource<PMMLData> internalData = executor.newDataSource("pmmlData");
   
       requestData.insert(request);
       resultData.insert(resultHolder);
   
       List<String> possiblePackageNames = calculatePossiblePackageNames(modelName,
                                                                       modelPkgName);
       Class<? extends RuleUnit> ruleUnitClass = getStartingRuleUnit("RuleUnitIndicator",
                                                                   (InternalKnowledgeBase)kbase,
                                                                   possiblePackageNames);
   
       if (ruleUnitClass != null) {
           executor.run(ruleUnitClass);
           if ( "OK".equals(resultHolder.getResultCode()) ) {
             // extract result variables here
           }
       }
   }
   
   protected Class<? extends RuleUnit> getStartingRuleUnit(String startingRule, InternalKnowledgeBase ikb, List<String> possiblePackages) {
       RuleUnitRegistry unitRegistry = ikb.getRuleUnitRegistry();
       Map<String,InternalKnowledgePackage> pkgs = ikb.getPackagesMap();
       RuleImpl ruleImpl = null;
       for (String pkgName: possiblePackages) {
         if (pkgs.containsKey(pkgName)) {
             InternalKnowledgePackage pkg = pkgs.get(pkgName);
             ruleImpl = pkg.getRule(startingRule);
             if (ruleImpl != null) {
                 RuleUnitDescr descr = unitRegistry.getRuleUnitFor(ruleImpl).orElse(null);
                 if (descr != null) {
                     return descr.getRuleUnitClass();
                 }
             }
         }
       }
       return null;
   }
   
   protected List<String> calculatePossiblePackageNames(String modelId, String...knownPackageNames) {
       List<String> packageNames = new ArrayList<>();
       String javaModelId = modelId.replaceAll("\\s","");
       if (knownPackageNames != null && knownPackageNames.length > 0) {
           for (String knownPkgName: knownPackageNames) {
               packageNames.add(knownPkgName + "." + javaModelId);
           }
       }
       String basePkgName = PMML4UnitImpl.DEFAULT_ROOT_PACKAGE+"."+javaModelId;
       packageNames.add(basePkgName);
       return packageNames;
   }

   ルールは RuleUnitExecutor クラスにより実行されます。RuleUnitExecutor クラスは KIE セッションを作成し、必要な DataSource オブジェクトをこれらのセッションに追加してから、run() メソッドへのパラメーターとして渡される RuleUnit をもとに、ルールを実行します。calculatePossiblePackageNames と getStartingRuleUnit メソッドは、run() メソッドに渡される RuleUnit クラスの完全修飾名を決定します。