morfologik-addon/src/main/java/opennlp/morfologik/cmdline/builder/XMLDictionaryToTableTool.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 opennlp.morfologik.cmdline.builder;

import java.io.BufferedWriter;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.nio.charset.Charset;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Iterator;
import java.util.Properties;

import morfologik.stemming.DictionaryMetadata;
import opennlp.tools.cmdline.BasicCmdLineTool;
import opennlp.tools.cmdline.CmdLineUtil;
import opennlp.tools.cmdline.TerminateToolException;
import opennlp.tools.postag.POSDictionary;

public class XMLDictionaryToTableTool extends BasicCmdLineTool {

  interface Params extends XMLDictionaryToTableParams {
  }

  private String SEPARATOR;

  public String getShortDescription() {
    return "reads an OpenNLP XML tag dictionary and outputs it in a tab separated file";
  }

  public String getHelp() {
    return getBasicHelp(Params.class);
  }

  public void run(String[] args) {
    Params params = validateAndParseParams(args, Params.class);

    File dictInFile = params.getInputFile();
    File dictOutFile = params.getOutputFile();
    Charset encoding = params.getEncoding();
    SEPARATOR = params.getSeparator();

    CmdLineUtil.checkInputFile("dictionary input file", dictInFile);
    CmdLineUtil.checkOutputFile("dictionary output file", dictOutFile);

    POSDictionary tagDictionary = null;
    try {
      tagDictionary = POSDictionary.create(new FileInputStream(dictInFile));
    } catch (IOException e) {
      throw new TerminateToolException(-1,
          "Error while loading XML POS Dictionay: " + e.getMessage(), e);
    }
    Iterator<String> iterator = tagDictionary.iterator();

    try (BufferedWriter writer = Files.newBufferedWriter(dictOutFile.toPath(),
        encoding)) {
      while (iterator.hasNext()) {
        String word = iterator.next();
        for (String tag : tagDictionary.getTags(word)) {
          if(valid(word,tag)) {
            String entry = createEntry(word, tag);
            writer.write(entry);
            writer.newLine();
          }
        }
      }
      writer.close();
      System.out.println("Created dictionary: " + dictOutFile.toPath());
    } catch (IOException e) {
      throw new TerminateToolException(-1, "Error while writing output: "
          + e.getMessage(), e);
    }
    
    Properties info = new Properties();
    info.setProperty("fsa.dict.separator", SEPARATOR);
    info.setProperty("fsa.dict.encoding", params.getEncoding().name());
    info.setProperty("fsa.dict.encoder", params.getEncoder());
    
    Path metaPath = DictionaryMetadata.getExpectedMetadataLocation(dictOutFile.toPath());
    
    try {
      info.store(Files.newOutputStream(metaPath), "Info file for FSA Morfologik dictionary.");
    } catch (IOException e) {
      throw new TerminateToolException(-1, "Error while writing metadata output: "
          + e.getMessage(), e);
    }
    System.out.println("Created metadata: " + dictOutFile.toPath());
    
  }

  private boolean valid(String word, String tag) {
    if(word.contains(SEPARATOR) || tag.contains(SEPARATOR)) {
      System.out
          .println("Warn: invalid entry because contains separator - word: "
              + word + " tag: " + tag);
      return false;
    }
    
    return true;
  }

  private String createEntry(String word, String tag) {
    
    String entry = "" + SEPARATOR +// base
        word + SEPARATOR +
        tag;
        
    return entry;
  }

}