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.FileNotFoundException;
028import java.io.PrintWriter;
029
030import org.cleartk.ml.CleartkProcessingException;
031import org.cleartk.ml.DataWriter;
032import org.cleartk.ml.SequenceDataWriter;
033import org.cleartk.ml.encoder.features.FeaturesEncoder;
034import org.cleartk.ml.encoder.outcome.OutcomeEncoder;
035
036/**
037 * Superclass for {@link DataWriter} and {@link SequenceDataWriter} implementations that write
038 * training data to a file using a classifier builder with {@link FeaturesEncoder}s and
039 * {@link OutcomeEncoder}s
040 * 
041 * Note that it does not declare that it implements either of the DataWriter interfaces. Subclasses
042 * should do this.
043 * 
044 * <br>
045 * Copyright (c) 2011, Regents of the University of Colorado <br>
046 * All rights reserved.
047 * 
048 * @author Steven Bethard
049 * @author Philip Ogren
050 */
051public abstract class EncodingDirectoryDataWriter<CLASSIFIER_BUILDER_TYPE extends EncodingJarClassifierBuilder<? extends CLASSIFIER_TYPE, ENCODED_FEATURES_TYPE, OUTCOME_TYPE, ENCODED_OUTCOME_TYPE>, CLASSIFIER_TYPE, ENCODED_FEATURES_TYPE, OUTCOME_TYPE, ENCODED_OUTCOME_TYPE>
052    extends DirectoryDataWriter<CLASSIFIER_BUILDER_TYPE, CLASSIFIER_TYPE> {
053
054  public EncodingDirectoryDataWriter(File outputDirectory) throws FileNotFoundException {
055    super(outputDirectory);
056    this.trainingDataFile = this.classifierBuilder.getTrainingDataFile(this.outputDirectory);
057    this.trainingDataWriter = new PrintWriter(this.trainingDataFile);
058  }
059
060  protected File trainingDataFile;
061
062  protected PrintWriter trainingDataWriter;
063
064  public void setFeaturesEncoder(FeaturesEncoder<ENCODED_FEATURES_TYPE> featuresEncoder) {
065    this.classifierBuilder.setFeaturesEncoder(featuresEncoder);
066  }
067
068  public void setOutcomeEncoder(OutcomeEncoder<OUTCOME_TYPE, ENCODED_OUTCOME_TYPE> outcomeEncoder) {
069    this.classifierBuilder.setOutcomeEncoder(outcomeEncoder);
070  }
071
072  @Override
073  public void finish() throws CleartkProcessingException {
074    this.trainingDataWriter.close();
075    super.finish();
076  }
077
078}