org.cleartk.classifier.util.PublicFieldDataWriter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cleartk-ml Show documentation
ClearTK machine learning library and interfaces
There is a newer version: 3.0.0
/** 
 * Copyright (c) 2007-2008, Regents of the University of Colorado 
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 
 * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 
 * Neither the name of the University of Colorado at Boulder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. 
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE. 
 */
package org.cleartk.classifier.util;

import java.util.ArrayList;
import java.util.List;

import org.apache.uima.analysis_engine.AnalysisEngine;
import org.apache.uima.analysis_engine.AnalysisEngineProcessException;
import org.apache.uima.jcas.JCas;
import org.cleartk.classifier.DataWriter;
import org.cleartk.classifier.DataWriterFactory;
import org.cleartk.classifier.Instance;

/**
 * A simple {@link DataWriter} that stores all instances in a public attribute. Intended only for
 * testing.
 * 
 * 

 * Copyright (c) 2007-2008, Regents of the University of Colorado 

 * All rights reserved.
 * 
 * @author Philip Ogren
 * @author Steven Bethard
 */
public class PublicFieldDataWriter implements DataWriter {

  public List> instances;

  public PublicFieldDataWriter() {
    this.instances = new ArrayList>();
  }

  public void finish() {
  }

  public void write(Instance instance) {
    this.instances.add(instance);
  }

  /**
   * Returns a single static instance of InstanceCollector.
   */
  public static class StringFactory implements DataWriterFactory {
    private static PublicFieldDataWriter collector = new PublicFieldDataWriter();

    public DataWriter createDataWriter() {
      return collector;
    }

    public static List> collectInstances(AnalysisEngine engine, JCas jCas)
        throws AnalysisEngineProcessException {
      return PublicFieldDataWriter.collectInstances(engine, jCas, collector);
    }
  }

  /**
   * Returns a single static instance of InstanceCollector.
   */
  public static class BooleanFactory implements DataWriterFactory {
    private static PublicFieldDataWriter collector = new PublicFieldDataWriter();

    public DataWriter createDataWriter() {
      return collector;
    }

    public static List> collectInstances(AnalysisEngine engine, JCas jCas)
        throws AnalysisEngineProcessException {
      return PublicFieldDataWriter.collectInstances(engine, jCas, collector);
    }
  }

  static  List> collectInstances(
      AnalysisEngine engine,
      JCas jCas,
      PublicFieldDataWriter collector) throws AnalysisEngineProcessException {
    collector.instances.clear();
    engine.process(jCas);
    engine.collectionProcessComplete();
    return collector.instances;
  }
}