001/** 
002 * Copyright (c) 2011, 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.ml.baseline;
025
026import java.io.File;
027import java.io.IOException;
028import java.io.InputStreamReader;
029import java.util.jar.JarInputStream;
030import java.util.jar.JarOutputStream;
031
032import org.cleartk.ml.jar.JarClassifierBuilder;
033import org.cleartk.ml.jar.JarStreams;
034
035import com.google.common.base.Charsets;
036import com.google.common.io.CharStreams;
037import com.google.common.io.Files;
038
039/**
040 * 
041 * <br>
042 * Copyright (c) 2011, Regents of the University of Colorado <br>
043 * All rights reserved.
044 * 
045 * @author Steven Bethard
046 */
047public abstract class SingleOutcomeClassifierBuilder<OUTCOME_TYPE> extends
048    JarClassifierBuilder<SingleOutcomeClassifier<OUTCOME_TYPE>> {
049
050  private static final String MODEL_NAME = "model.singlevalue";
051
052  public File getTrainingDataFile(File dir) {
053    return new File(dir, "training-data.outcomes");
054  }
055
056  protected abstract OUTCOME_TYPE parseOutcome(String outcome);
057
058  protected void writeOutcome(File dir, OUTCOME_TYPE outcome) throws IOException {
059    Files.write(outcome.toString(), new File(dir, MODEL_NAME), Charsets.US_ASCII);
060  }
061
062  @Override
063  protected void packageClassifier(File dir, JarOutputStream modelStream) throws IOException {
064    super.packageClassifier(dir, modelStream);
065    JarStreams.putNextJarEntry(modelStream, MODEL_NAME, new File(dir, MODEL_NAME));
066  }
067
068  protected OUTCOME_TYPE value;
069
070  @Override
071  protected void unpackageClassifier(JarInputStream modelStream) throws IOException {
072    super.unpackageClassifier(modelStream);
073    JarStreams.getNextJarEntry(modelStream, MODEL_NAME);
074    InputStreamReader reader = new InputStreamReader(modelStream, Charsets.US_ASCII);
075    this.value = this.parseOutcome(CharStreams.toString(reader));
076  }
077
078  @Override
079  protected SingleOutcomeClassifier<OUTCOME_TYPE> newClassifier() {
080    return new SingleOutcomeClassifier<OUTCOME_TYPE>(this.value);
081  }
082}