es.ehu.si.ixa.ixa.pipe.lemma.MultiWordSample Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ixa-pipe-pos Show documentation
POS tagger and lemmatizer of ixa pipes (ixa2.si.ehu.es/ixa-pipes)
There is a newer version: 1.3.3
/* 
 *Copyright 2014 Rodrigo Agerri

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
 */
package es.ehu.si.ixa.ixa.pipe.lemma;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;

import opennlp.tools.util.Span;

/**
 * Class for holding multiwords for a sentence.
 * @author ragerri
 * @version 2014-11-30
 */
public class MultiWordSample {

  private final String id;
  private final List tokens;
  private final List names;
  public static final String DEFAULT_TYPE = "UNK";

  public MultiWordSample(String id, String[] sentence, Span[] multiwords) {

    this.id = id;
    if (sentence == null) {
      throw new IllegalArgumentException("sentence must not be null!");
    }
    if (multiwords == null) {
      multiwords = new Span[0];
    }
    this.tokens = Collections.unmodifiableList(new ArrayList(Arrays.asList(sentence)));
    this.names = Collections.unmodifiableList(new ArrayList(Arrays.asList(multiwords)));
    // TODO: Check that multiword spans are not overlapping, otherwise throw exception
  }

  public MultiWordSample(String[] sentence, Span[] names) {
    this(null, sentence, names);
  }

  public String getId() {
    return id;
  }

  public String[] getSentence() {
    return tokens.toArray(new String[tokens.size()]);
  }

  public Span[] getNames() {
    return names.toArray(new Span[names.size()]);
  }

  @Override
  public boolean equals(Object obj) {

    if (this == obj) {
      return true;
    } else if (obj instanceof MultiWordSample) {
      MultiWordSample a = (MultiWordSample) obj;
      return Arrays.equals(getSentence(), a.getSentence()) &&
          Arrays.equals(getNames(), a.getNames());
    } else {
      return false;
    }
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    
    for (int tokenIndex = 0; tokenIndex < tokens.size(); tokenIndex++) {

      for (Span name : names) {
        if (name.getStart() == tokenIndex) {
          sb.append(" ");
        }

        if (name.getEnd() == tokenIndex) {
          sb.append("").append(' ');
        }
      }
      sb.append(tokens.get(tokenIndex)).append(' ');
    }

    if (tokens.size() > 1)
      sb.setLength(sb.length() - 1);

    for (Span name : names) {
      if (name.getEnd() == tokens.size()) {
        sb.append(' ').append("");
      }
    }
    String multiWordSample = sb.toString();
    return multiWordSample;
  }
  
}