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;
027
028import org.apache.uima.UimaContext;
029import org.apache.uima.resource.ResourceInitializationException;
030import org.cleartk.ml.DataWriterFactory;
031import org.cleartk.ml.SequenceDataWriterFactory;
032import org.cleartk.ml.encoder.features.FeaturesEncoder;
033import org.cleartk.ml.encoder.outcome.OutcomeEncoder;
034import org.apache.uima.fit.component.initialize.ConfigurationParameterInitializer;
035import org.apache.uima.fit.descriptor.ConfigurationParameter;
036import org.apache.uima.fit.factory.initializable.Initializable;
037
038/**
039 * Superclass for {@link DataWriterFactory} and {@link SequenceDataWriterFactory} implementations
040 * that use {@link FeaturesEncoder}s and {@link OutcomeEncoder}s.
041 * 
042 * Note that it does not declare that it implements either of the DataWriterFactory interfaces.
043 * Subclasses should do this.
044 * 
045 * <br>
046 * Copyright (c) 2011, Regents of the University of Colorado <br>
047 * All rights reserved.
048 * 
049 * @author Steven Bethard
050 * @author Philip Ogren
051 */
052public abstract class DirectoryDataWriterFactory implements Initializable {
053
054  public static final String PARAM_OUTPUT_DIRECTORY = "outputDirectory";
055
056  @ConfigurationParameter(
057      name = PARAM_OUTPUT_DIRECTORY,
058      mandatory = true,
059      description = "provides the name of the directory where the "
060          + "training data will be written.  if you do not set this "
061          + "parameter, then you must call setOutputDirectory directly.")
062  protected File outputDirectory;
063
064  public File getOutputDirectory() {
065    return outputDirectory;
066  }
067
068  public void setOutputDirectory(File outputDirectory) {
069    this.outputDirectory = outputDirectory;
070  }
071
072  @Override
073  public void initialize(UimaContext context) throws ResourceInitializationException {
074    ConfigurationParameterInitializer.initialize(this, context);
075  }
076}