PersonUtils.java

Go to the documentation of this file.

/* *********************************************************************** *
 * project: org.matsim.*
 * PersonUtils.java
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 * copyright       : (C) 2019 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;

import java.util.Iterator;
import java.util.Map;
import java.util.TreeSet;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.matsim.api.core.v01.Id;
import org.matsim.api.core.v01.population.Person;
import org.matsim.api.core.v01.population.Plan;
import org.matsim.vehicles.Vehicle;
import org.matsim.vehicles.VehicleType;
import org.matsim.vehicles.VehicleUtils;

public final class PersonUtils {
    private PersonUtils() {
    } // do not instantiate

    private final static String SEX_ATTRIBUTE = "sex";
    private final static String HAS_LICENSE = "hasLicense";
    private static final String CAR_AVAIL = "carAvail";
    private static final String EMPLOYED = "employed";
    private static final String AGE = "age";
    private static final String TRAVEL_CARDS = "travelcards";
    private static final String PERSONAL_INCOME_ATTRIBUTE_NAME = "income";
    private static final String PERSONAL_SCORING_MODE_CONSTANTS_ATTRIBUTE_NAME = "modeConstants";
    private final static Logger log = LogManager.getLogger(Person.class);

    @Deprecated // use methods of interface Person
    //yyy there is no such method in the Person interface.  paul, feb'25
    public static Plan createAndAddPlan(Person person, final boolean selected) {
        Plan p = PopulationUtils.createPlan(person);
        person.addPlan(p);
        if (selected) {
            person.setSelectedPlan(p);
        }
        return p;
    }

    public static void removeUnselectedPlans(Person person) {
        for (Iterator<? extends Plan> iter = person.getPlans().iterator(); iter.hasNext(); ) {
            Plan plan = iter.next();
            if (!PersonUtils.isSelected(plan)) {
                iter.remove();
            }
        }
    }

    public static String getSex(Person person) {
        return (String) person.getAttributes().getAttribute(SEX_ATTRIBUTE);
    }

    public static Integer getAge(Person person) {
        return (Integer) person.getAttributes().getAttribute(AGE);
    }

    public static String getLicense(Person person) {
        return (String) person.getAttributes().getAttribute(HAS_LICENSE);
    }

    public static Double getIncome(Person person) {
        return (Double) person.getAttributes().getAttribute(PERSONAL_INCOME_ATTRIBUTE_NAME);
    }

    public static Map<String, String> getModeConstants(Person person) {
        try {

            return (Map<String, String>) person.getAttributes().getAttribute(PERSONAL_SCORING_MODE_CONSTANTS_ATTRIBUTE_NAME);
        } catch (Exception e) {
            log.error("Error retrieving personalScoringModeConstants from attribute " +
                PERSONAL_SCORING_MODE_CONSTANTS_ATTRIBUTE_NAME + ". Should be a Map<String,String>.");
            log.error(e.getMessage());
            throw new RuntimeException(e.getMessage());
        }
    }

    public static boolean hasLicense(Person person) {
        return ("yes".equals(getLicense(person))) || ("true".equals(getLicense(person)));
    }

    public static String getCarAvail(Person person) {
        return (String) person.getAttributes().getAttribute(CAR_AVAIL);
    }

    public static boolean canUseCar(Person person) {
        return !"no".equals(PersonUtils.getLicense(person)) && !"never".equals(PersonUtils.getCarAvail(person));
    }

    public static Boolean isEmployed(Person person) {
        return (Boolean) person.getAttributes().getAttribute(EMPLOYED);
    }


    public static void setAge(Person person, final Integer age) {
        if (age != null) {
            person.getCustomAttributes().put(AGE, age);
            person.getAttributes().putAttribute(AGE, age);
        }
    }

    public static void setSex(Person person, final String sex) {
        if (sex != null) {
            person.getCustomAttributes().put(SEX_ATTRIBUTE, sex);
            person.getAttributes().putAttribute(SEX_ATTRIBUTE, sex);
        }
    }

    public static void setLicence(Person person, final String licence) {
        if (licence != null) {

            person.getCustomAttributes().put(HAS_LICENSE, licence);
            person.getAttributes().putAttribute(HAS_LICENSE, licence);
        }
    }

    public static void setCarAvail(Person person, final String carAvail) {
        if (carAvail != null) {
            person.getCustomAttributes().put(CAR_AVAIL, carAvail);
            person.getAttributes().putAttribute(CAR_AVAIL, carAvail);
        }
    }

    public static void setEmployed(Person person, final Boolean employed) {
        if (employed != null) {
            person.getCustomAttributes().put(EMPLOYED, employed);
            person.getAttributes().putAttribute(EMPLOYED, employed);
        }
    }

    public static void setIncome(Person person, final double income) {
        person.getCustomAttributes().put(PERSONAL_INCOME_ATTRIBUTE_NAME, income); // deprecated, should not be necessary anymore
        person.getAttributes().putAttribute(PERSONAL_INCOME_ATTRIBUTE_NAME, income);
    }

    public static void setModeConstants(Person person, Map<String, String> mode2scoringConstant) {
        person.getAttributes().putAttribute(PERSONAL_SCORING_MODE_CONSTANTS_ATTRIBUTE_NAME, mode2scoringConstant);
    }

    @Deprecated // yyyy is there a way to use person.getAttributes instead??  kai, nov'16
    public static void addTravelcard(Person person, final String type) {
        if (getTravelcards(person) == null) {
            person.getCustomAttributes().put(TRAVEL_CARDS, new TreeSet<String>());
        }
        if (getTravelcards(person).contains(type)) {
            log.info(person + "[type=" + type + " already exists]");
        } else {
            getTravelcards(person).add(type.intern());
        }
    }

    @Deprecated // use PersonAttributes
    public static TreeSet<String> getTravelcards(Person person) {
        return (TreeSet<String>) person.getCustomAttributes().get(TRAVEL_CARDS);
    }

    public static boolean isSelected(Plan plan) {
        return plan.getPerson().getSelectedPlan() == plan;
    }

    public static void insertVehicleTypesIntoPersonAttributes(Person person, Map<String, Id<VehicleType>> modeToVehicleType) {
        VehicleUtils.insertVehicleTypesIntoPersonAttributes(person, modeToVehicleType);
    }

    public static void insertVehicleIdsIntoPersonAttributes(Person person, Map<String, Id<Vehicle>> modeToVehicle) {
        VehicleUtils.insertVehicleIdsIntoPersonAttributes(person, modeToVehicle);
    }
}