org.optaplanner.examples.common.app.CommonBenchmarkApp Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of optaplanner-examples Show documentation

OptaPlanner solves planning problems. This lightweight, embeddable planning engine implements powerful and scalable algorithms to optimize business resource scheduling and planning. This module contains the examples which demonstrate how to use it in a normal Java application.

The newest version!

package org.optaplanner.examples.common.app;

import java.util.Arrays;
import java.util.Collection;
import java.util.LinkedHashMap;
import java.util.Map;

import org.optaplanner.benchmark.api.PlannerBenchmark;
import org.optaplanner.benchmark.api.PlannerBenchmarkFactory;
import org.optaplanner.benchmark.impl.aggregator.swingui.BenchmarkAggregatorFrame;

public abstract class CommonBenchmarkApp extends LoggingMain {

    public static final String AGGREGATOR_ARG = "--aggregator";

    private final Map benchmarkArgumentMap;

    public CommonBenchmarkApp(ArgOption... argOptions) {
        benchmarkArgumentMap = new LinkedHashMap<>(argOptions.length);
        for (ArgOption argOption : argOptions) {
            benchmarkArgumentMap.put(argOption.getName(), argOption);
        }
    }

    public Collection getArgOptions() {
        return benchmarkArgumentMap.values();
    }

    public void buildAndBenchmark(String[] args) {
        // Parse arguments
        boolean aggregator = false;
        ArgOption argOption = null;
        for (String arg : args) {
            if (arg.equalsIgnoreCase(AGGREGATOR_ARG)) {
                aggregator = true;
            } else if (benchmarkArgumentMap.containsKey(arg)) {
                if (argOption != null) {
                    throw new IllegalArgumentException("The args (" + Arrays.toString(args)
                            + ") contains arg name (" + argOption.getName() + ") and arg name (" + arg + ").");
                }
                argOption = benchmarkArgumentMap.get(arg);
            } else {
                throw new IllegalArgumentException("The args (" + Arrays.toString(args)
                        + ") contains an arg (" + arg + ") which is not part of the recognized args ("
                        + benchmarkArgumentMap.keySet() + " or " + AGGREGATOR_ARG + ").");
            }
        }
        if (argOption == null) {
            argOption = benchmarkArgumentMap.values().iterator().next();
        }
        boolean template = argOption.isTemplate();
        String benchmarkConfigResource = argOption.getBenchmarkConfigResource();

        // Execute the benchmark or aggregation
        if (!aggregator) {
            PlannerBenchmarkFactory benchmarkFactory;
            if (!template) {
                benchmarkFactory = PlannerBenchmarkFactory.createFromXmlResource(benchmarkConfigResource);
            } else {
                benchmarkFactory = PlannerBenchmarkFactory.createFromFreemarkerXmlResource(benchmarkConfigResource);
            }
            PlannerBenchmark benchmark = benchmarkFactory.buildPlannerBenchmark();
            benchmark.benchmarkAndShowReportInBrowser();
        } else {
            if (!template) {
                BenchmarkAggregatorFrame.createAndDisplayFromXmlResource(benchmarkConfigResource);
            } else {
                BenchmarkAggregatorFrame.createAndDisplayFromFreemarkerXmlResource(benchmarkConfigResource);
            }
        }
    }

    public static class ArgOption {

        private String name;
        private String benchmarkConfigResource;
        private boolean template;

        public ArgOption(String name, String benchmarkConfigResource) {
            this(name, benchmarkConfigResource, false);
        }

        public ArgOption(String name, String benchmarkConfigResource, boolean template) {
            this.name = name;
            this.benchmarkConfigResource = benchmarkConfigResource;
            this.template = template;
        }

        public String getName() {
            return name;
        }

        public String getBenchmarkConfigResource() {
            return benchmarkConfigResource;
        }

        public boolean isTemplate() {
            return template;
        }

        @Override
        public String toString() {
            return name + " (" + benchmarkConfigResource + ")";
        }

    }

}