ConfigReader.java

Go to the documentation of this file.

/* *********************************************************************** *
 * project: org.matsim.*
 * MatsimConfigReader.java
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 * copyright       : (C) 2007 by the members listed in the COPYING,        *
 *                   LICENSE and WARRANTY file.                            *
 * email           : info at matsim dot org                                *
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *   See also COPYING, LICENSE and WARRANTY file                           *
 *                                                                         *
 * *********************************************************************** */

package org.matsim.core.config;

import java.io.UncheckedIOException;
import java.util.Stack;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.matsim.core.utils.io.MatsimXmlParser;
import org.xml.sax.Attributes;

public final class ConfigReader extends MatsimXmlParser {

    private final static Logger log = LogManager.getLogger(ConfigReader.class);

    private final static String CONFIG_V1 = "config_v1.dtd";
    private final static String CONFIG_V2 = "config_v2.dtd";

    private final ConfigAliases aliases = new ConfigAliases();
    private final Config config;
    private MatsimXmlParser delegate = null;

    private String localDtd;

    public ConfigReader(final Config config) {
        super(ValidationType.DTD_ONLY);
        this.config = config;
    }

    public ConfigAliases getConfigAliases() {
        return this.aliases;
    }

    @Override
    public void startTag(final String name, final Attributes atts, final Stack<String> context) {
        this.delegate.startTag(name, atts, context);
    }

    @Override
    public void endTag(final String name, final String content, final Stack<String> context) {
        this.delegate.endTag(name, content, context);
    }

    public void readFile(final String filename, final String dtdFilename) throws UncheckedIOException {
        // yyyyyy if this is a necessary/useful method, I would prefer it in the superclass.  kai, jul'16

        log.info("trying to read config from " + filename);
      this.localDtd = dtdFilename;
        readFile(filename);
        this.localDtd = null;
    }

    @Override
    protected void setDoctype(final String doctype) {
        super.setDoctype(doctype);
        // Currently the only config-type is v1
        if (CONFIG_V1.equals(doctype)) {
            this.delegate = new ConfigReaderMatsimV1(this.config);
            log.info("using config_v1-reader.");
        }
        else if ( CONFIG_V2.equals( doctype ) ) {
            this.delegate = new ConfigReaderMatsimV2( this.config );
            log.info( "using config_v2-reader" );
        }
        else {
            throw new IllegalArgumentException("Doctype \"" + doctype + "\" not known.");
        }
    }

    // The following did override the inherited resolveEntity method.  But I have no idea why that may have made sense.  kai, jul'16
//  @Override
//  public InputSource resolveEntity(final String publicId, final String systemId) {
//      InputSource is = super.resolveEntity(publicId, systemId);
//      if (is != null) {
//          // everything is fine, we can access the dtd
//          return is;
//      }
//      // okay, standard procedure failed... let's see if we have it locally
//      if (this.localDtd != null) {
//          File dtdFile = new File(this.localDtd);
//          if (dtdFile.exists() && dtdFile.isFile() && dtdFile.canRead()) {
//              log.info("Using the local DTD " + this.localDtd);
//              return new InputSource(this.localDtd);
//          }
//      }
//      // hmm, didn't find the local one either... maybe inside a jar somewhere?
//      int index = systemId.replace('\\', '/').lastIndexOf('/');
//      String shortSystemId = systemId.substring(index + 1);
//      InputStream stream = this.getClass().getResourceAsStream("/dtd/" + shortSystemId);
//      if (stream != null) {
//          log.info("Using local DTD from jar-file " + shortSystemId);
//          return new InputSource(stream);
//      }
//      // we fail...
//      return null;
//  }

}