ObjectAttributesXmlReader.java

Go to the documentation of this file.

/* *********************************************************************** *
 * project: org.matsim.*
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 * copyright       : (C) 2010 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.utils.objectattributes;

import static org.matsim.utils.objectattributes.ObjectAttributesXmlWriter.ATTR_ATTRIBUTECLASS;
import static org.matsim.utils.objectattributes.ObjectAttributesXmlWriter.ATTR_ATTRIBUTENAME;
import static org.matsim.utils.objectattributes.ObjectAttributesXmlWriter.ATTR_OBJECTID;
import static org.matsim.utils.objectattributes.ObjectAttributesXmlWriter.TAG_ATTRIBUTE;
import static org.matsim.utils.objectattributes.ObjectAttributesXmlWriter.TAG_OBJECT;

import java.util.Map;
import java.util.Stack;

import com.google.inject.Inject;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.matsim.core.utils.io.MatsimXmlParser;
import org.xml.sax.Attributes;
import org.xml.sax.SAXException;

public class ObjectAttributesXmlReader extends MatsimXmlParser {
    private final static Logger log = LogManager.getLogger(ObjectAttributesXmlReader.class);
    private final ObjectAttributesConverter converter = new ObjectAttributesConverter();
    private final ObjectAttributes attributes;
    private boolean readCharacters = false;
    private String currentObject = null;
    private String currentAttribute = null;
    private String currentAttributeClass = null;
    private long count = 0;


    public ObjectAttributesXmlReader(final ObjectAttributes attributes) {
        super(ValidationType.NO_VALIDATION);
        this.attributes = attributes;
        super.setValidating(false);
    }

    @Override
    public void startTag(String name, Attributes atts, Stack<String> context) {
        if (TAG_ATTRIBUTE.equals(name)) {
            this.currentAttribute = atts.getValue(ATTR_ATTRIBUTENAME);
            this.currentAttributeClass = atts.getValue(ATTR_ATTRIBUTECLASS);
            this.readCharacters = true;
        } else if (TAG_OBJECT.equals(name)) {
            this.currentObject = atts.getValue(ATTR_OBJECTID);
        }
    }

    @Override
    public void endTag(String name, String content, Stack<String> context) {
        if (TAG_ATTRIBUTE.equals(name)) {
            this.readCharacters = false;

            Object o = converter.convert(this.currentAttributeClass, content);
            this.attributes.putAttribute(this.currentObject, this.currentAttribute, o);
        } else if (TAG_OBJECT.equals(name)) {
            if (this.count % 100000 == 0) {
                log.info("reading object #" + this.count);
            }
            this.count++;
            this.currentObject = null;
        }
    }

    @Override
    public void characters(char[] ch, int start, int length) throws SAXException {
        if (this.readCharacters) {
            super.characters(ch, start, length);
        }
        // ignore characters to prevent OutOfMemoryExceptions
        /* non-validating files contain empty tags with attributes,
         * but without the dtd or schema, all whitespace between tags is handled
         * by characters and added up by super.characters, consuming huge
         * amount of memory when large files are read in.
         */
    }

    public AttributeConverter<?> putAttributeConverter(final Class<?> clazz, final AttributeConverter<?> converter) {
        return this.converter.putAttributeConverter(clazz, converter);
    }

    @Inject
    public void putAttributeConverters( final Map<Class<?>, AttributeConverter<?>> converters ) {
        this.converter.putAttributeConverters(converters);
    }

    public AttributeConverter<?> removeAttributeConverter(final Class<?> clazz) {
        return this.converter.removeAttributeConverter(clazz);
    }

}