/*
* 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
*
* hhttp://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.phase;
import java.util.List;
import java.util.Random;
import org.drools.planner.core.domain.solution.SolutionDescriptor;
import org.drools.planner.core.move.Move;
import org.drools.planner.core.phase.step.AbstractStepScope;
import org.drools.planner.core.score.Score;
import org.drools.planner.core.score.definition.ScoreDefinition;
import org.drools.planner.core.score.director.ScoreDirector;
import org.drools.planner.core.solution.Solution;
import org.drools.planner.core.solver.scope.DefaultSolverScope;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public abstract class AbstractSolverPhaseScope {
protected final transient Logger logger = LoggerFactory.getLogger(getClass());
protected DefaultSolverScope solverScope;
protected long startingSystemTimeMillis;
protected Score startingScore;
protected int bestSolutionStepIndex;
public AbstractSolverPhaseScope(DefaultSolverScope solverScope) {
this.solverScope = solverScope;
}
public DefaultSolverScope getSolverScope() {
return solverScope;
}
public long getStartingSystemTimeMillis() {
return startingSystemTimeMillis;
}
public Score getStartingScore() {
return startingScore;
}
public void setStartingScore(Score startingScore) {
this.startingScore = startingScore;
}
public int getBestSolutionStepIndex() {
return bestSolutionStepIndex;
}
public void setBestSolutionStepIndex(int bestSolutionStepIndex) {
this.bestSolutionStepIndex = bestSolutionStepIndex;
}
public abstract AbstractStepScope getLastCompletedStepScope();
// ************************************************************************
// Calculated methods
// ************************************************************************
public void reset() {
startingSystemTimeMillis = System.currentTimeMillis();
bestSolutionStepIndex = -1;
// TODO Usage of solverScope.getBestScore() would be better performance wise but is null with a uninitialized score
startingScore = solverScope.calculateScore();
}
public SolutionDescriptor getSolutionDescriptor() {
return solverScope.getSolutionDescriptor();
}
public ScoreDefinition getScoreDefinition() {
return solverScope.getScoreDefinition();
}
public long calculateSolverTimeMillisSpend() {
return solverScope.calculateTimeMillisSpend();
}
public long calculatePhaseTimeMillisSpend() {
long now = System.currentTimeMillis();
return now - startingSystemTimeMillis;
}
public ScoreDirector getScoreDirector() {
return solverScope.getScoreDirector();
}
public Solution getWorkingSolution() {
return solverScope.getWorkingSolution();
}
public List<Object> getWorkingPlanningEntityList() {
return solverScope.getWorkingPlanningEntityList();
}
public boolean isWorkingSolutionInitialized() {
return solverScope.isWorkingSolutionInitialized();
}
public Score calculateScore() {
return solverScope.calculateScore();
}
public void assertWorkingScore(Score workingScore) {
solverScope.assertWorkingScore(workingScore);
}
public Random getWorkingRandom() {
return solverScope.getWorkingRandom();
}
public Score getBestScore() {
return solverScope.getBestScore();
}
public void assertUndoMoveIsUncorrupted(Move move, Move undoMove) {
Score undoScore = calculateScore();
Score lastCompletedStepScore = getLastCompletedStepScope().getScore();
if (!undoScore.equals(lastCompletedStepScore)) {
// First assert that are probably no corrupted score rules.
getScoreDirector().assertWorkingScore(undoScore);
throw new IllegalStateException(
"The moveClass (" + move.getClass() + ")'s move (" + move
+ ") probably has a corrupted undoMove (" + undoMove + ")." +
" Or maybe there are corrupted score rules.\n"
+ "Check the Move.createUndoMove(...) method of that Move class" +
" and enable EnvironmentMode TRACE to fail-faster on corrupted score rules.\n"
+ "Score corruption: the lastCompletedStepScore (" + lastCompletedStepScore
+ ") is not the undoScore (" + undoScore + ").");
}
}
@Override
public String toString() {
return getClass().getSimpleName(); // TODO add + "(" + phaseIndex + ")"
}
}