001/*
002 * Copyright (c) 2012, Regents of the University of Colorado 
003 * All rights reserved.
004 * 
005 * Redistribution and use in source and binary forms, with or without
006 * modification, are permitted provided that the following conditions are met:
007 * 
008 * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 
009 * 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. 
010 * 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. 
011 * 
012 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
013 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
014 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
015 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
016 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
017 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
018 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
019 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
020 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
021 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
022 * POSSIBILITY OF SUCH DAMAGE. 
023 */
024package org.cleartk.timeml.eval;
025
026import java.io.File;
027import java.util.Collection;
028
029import org.apache.uima.jcas.JCas;
030import org.apache.uima.jcas.cas.TOP;
031import org.cleartk.eval.AnnotationStatistics;
032import org.cleartk.timeml.util.CleartkInternalModelFactory;
033import org.apache.uima.fit.util.JCasUtil;
034
035import com.google.common.base.Function;
036
037/**
038 * <br>
039 * Copyright (c) 2012, Regents of the University of Colorado <br>
040 * All rights reserved.
041 * 
042 * @author Steven Bethard
043 */
044public class ModelInfo<ANNOTATION_TYPE extends TOP> {
045
046  public Class<ANNOTATION_TYPE> annotatedClass;
047
048  public String annotatedFeatureName;
049
050  public Function<ANNOTATION_TYPE, ?> getSpan;
051
052  public Function<ANNOTATION_TYPE, String> getOutcome;
053
054  public CleartkInternalModelFactory modelFactory;
055
056  public String[] trainingArguments;
057
058  public ModelInfo(
059      Class<ANNOTATION_TYPE> annotatedClass,
060      String annotatedFeatureName,
061      Function<ANNOTATION_TYPE, ? extends Object> getSpan,
062      CleartkInternalModelFactory modelFactory,
063      String[] trainingArguments) {
064    this.annotatedClass = annotatedClass;
065    this.annotatedFeatureName = annotatedFeatureName;
066    this.getSpan = getSpan;
067    if (this.annotatedFeatureName == null) {
068      this.getOutcome = AnnotationStatistics.annotationToNull();
069    } else {
070      this.getOutcome = AnnotationStatistics.annotationToFeatureValue(this.annotatedFeatureName);
071    }
072    this.modelFactory = modelFactory;
073    this.trainingArguments = trainingArguments;
074  }
075
076  public File getModelSubdirectory(File directory) {
077    String annotatorName = this.modelFactory.getAnnotatorClass().getName();
078    return new File(new File(directory, "models"), annotatorName);
079  }
080
081  public void updateStatistics(
082      AnnotationStatistics<String> statistics,
083      JCas goldView,
084      JCas systemView) {
085    Collection<ANNOTATION_TYPE> goldAnns = JCasUtil.select(goldView, this.annotatedClass);
086    Collection<ANNOTATION_TYPE> systemAnns = JCasUtil.select(systemView, this.annotatedClass);
087    statistics.add(
088        goldAnns,
089        systemAnns,
090        this.getSpan,
091        this.getOutcome);
092  }
093}