PersonImpl.java

Go to the documentation of this file.

/* *********************************************************************** *
 * project: org.matsim.*
 * Person.java
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 * copyright       : (C) 2007, 2008 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.ArrayList;
import java.util.List;
import java.util.Map;

import org.apache.logging.log4j.LogManager;
import org.matsim.api.core.v01.Customizable;
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.core.replanning.selectors.RandomPlanSelector;
import org.matsim.core.scenario.CustomizableUtils;
import org.matsim.core.scenario.Lockable;
import org.matsim.utils.objectattributes.attributable.Attributes;
import org.matsim.utils.objectattributes.attributable.AttributesImpl;

/* deliberately package */ final class PersonImpl implements Person, Lockable {

    private List<Plan> plans = new ArrayList<>(6);
    private Id<Person> id;

    private Plan selectedPlan = null;

    private Customizable customizableDelegate;
    private boolean locked;

    private final Attributes attributes = new AttributesImpl();

    /* deliberately package */ PersonImpl(final Id<Person> id) {
        this.id = id;
    }

    @Override
    public final Plan getSelectedPlan() {
        return this.selectedPlan;
    }

    @Override
    public boolean addPlan(final Plan plan) {
        plan.setPerson(this);
        // Make sure there is a selected plan if there is at least one plan
        if (this.selectedPlan == null) this.selectedPlan = plan;
        return this.plans.add(plan);
    }

    @Override
    public final void setSelectedPlan(final Plan selectedPlan) {
        if (selectedPlan != null && !plans.contains( selectedPlan )) {
            throw new IllegalStateException("The plan to be set as selected is not null nor stored in the person's plans");
        }
        this.selectedPlan = selectedPlan;
    }

    @Override
    public Plan createCopyOfSelectedPlanAndMakeSelected() {
        Plan oldPlan = this.getSelectedPlan();
        if (oldPlan == null) {
            return null;
        }
        Plan newPlan = PopulationUtils.createPlan(oldPlan.getPerson());
        PopulationUtils.copyFromTo(oldPlan, newPlan, true);
        this.getPlans().add(newPlan);
        this.setSelectedPlan(newPlan);
        return newPlan;
    }

    @Override
    public Id<Person> getId() {
        return this.id;
    }

    /* deliberately package */ void changeId(final Id<Person> newId) {
        // This is deliberately non-public and not on the interface, since the ID should not be changed after the
        // person is inserted into the population map (since the ID is the map key).
        // However, there are some situations where changing the ID makes sense while the person is outside
        // the population ...  kai, jun'16
        try {
            testForLocked() ;
        } catch ( Exception ee ) {
            LogManager.getLogger(getClass()).warn("cannot change oerson id while in population.  remove the person, change Id, re-add.");
            throw ee ;
        }
        this.id = newId;
    }

    @Override
    public final String toString() {
        StringBuilder b = new StringBuilder();
        b.append("[id=").append(this.getId()).append("]");
        b.append("[nof_plans=").append(this.getPlans() == null ? "null" : this.getPlans().size()).append("]");
        return b.toString();
    }

    @Override
    public boolean removePlan(final Plan plan) {
        boolean result = this.getPlans().remove(plan);
        if ((this.getSelectedPlan() == plan) && result) {
            this.setSelectedPlan(new RandomPlanSelector<Plan, Person>().selectPlan(this));
        }
        return result;
    }

    @Override
    public List<Plan> getPlans() {
        return this.plans;
    }


    @Override
    public Map<String, Object> getCustomAttributes() {
        if (this.customizableDelegate == null) {
            this.customizableDelegate = CustomizableUtils.createCustomizable();
        }
        return this.customizableDelegate.getCustomAttributes();
    }

    @Override
    public Attributes getAttributes() {
        return attributes;
    }

    @Override
    public final void setLocked() {
        this.locked = true ;
        // we are not locking anything in the plans
    }

    private void testForLocked() {
        if ( this.locked ) {
            throw new RuntimeException("too late to do this") ;
        }
    }


}