package org.apache.samoa.learners;

/*
 * #%L
 * SAMOA
 * %%
 * Copyright (C) 2014 - 2015 Apache Software Foundation
 * %%
 * Licensed 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.
 * #L%
 */

import java.io.Serializable;
import java.util.Set;

import org.apache.samoa.core.Processor;
import org.apache.samoa.instances.Instances;
import org.apache.samoa.topology.Stream;
import org.apache.samoa.topology.TopologyBuilder;

/**
 * The Interface Classifier. Initializing Classifier should initalize PI to connect the Classifier with the input stream
 * and initialize result stream so that other PI can connect to the classification result of this classifier
 */

public interface Learner extends Serializable {

  /**
   * Inits the Learner object.
   * 
   * @param topologyBuilder
   *          the topology builder
   * @param dataset
   *          the dataset
   * @param parallelism
   *          the parallelism
   */
  public void init(TopologyBuilder topologyBuilder, Instances dataset, int parallelism);

  /**
   * Gets the input processing item.
   * 
   * @return the input processing item
   */
  public Processor getInputProcessor();

  /**
   * Gets the result streams
   * 
   * @return the set of result streams
   */
  public Set<Stream> getResultStreams();
}

@@ -926,31 +926,90 @@
 %0A * 
-The Interface Classifie
+A Learner instance learns a model, and it can be either a classifier or a regresso
 r. I
@@ -1020,24 +1020,23 @@
 alizing 
-Classifi
+a Learn
 er shoul
@@ -1040,24 +1040,43 @@
 ould
+%0A *
  init
+i
 alize 
-PI to
+a %7B@link Processor%7D,
  con
@@ -1088,16 +1088,13 @@
 the 
-Classifi
+Learn
 er w
@@ -1113,19 +1113,17 @@
 t stream
-%0A *
+,
  and ini
@@ -1130,16 +1130,20 @@
 tialize 
+the 
 result s
@@ -1166,51 +1166,50 @@
 her 
-PI can connect to the classification
+processors%0A * can subscribe to the
  result
+s
  of 
@@ -1213,26 +1213,24 @@
 of this 
-classifi
+learn
 er
+.
 %0A */%0A%0Apu

Fix javadoc of Learner