All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.drools.planner.core.domain.variable.PlanningValueSorter Maven / Gradle / Ivy

Go to download

Drools Planner optimizes automated planning by combining metaheuristic search algorithms with rule engine powered score calculation. This is the drools-planner-core module which contains metaheuristic algorithms.

There is a newer version: 6.0.0.Alpha9
Show newest version
/*
 * Copyright 2011 JBoss Inc
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.drools.planner.core.domain.variable;

import java.util.Collections;
import java.util.Comparator;
import java.util.List;
import java.util.SortedMap;
import java.util.TreeMap;

import org.drools.planner.api.domain.variable.PlanningValueStrengthWeightFactory;
import org.drools.planner.core.solution.Solution;

/**
 * Helper class for {@link PlanningValueStrengthWeightFactory}.
 * @see PlanningValueStrengthWeightFactory
 */
public class PlanningValueSorter {

    // TODO also keep PlanningEntityDescriptor and the valueRange descriptor?

    private Comparator strengthComparator = null;
    private PlanningValueStrengthWeightFactory strengthWeightFactory = null;

    public PlanningValueSorter() {
    }

    public void setStrengthComparator(Comparator strengthComparator) {
        this.strengthComparator = strengthComparator;
    }

    public void setStrengthWeightFactory(PlanningValueStrengthWeightFactory strengthWeightFactory) {
        this.strengthWeightFactory = strengthWeightFactory;
    }

    public boolean isSortStrengthSupported() {
        return strengthComparator != null || strengthWeightFactory != null;
    }

    public void sortStrengthAscending(Solution solution, List planningValueList) {
        if (strengthComparator != null) {
            Collections.sort(planningValueList, strengthComparator);
        } else if (strengthWeightFactory != null) {
            SortedMap planningValueMap = new TreeMap();
            for (Object planningValue : planningValueList) {
                Comparable strengthWeight = strengthWeightFactory.createStrengthWeight(solution, planningValue);
                Object previous = planningValueMap.put(strengthWeight, planningValue);
                if (previous != null) {
                    throw new IllegalStateException("The planningValueList contains 2 times the same planningValue ("
                            + previous + ") and (" + planningValue + ").");
                }
            }
            planningValueList.clear();
            planningValueList.addAll(planningValueMap.values());
        } else {
            throw new IllegalStateException("Sorting on strength is impossible" +
                    " because strengthComparator and strengthWeightFactory are null.");
        }
    }

    public void sortStrengthDescending(Solution solution, List planningEntityList) {
        sortStrengthAscending(solution, planningEntityList);
        Collections.reverse(planningEntityList);
    }

}