ruta-ep-textruler/src/main/java/org/apache/uima/ruta/textruler/extension/TextRulerLearnerFactory.java

/*
 * 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.uima.ruta.textruler.extension;

import java.util.Map;
import java.util.Set;

/**
 * The TextRuler system uses this interface to create an algorithm you added to it via the extension
 * point.
 * 
 * Please see TextRulerLearner for more detailed information.
 */
public interface TextRulerLearnerFactory {

  /**
   * @param inputFolderPath
   *          the input folder path where e.g. example XMIs are located
   * @param additionalFolderPath
   * @param preprocessorTMfile
   *          the preprocessing Ruta file (this is important for finding the type system and
   *          analysis engine descriptor file)
   * @param tempFolderPath
   *          a folder name that you can use as temporary folder (caution: you need to create it if
   *          you want to use it!)
   * @param fullSlotTypeNames
   *          an array with the slot-names to learn (full qualified UIMA type names)
   * @param filterSet
   *          Ruta filter set (full qualified UIMA type names)
   * @param skip
   * @param delegate
   *          a delegate that can be notified for status updates and asked for aborting the
   *          algorithm
   * @return the algorithm of your class that implements TextRulerLearner
   */
  public TextRulerLearner createAlgorithm(String inputFolderPath, String additionalFolderPath,
          String preprocessorTMfile, String tempFolderPath, String[] fullSlotTypeNames,
          Set<String> filterSet, boolean skip, TextRulerLearnerDelegate delegate);

  /**
   * @return null or an array with MLAlgorithmParameters your TextRulerLearner wants to get from the
   *         GUI
   */
  public TextRulerLearnerParameter[] getAlgorithmParameters();

  /**
   * @return null or a key value set for the standard values of your algorithm's parameters
   */
  public Map<String, Object> getAlgorithmParameterStandardValues();

}