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;
028
029import org.cleartk.ml.Classifier;
030import org.cleartk.ml.CleartkProcessingException;
031import org.cleartk.ml.DataWriter;
032import org.cleartk.ml.Instance;
033import org.cleartk.ml.encoder.features.FeaturesEncoder;
034import org.cleartk.ml.encoder.outcome.OutcomeEncoder;
035
036/**
037 * Superclass for {@link DataWriter} implementations that write training data to a file using
038 * {@link FeaturesEncoder}s and {@link OutcomeEncoder}s.
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 DataWriter_ImplBase<CLASSIFIER_BUILDER_TYPE extends EncodingJarClassifierBuilder<? extends Classifier<OUTCOME_TYPE>, ENCODED_FEATURES_TYPE, OUTCOME_TYPE, ENCODED_OUTCOME_TYPE>, ENCODED_FEATURES_TYPE, OUTCOME_TYPE, ENCODED_OUTCOME_TYPE>
048    extends
049    EncodingDirectoryDataWriter<CLASSIFIER_BUILDER_TYPE, Classifier<OUTCOME_TYPE>, ENCODED_FEATURES_TYPE, OUTCOME_TYPE, ENCODED_OUTCOME_TYPE>
050    implements DataWriter<OUTCOME_TYPE> {
051
052  public DataWriter_ImplBase(File outputDirectory) throws FileNotFoundException {
053    super(outputDirectory);
054  }
055
056  public void write(Instance<OUTCOME_TYPE> instance) throws CleartkProcessingException {
057    writeEncoded(
058        this.classifierBuilder.getFeaturesEncoder().encodeAll(instance.getFeatures()),
059        this.classifierBuilder.getOutcomeEncoder().encode(instance.getOutcome()));
060  }
061
062  /**
063   * Write the encoded features and encoded outcome to the output directory.
064   * 
065   * @param features
066   *          The encoded features.
067   * @param outcome
068   *          The encoded outcome.
069   */
070  protected abstract void writeEncoded(ENCODED_FEATURES_TYPE features, ENCODED_OUTCOME_TYPE outcome)
071      throws CleartkProcessingException;
072
073}