/*
 * 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 opennlp.tools.ml;

import java.io.IOException;

import opennlp.tools.ml.model.Event;
import opennlp.tools.ml.model.MaxentModel;
import opennlp.tools.ml.model.SequenceStream;
import opennlp.tools.util.TrainingParameters;

/**
 * A basic {@link EventModelSequenceTrainer} implementation that processes {@link Event events}.
 */
public abstract class AbstractEventModelSequenceTrainer extends AbstractTrainer implements
    EventModelSequenceTrainer<Event>  {

  public AbstractEventModelSequenceTrainer() {
  }

  public abstract MaxentModel doTrain(SequenceStream<Event> events) throws IOException;

  @Override
  public final MaxentModel train(SequenceStream<Event> events) throws IOException {
    validate();

    MaxentModel model = doTrain(events);
    addToReport(TrainingParameters.TRAINER_TYPE_PARAM, EventModelSequenceTrainer.SEQUENCE_VALUE);
    return model;
  }

}
