001/*
002 * Copyright (c) 2013, 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.liblinear;
025
026import java.io.File;
027import java.io.IOException;
028import java.io.InputStreamReader;
029import java.util.Arrays;
030import java.util.jar.JarInputStream;
031import java.util.jar.JarOutputStream;
032
033import org.cleartk.ml.jar.ClassifierBuilder_ImplBase;
034import org.cleartk.ml.jar.JarStreams;
035
036import de.bwaldvogel.liblinear.FeatureNode;
037import de.bwaldvogel.liblinear.Model;
038import de.bwaldvogel.liblinear.Train;
039
040/**
041 * <br>
042 * Copyright (c) 2013, Regents of the University of Colorado <br>
043 * All rights reserved.
044 * 
045 * @author Steven Bethard
046 */
047public abstract class GenericLibLinearClassifierBuilder<CLASSIFIER_TYPE extends GenericLibLinearClassifier<OUTCOME_TYPE>, OUTCOME_TYPE>
048    extends ClassifierBuilder_ImplBase<CLASSIFIER_TYPE, FeatureNode[], OUTCOME_TYPE, Integer> {
049
050  @Override
051  public File getTrainingDataFile(File dir) {
052    return new File(dir, "training-data.liblinear");
053  }
054
055  private String getModelName() {
056    return "model.liblinear";
057  }
058
059  private File getModelFile(File dir) {
060    return new File(dir, this.getModelName());
061  }
062
063  @Override
064  public void trainClassifier(File dir, String... args) throws Exception {
065    args = Arrays.copyOf(args, args.length + 2);
066    args[args.length - 2] = this.getTrainingDataFile(dir).getPath();
067    args[args.length - 1] = this.getModelFile(dir).getPath();
068    Train.main(args);
069  }
070
071  @Override
072  protected void packageClassifier(File dir, JarOutputStream modelStream) throws IOException {
073    super.packageClassifier(dir, modelStream);
074    JarStreams.putNextJarEntry(modelStream, this.getModelName(), this.getModelFile(dir));
075  }
076
077  protected Model model;
078
079  @Override
080  protected void unpackageClassifier(JarInputStream modelStream) throws IOException {
081    super.unpackageClassifier(modelStream);
082    JarStreams.getNextJarEntry(modelStream, this.getModelName());
083    this.model = Model.load(new InputStreamReader(modelStream));
084  }
085}