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.util.List;
027import java.util.Map;
028
029import org.cleartk.ml.Classifier;
030import org.cleartk.ml.CleartkProcessingException;
031import org.cleartk.ml.Feature;
032import org.cleartk.ml.encoder.features.FeaturesEncoder;
033import org.cleartk.ml.encoder.outcome.OutcomeEncoder;
034
035/**
036 * Superclass for {@link Classifier} implementations that use {@link FeaturesEncoder}s and
037 * {@link OutcomeEncoder}s.
038 * 
039 * <br>
040 * Copyright (c) 2011, Regents of the University of Colorado <br>
041 * All rights reserved.
042 * 
043 * @author Steven Bethard
044 * @author Philip Ogren
045 */
046public abstract class Classifier_ImplBase<ENCODED_FEATURES_TYPE, OUTCOME_TYPE, ENCODED_OUTCOME_TYPE>
047    extends EncodingJarClassifier<ENCODED_FEATURES_TYPE, OUTCOME_TYPE, ENCODED_OUTCOME_TYPE>
048    implements Classifier<OUTCOME_TYPE> {
049
050  public Classifier_ImplBase(
051      FeaturesEncoder<ENCODED_FEATURES_TYPE> featuresEncoder,
052      OutcomeEncoder<OUTCOME_TYPE, ENCODED_OUTCOME_TYPE> outcomeEncoder) {
053    super(featuresEncoder, outcomeEncoder);
054  }
055
056  @Override
057  public Map<OUTCOME_TYPE, Double> score(List<Feature> features) throws CleartkProcessingException {
058    throw new UnsupportedOperationException(
059        "there is no default implementation of the score method.");
060  }
061}