PopulationWriterHandlerImplV6.java

Go to the documentation of this file.

/* *********************************************************************** *
 * project: org.matsim.*
 * PlansWriterHandlerImplV4.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.population.io;

import static org.matsim.core.utils.io.XmlUtils.encodeAttributeValue;
import static org.matsim.core.utils.io.XmlUtils.encodeContent;

import java.io.BufferedWriter;
import java.io.IOException;
import java.util.Map;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.matsim.api.core.v01.Coord;
import org.matsim.api.core.v01.Id;
import org.matsim.api.core.v01.population.Activity;
import org.matsim.api.core.v01.population.Leg;
import org.matsim.api.core.v01.population.Person;
import org.matsim.api.core.v01.population.Plan;
import org.matsim.api.core.v01.population.PlanElement;
import org.matsim.api.core.v01.population.Population;
import org.matsim.api.core.v01.population.Route;
import org.matsim.core.population.PersonUtils;
import org.matsim.core.population.routes.NetworkRoute;
import org.matsim.core.router.TripStructureUtils;
import org.matsim.core.utils.geometry.CoordinateTransformation;
import org.matsim.core.utils.io.MatsimXmlWriter;
import org.matsim.core.utils.misc.Time;
import org.matsim.utils.objectattributes.AttributeConverter;
import org.matsim.utils.objectattributes.attributable.Attributes;
import org.matsim.utils.objectattributes.attributable.AttributesImpl;
import org.matsim.utils.objectattributes.attributable.AttributesUtils;
import org.matsim.utils.objectattributes.attributable.AttributesXmlWriterDelegate;
import org.matsim.vehicles.Vehicle;

/*package*/ class PopulationWriterHandlerImplV6 implements PopulationWriterHandler {
    private static final Logger log = LogManager.getLogger( PopulationWriterHandlerImplV6.class );

    // TODO: infrastructure to inject converters
    private final AttributesXmlWriterDelegate attributesWriter = new AttributesXmlWriterDelegate();
    private final CoordinateTransformation coordinateTransformation;

    PopulationWriterHandlerImplV6(CoordinateTransformation coordinateTransformation) {
        this.coordinateTransformation = coordinateTransformation;
    }

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

    @Override
    public void writeHeaderAndStartElement(final BufferedWriter out) throws IOException {
        out.write("<?xml version=\"1.0\" encoding=\"utf-8\"?>\n");
        out.write("<!DOCTYPE population SYSTEM \"" + MatsimXmlWriter.DEFAULT_DTD_LOCATION + "population_v6.dtd\">\n\n");
    }

    @Override
    public void startPlans(final Population plans, final BufferedWriter out) throws IOException {
        out.write("<population");
        if (plans.getName() != null) {
            out.write(" desc=\"" + encodeAttributeValue(plans.getName()) + "\"");
        }
        out.write(">\n\n");

        this.attributesWriter.writeAttributes( "\t" , out , plans.getAttributes() );

        out.write("\n\n");
    }

    @Override
    public void writePerson(final Person person, final BufferedWriter out) throws IOException {
        this.startPerson(person, out);
        for (Plan plan : person.getPlans()) {
            startPlan(plan, out);
            // act/leg
            for (PlanElement pe : plan.getPlanElements()) {
                if (pe instanceof Activity) {
                    Activity act = (Activity) pe;
                    this.writeAct(act, out);
                }
                else if (pe instanceof Leg) {
                    Leg leg = (Leg) pe;
                    this.startLeg(leg, out);
                    // route
                    Route route = leg.getRoute();
                    if (route != null) {
                        PopulationWriterHandlerImplV6.startRoute(route, out);
                        PopulationWriterHandlerImplV6.endRoute(out);
                    }
                    PopulationWriterHandlerImplV6.endLeg(out);
                }
            }
            PopulationWriterHandlerImplV6.endPlan(out);
        }
        PopulationWriterHandlerImplV6.endPerson(out);
        this.writeSeparator(out);
    }

    @Override
    public void endPlans(final BufferedWriter out) throws IOException {
        out.write("</population>\n");
        out.flush();
    }

    private void startPerson(final Person person, final BufferedWriter out) throws IOException {
        out.write("\t<person id=\"");
        out.write(encodeAttributeValue(person.getId().toString()));
        out.write("\"");
        out.write(">\n");
        this.attributesWriter.writeAttributes( "\t\t" , out , person.getAttributes() );
    }

    private static void endPerson(final BufferedWriter out) throws IOException {
        out.write("\t</person>\n\n");
    }

    private void startPlan(final Plan plan, final BufferedWriter out) throws IOException {
        out.write("\t\t<plan");
        if (plan.getScore() != null) {
            out.write(" score=\"");
            out.write(plan.getScore().toString());
            out.write("\"");
        }
        if (PersonUtils.isSelected(plan))
            out.write(" selected=\"yes\"");
        else
            out.write(" selected=\"no\"");
        if ((plan.getType() != null)) {
            out.write(" type=\"");
            out.write(encodeAttributeValue(plan.getType()));
            out.write("\"");
        }
        out.write(">\n");
        
        this.attributesWriter.writeAttributes( "\t\t\t\t" , out , plan.getAttributes() );

    }

    private static void endPlan(final BufferedWriter out) throws IOException {
        out.write("\t\t</plan>\n\n");
    }

    private void writeAct(final Activity act, final BufferedWriter out) throws IOException {
        out.write("\t\t\t<activity type=\"");
        out.write(encodeAttributeValue(act.getType()));
        out.write("\"");
        if (act.getLinkId() != null) {
            out.write(" link=\"");
            out.write(encodeAttributeValue(act.getLinkId().toString()));
            out.write("\"");
        }
        if (act.getFacilityId() != null) {
            out.write(" facility=\"");
            out.write(encodeAttributeValue(act.getFacilityId().toString()));
            out.write("\"");
        }
        if (act.getCoord() != null) {
            final Coord coord = this.coordinateTransformation.transform( act.getCoord() );
            out.write(" x=\"");
            out.write(Double.toString( coord.getX() ));
            out.write("\" y=\"");
            out.write(Double.toString( coord.getY() ));
            out.write("\"");

            if ( act.getCoord().hasZ() ) {
                out.write(" z=\"");
                out.write(Double.toString( coord.getZ() ));
                out.write("\"");
            }
        }
        if (act.getStartTime().isDefined()) {
            out.write(" start_time=\"");
            out.write(Time.writeTime(act.getStartTime().seconds()));
            out.write("\"");
        }
        if (act.getMaximumDuration().isDefined()) {
            out.write(" max_dur=\"");
            out.write(Time.writeTime(act.getMaximumDuration().seconds()));
            out.write("\"");
        }
        if (act.getEndTime().isDefined()) {
            out.write(" end_time=\"");
            out.write(Time.writeTime(act.getEndTime().seconds()));
            out.write("\"");
        }
        out.write(" >\n");

        this.attributesWriter.writeAttributes("\t\t\t\t", out, act.getAttributes());

        out.write("\t\t\t</activity>\n");
    }

    private void startLeg(final Leg leg, final BufferedWriter out) throws IOException {
        out.write("\t\t\t<leg mode=\"");
        out.write(encodeAttributeValue(leg.getMode()));
        out.write("\"");
        if (leg.getDepartureTime().isDefined()) {
            out.write(" dep_time=\"");
            out.write(Time.writeTime(leg.getDepartureTime().seconds()));
            out.write("\"");
        }
        if (leg.getTravelTime().isDefined()) {
            out.write(" trav_time=\"");
            out.write(Time.writeTime(leg.getTravelTime().seconds()));
            out.write("\"");
        }
//      if (leg instanceof LegImpl) {
//          LegImpl l = (LegImpl)leg;
//          if (l.getDepartureTime() + l.getTravelTime() != Time.getUndefinedTime()) {
//              out.write(" arr_time=\"");
//              out.write(Time.writeTime(l.getDepartureTime() + l.getTravelTime()));
//              out.write("\"");
//          }
//      }
        // arrival time is in dtd, but no longer evaluated in code (according to not being in API).  kai, jun'16

        out.write(">\n");

        if (leg.getRoutingMode() != null) {
            Attributes attributes = new AttributesImpl();
            AttributesUtils.copyTo(leg.getAttributes(), attributes);
            attributes.putAttribute(TripStructureUtils.routingMode, leg.getRoutingMode());
            this.attributesWriter.writeAttributes( "\t\t\t\t" , out , attributes );
        } else this.attributesWriter.writeAttributes( "\t\t\t\t" , out , leg.getAttributes() );
    }

    private static void endLeg(final BufferedWriter out) throws IOException {
        out.write("\t\t\t</leg>\n");
    }

    private static void startRoute(final Route route, final BufferedWriter out) throws IOException {
        out.write("\t\t\t\t<route ");
        out.write("type=\"");
        out.write(encodeAttributeValue(route.getRouteType()));
        out.write("\"");
        out.write(" start_link=\"");
        out.write(encodeAttributeValue(route.getStartLinkId().toString()));
        out.write("\"");
        out.write(" end_link=\"");
        out.write(encodeAttributeValue(route.getEndLinkId().toString()));
        out.write("\"");
        out.write(" trav_time=\"");
        out.write(Time.writeTime(route.getTravelTime()));
        out.write("\"");
        out.write(" distance=\"");
        out.write(Double.toString(route.getDistance()));
        out.write("\"");
        if ( route instanceof NetworkRoute) {
            out.write(" vehicleRefId=\"");
            final Id<Vehicle> vehicleId = ((NetworkRoute) route).getVehicleId();
            if ( vehicleId==null ) {
                out.write("null");
            } else {
                out.write(encodeAttributeValue(vehicleId.toString()));
            }
            out.write("\"");
        }
        out.write(">");
        String rd = route.getRouteDescription();
        if (rd != null) {
            out.write(encodeContent(rd));
        }
    }

    private static void endRoute(final BufferedWriter out) throws IOException {
        out.write("</route>\n");
    }

    @Override
    public void writeSeparator(final BufferedWriter out) throws IOException {
        out.write("<!-- ====================================================================== -->\n\n");
    }

}