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.jar;
025
026import java.io.File;
027import java.io.IOException;
028
029import org.cleartk.ml.CleartkProcessingException;
030import org.cleartk.ml.DataWriter;
031import org.cleartk.ml.SequenceDataWriter;
032
033/**
034 * Superclass for {@link DataWriter} and {@link SequenceDataWriter} implementations that saves files
035 * to a training directory using a {@link JarClassifierBuilder}.
036 * 
037 * Note that it does not declare that it implements either of the DataWriter interfaces. Subclasses
038 * should do this.
039 * 
040 * <br>
041 * Copyright (c) 2011, Regents of the University of Colorado <br>
042 * All rights reserved.
043 * 
044 * @author Steven Bethard
045 * @author Philip Ogren
046 */
047public abstract class DirectoryDataWriter<CLASSIFIER_BUILDER extends JarClassifierBuilder<? extends CLASSIFIER_TYPE>, CLASSIFIER_TYPE> {
048
049  protected File outputDirectory;
050
051  protected CLASSIFIER_BUILDER classifierBuilder;
052
053  public DirectoryDataWriter(File outputDirectory) {
054    this.outputDirectory = outputDirectory;
055    if (!this.outputDirectory.exists()) {
056      this.outputDirectory.mkdirs();
057    }
058    this.classifierBuilder = this.newClassifierBuilder();
059  }
060
061  /**
062   * Constructs a new {@link JarClassifierBuilder} that will be set as the
063   * {@link #classifierBuilder} during object construction.
064   */
065  protected abstract CLASSIFIER_BUILDER newClassifierBuilder();
066
067  /**
068   * Get the {@link JarClassifierBuilder} associated with this DataWriter.
069   * 
070   * @return The classifier builder.
071   */
072  public CLASSIFIER_BUILDER getClassifierBuilder() {
073    return classifierBuilder;
074  }
075
076  /**
077   * Basic implementation of {@link DataWriter#finish()} and {@link SequenceDataWriter#finish()}
078   * that calls {@link JarClassifierBuilder#saveToTrainingDirectory(File)}
079   */
080  public void finish() throws CleartkProcessingException {
081    try {
082      this.classifierBuilder.saveToTrainingDirectory(this.outputDirectory);
083    } catch (IOException e) {
084      throw new CleartkProcessingException(e);
085    }
086  }
087}