com.ontotext.kim.model.Options Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gazetteer-lkb Show documentation
A Large Knowledge Based (LKB) Gazetteer
The newest version!
package com.ontotext.kim.model;

import gate.util.Strings;

import java.io.File;
import java.io.FileReader;
import java.io.IOException;
import java.io.Reader;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;

import org.apache.commons.io.IOUtils;
import org.apache.log4j.Logger;
import org.openrdf.model.Graph;
import org.openrdf.model.Statement;
import org.openrdf.model.impl.URIImpl;
import org.openrdf.rio.RDFFormat;
import org.openrdf.rio.RDFHandlerException;
import org.openrdf.rio.RDFParseException;
import org.openrdf.rio.RDFParser;
import org.openrdf.rio.RDFParserRegistry;
import org.openrdf.rio.helpers.StatementCollector;

/**
 * Options reader for the LKB Gazetteer
 * 
 * @author mnozchev
 */
public class Options {

  public static final String SENSITIVE = "casesensitive";
  public static final String ALL_UPPER = "casesensitiveAllUpper";
  public static final String INSENSITIVE = "caseinsensitive";
  
  private final Map opts;
  private final static Logger log = Logger.getLogger(Options.class);
  private final File dictionaryPath;
  
  public Options(Map opts, File dictionaryPath) {
    this.opts = opts;
    this.dictionaryPath = dictionaryPath;
  }
  
  /**
   * Loads the configuration of the dictionary from a "config.ttl" Turtle RDF
   * 
   * @param dictionaryPath the dictionary path, not null
   * @return an Options instance, no null
   */
  @SuppressWarnings("deprecation")
  public static Options load(File dictionaryPath) {    
    Map opts = new HashMap();
    Reader inp = null;
    try {
      inp = new FileReader(new File(dictionaryPath, getConfigFileName()));
      RDFParser parser = RDFParserRegistry.getInstance().get(RDFFormat.TURTLE).getParser();
      Graph statements = new org.openrdf.model.impl.GraphImpl();
      parser.setRDFHandler(new StatementCollector(statements));      
      parser.parse(inp, "http://www.ontotext.com/lkb_gazetteer#");
      Iterator it = statements.match(new URIImpl("http://www.ontotext.com/lkb_gazetteer#DictionaryConfiguration"), null, null);
      while (it.hasNext()) {
        Statement st = it.next();
        opts.put(st.getPredicate().getLocalName().toLowerCase(), st.getObject().stringValue());
      }
    }
    catch(IOException e) {
      log.error("Could not read config file from " + new File(dictionaryPath, getConfigFileName()).getAbsolutePath(), e);
    }
    catch(RDFParseException e) {
      log.error("Config file accessible but was not a valid Turtle RDF.", e);
    }
    catch(RDFHandlerException e) {
      log.error("Unexpected error when reading the configuration RDF.", e);
    }
    finally {
      IOUtils.closeQuietly(inp);
    }
    return new Options(Collections.unmodifiableMap(opts), dictionaryPath);
  }

  public static String getConfigFileName() {    
    return "config.ttl";
  }

  public boolean isCacheEnabled() {    
    return "enabled".equalsIgnoreCase(opts.get("caching"));
  }

  public String getCaseSensitivity() {    
    String res = opts.get("casesensitivity");
    return res != null ? res : INSENSITIVE;
  }
  
  public String getSeparator() {
    String ret = opts.get("gazetteerfeatureseparator");
    if(ret == null) { ret = ""; }
    return Strings.unescape(ret);
  }
  
  public Map getMap() {
    return opts; // unmodifiable
  }

  public File getIgnoreListPath() {   
    String igPath = opts.get("ignorelist");
    if (igPath == null)
      return null;
    File res = new File(igPath);
    return res.isAbsolute() ? res : new File(dictionaryPath, igPath); 
  }
}