001/** 
002 * Copyright (c) 2012, 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.feature.transform;
025
026import java.util.List;
027
028import org.cleartk.ml.Feature;
029
030/**
031 * Abstract base class for transformable features.
032 * <P>
033 * 
034 * <br>
035 * Copyright (c) 2012, Regents of the University of Colorado <br>
036 * All rights reserved.
037 * 
038 * @author Lee Becker
039 * 
040 */
041public class TransformableFeature extends Feature {
042
043  /**
044   * 
045   */
046  private static final long serialVersionUID = 1L;
047
048  protected List<Feature> features;
049
050  private static final String UNSUPPORTED_OPERATION_EXCEPTION_MESSAGE = "This is a temporary "
051      + "place-holder feature that cannot be written by most data writers. Instead, it must be "
052      + "written with an " + InstanceDataWriter.class.getName() + "and then the instances should"
053      + "be transformed by the appropriate " + TrainableExtractor.class.getName();
054
055  public TransformableFeature(String name, List<Feature> features) {
056    super();
057    this.setName(name);
058    this.features = features;
059  }
060
061  // Following are unsupported to prevent anything but InstanceDataWriter from writing transformable
062  // features.
063  @Override
064  public Object getValue() {
065    throw new UnsupportedOperationException(UNSUPPORTED_OPERATION_EXCEPTION_MESSAGE);
066  }
067
068  @Override
069  public void setValue(Object value) {
070    throw new UnsupportedOperationException(UNSUPPORTED_OPERATION_EXCEPTION_MESSAGE);
071  }
072
073  public List<Feature> getFeatures() {
074    return this.features;
075  }
076
077}