StrategyManagerModule.java

Go to the documentation of this file.

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

import com.google.inject.Key;
import com.google.inject.Singleton;
import com.google.inject.TypeLiteral;
import com.google.inject.multibindings.MapBinder;
import com.google.inject.name.Names;
import jakarta.inject.Provider;
import org.matsim.api.core.v01.population.Person;
import org.matsim.api.core.v01.population.Plan;
import org.matsim.core.config.groups.ReplanningConfigGroup;
import org.matsim.core.controler.AbstractModule;
import org.matsim.core.replanning.choosers.StrategyChooser;
import org.matsim.core.replanning.choosers.WeightedStrategyChooser;
import org.matsim.core.replanning.conflicts.ConflictModule;
import org.matsim.core.replanning.strategies.DefaultPlanStrategiesModule;

public class StrategyManagerModule extends AbstractModule {
    @Override
    public void install() {
        install(new DefaultPlanStrategiesModule());
        // (does commands of type "bind(PlanStrategy.class).annotatedWith(Names.named(strategyName))", i.e.
        // plan strategies can be looked up under their names (*))

        bind(StrategyManager.class).in(Singleton.class);
        bind(new TypeLiteral<StrategyChooser<Plan, Person>>() {}).to(new TypeLiteral<WeightedStrategyChooser<Plan, Person>>() {}).asEagerSingleton();
        bind(ReplanningContext.class).to(ReplanningContextImpl.class).asEagerSingleton();

        MapBinder<ReplanningConfigGroup.StrategySettings, PlanStrategy> planStrategyMapBinder = MapBinder.newMapBinder(binder(), ReplanningConfigGroup.StrategySettings.class, PlanStrategy.class);
        // (this will bind a Map that has StrategySettings as key, and PlanStrategy as value.  Not sure why StrategySettings as key, and not just the name, but possibly this is mean to allow adding
        // the same strategy multiple times, with possibly different settings.)

        for (ReplanningConfigGroup.StrategySettings settings : getConfig().replanning().getStrategySettings()) {
            String name = settings.getStrategyName() ;
            if (name.contains(".")) {
                // plan strategy is in Java, but it is found via the class loader:
                if (name.startsWith("org.matsim.core")
                            // && !name.startsWith("org.matsim.contrib.")
                ) {
                    // org.matsim.core strategies are not to be loaded via the class loader:
                    throw new RuntimeException("Strategies in the org.matsim.core package must not be loaded by name!");
                } else {
                    try {
                        Class klass = Class.forName(name);
                        if (PlanStrategy.class.isAssignableFrom(klass)) {
                            planStrategyMapBinder.addBinding(settings).to(klass);
                        } else if (Provider.class.isAssignableFrom(klass)) {
                            planStrategyMapBinder.addBinding(settings).toProvider(klass);
                        } else {
                            throw new RuntimeException("You specified a class name as a strategy, but it is neither a PlanStrategy nor a Provider.");
                        }
                    } catch (ClassNotFoundException e) {
                        throw new RuntimeException("You specified something which looks like a class name as a strategy, but the class could not be found.", e);
                    }
                }
            } else {
                // this is the normal case: plan strategy comes from within matsim
                planStrategyMapBinder.addBinding(settings).to(Key.get(PlanStrategy.class, Names.named(settings.getStrategyName())));
                // (settings is the key ... ok.  The Key.get(...) returns the PlanStrategy that was registered under its name at (*) above.)
            }
        }

        install(new ConflictModule());
    }
}