gate.plugin.learningframework.features.FeatureSpecSimpleAttribute Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of learningframework Show documentation

A GATE plugin that provides many different machine learning algorithms for a wide range of NLP-related machine learning tasks like text classification, tagging, or chunking.

There is a newer version: 4.2

Show newest version

/*
 * Copyright (c) 2015-2016 The University Of Sheffield.
 *
 * This file is part of gateplugin-LearningFramework 
 * (see https://github.com/GateNLP/gateplugin-LearningFramework).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 2.1 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this software. If not, see .
 */

package gate.plugin.learningframework.features;

import gate.plugin.learningframework.mallet.LFAlphabet;
import java.io.Serializable;

/**
 *
 * @author Johann Petrak
 */
public class FeatureSpecSimpleAttribute extends FeatureSpecAttribute implements Serializable, Cloneable {

  private static final long serialVersionUID = -2346560362547132478L;

  /**
   * Constructor
   * @param aname attribute name 
   * @param type attribute type
   * @param feature feature name
   * @param datatype datatype
   * @param codeas code as setting
   * @param missingValueTreatment missing value treatment
   * @param missingValueValue missing value 
   * @param scalingMethod scalign method
   * @param transformMethod transformation method
   * @param withinType withing which sequence type
   * @param listsep list separator string
   * @param featureName4Value which feature to get the value from
   */
  public FeatureSpecSimpleAttribute(
          String aname, 
          String type, 
          String feature, 
          Datatype datatype, 
          CodeAs codeas, 
          MissingValueTreatment missingValueTreatment, 
          String missingValueValue, 
          String scalingMethod, 
          String transformMethod,
          String withinType,
          String listsep,
          String featureName4Value) {
    this.name = aname;
    this.annType = type;
    this.feature = feature;
    this.datatype = datatype;
    this.codeas = codeas;
    this.missingValueTreatment = missingValueTreatment;
    if (datatype == Datatype.nominal && codeas == CodeAs.number) {
      alphabet = new LFAlphabet();
    }
    this.withinType = withinType;
    this.listsep = listsep;
    this.featureName4Value = featureName4Value;
    this.missingValueValue = missingValueValue;
    featureCode = "A";
  }
  public CodeAs codeas = CodeAs.one_of_k;
  public MissingValueTreatment missingValueTreatment = MissingValueTreatment.zero_value;
  public LFAlphabet alphabet;
  public String withinType;
  public String featureName4Value;

  @Override
  public void stopGrowth() {
    if(alphabet!=null) { alphabet.stopGrowth(); }
  }

  
  @Override
  public void startGrowth() {
    if(alphabet!=null) { alphabet.startGrowth(); }
  }
  
  @Override
  public String toString() {
    return "SimpleAttribute(name="+name+
            ",type="+annType+
            ",feature="+feature+
            ",datatype="+datatype+
            ",missingvaluetreatment="+missingValueTreatment+
            ",within="+withinType+
            ",codeas="+codeas;
  }
  
  @Override
  public FeatureSpecSimpleAttribute clone() {
      return (FeatureSpecSimpleAttribute) super.clone();
  }
  

}