gate.plugin.learningframework.data.Attribute 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.data;

import cc.mallet.types.Alphabet;
import gate.plugin.learningframework.features.CodeAs;
import gate.plugin.learningframework.features.Datatype;
import gate.plugin.learningframework.features.MissingValueTreatment;
import gate.plugin.learningframework.mallet.LFAlphabet;
import java.util.Objects;
import org.apache.log4j.Logger;


/**
 * Class that describes a single attribute/feature.
 * @author Johann Petrak
 */
public class Attribute {
  private static final Logger LOG = Logger.getLogger(Attribute.class.getName());
  /**
   * Name of the attribute
   */
  public String name;

  @Override
  public int hashCode() {
    int hash = 3;
    hash = 41 * hash + Objects.hashCode(this.name);
    hash = 41 * hash + this.index;
    return hash;
  }

  @Override
  public boolean equals(Object obj) {
    if (obj == null) {
      return false;
    }
    if (getClass() != obj.getClass()) {
      return false;
    }
    final Attribute other = (Attribute) obj;
    if (!Objects.equals(this.name, other.name)) {
      return false;
    }
    return this.index == other.index;
  }

  public Attribute(String name, int index, Datatype datatype, CodeAs codeAs, MissingValueTreatment mvt, LFAlphabet alphabet) {
    this.name = name;
    this.index = index;
    this.datatype = datatype;
    this.codeAs = codeAs;
    this.alphabet = alphabet;
    this.mvTreatment = mvt;
  }
  /** 
   * Index/location of the attribute in a (sparse) feature vector.
   */
  public int index; 
  /**
   * The type of the values of the attribute/feature
   */
  public Datatype datatype;
  /**
   * If the attribute/feature is nominal, how the value is coded 
   */
  public CodeAs codeAs;
  
  public MissingValueTreatment mvTreatment;

  @Override
  public String toString() {
    return "Attribute{" + "name=" + name + ", index=" + index + ", datatype=" + datatype + ", codeAs=" + codeAs + ", mvt="+mvTreatment+ ", alphabet=" + alphabet + '}';
  }
  /**
   * Dictionary of possible values and their codes if the attribute/feature 
   * is nominal and coded as number
   */
  public Alphabet alphabet;
}