com.joliciel.talismane.machineLearning.TextFileMultivaluedResource Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of talismane-machine-learning Show documentation
There is a newer version: 6.1.8
Show newest version
///////////////////////////////////////////////////////////////////////////////
//Copyright (C) 2014 Joliciel Informatique
//
//This file is part of Talismane.
//
//Talismane is free software: you can redistribute it and/or modify
//it under the terms of the GNU Affero General Public License as published by
//the Free Software Foundation, either version 3 of the License, or
//(at your option) any later version.
//
//Talismane 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 Affero General Public License for more details.
//
//You should have received a copy of the GNU Affero General Public License
//along with Talismane.  If not, see .
//////////////////////////////////////////////////////////////////////////////
package com.joliciel.talismane.machineLearning;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Scanner;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.joliciel.talismane.utils.JolicielException;
import com.joliciel.talismane.utils.WeightedOutcome;

/**
 * An external resource read from a text file.

 * The default name will be the filename.

 * The first line must be "Type: KeyMultiValue". 

 * If a line starts with the string "Name: ", the default name will be replaced
 * by this name.

 * All lines starting with # are skipped.

 * Any other line will be broken up by tabs:

 * For multi-valued resources, the second-to-last tab is the class, the last tab
 * is the weight.

 * All previous tabs are considered to be key components.

 * The same set of key components can have multiple classes with different
 * weights.

 * 
 * @author Assaf Urieli
 *
 */
public class TextFileMultivaluedResource implements ExternalResource>> {
  private static final long serialVersionUID = 1L;
  @SuppressWarnings("unused")
  private static final Logger LOG = LoggerFactory.getLogger(TextFileMultivaluedResource.class);
  Map>> resultsMap = new HashMap>>();

  private String name;

  public TextFileMultivaluedResource(String fileName, Scanner scanner) {
    this.name = fileName;

    int numParts = -1;
    int i = 1;
    while (scanner.hasNextLine()) {
      String line = scanner.nextLine();
      if (line.equals("Type: KeyMultiValue"))
        continue;
      if (line.length() > 0 && !line.startsWith("#")) {
        StringBuilder sb = new StringBuilder();
        String[] parts = line.split("\t");
        if (parts.length == 1 && line.startsWith("Name: ")) {
          this.name = line.substring("Name: ".length());
          i++;
          continue;
        }
        if (numParts < 0)
          numParts = parts.length;
        if (parts.length != numParts)
          throw new JolicielException("Wrong number of elements on line " + i + " in file: " + fileName);

        for (int j = 0; j < numParts - 2; j++) {
          sb.append(parts[j]);
          sb.append("|");
        }
        String key = sb.toString();
        List> resultList = resultsMap.get(key);
        if (resultList == null) {
          resultList = new ArrayList>(1);
          resultsMap.put(key, resultList);
        }
        String outcome = parts[numParts - 2];
        double weight = Double.parseDouble(parts[numParts - 1]);
        resultList.add(new WeightedOutcome(outcome, weight));

      }
      i++;
    }

  }

  @Override
  public List> getResult(List keyElements) {
    StringBuilder sb = new StringBuilder();
    for (String keyElement : keyElements) {
      sb.append(keyElement);
      sb.append("|");
    }
    String key = sb.toString();
    List> resultList = null;

    resultList = resultsMap.get(key);

    return resultList;
  }

  @Override
  public String getName() {
    return name;
  }

  public void setName(String name) {
    this.name = name;
  }

}