org.optaplanner.examples.scrabble.domain.solver.CellUpdatingVariableListener 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.
There is a newer version: 9.44.0.Final
Show newest version
/*
 * Copyright 2016 Red Hat, Inc. and/or its affiliates.
 *
 * 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.optaplanner.examples.scrabble.domain.solver;

import org.optaplanner.core.impl.domain.variable.listener.VariableListener;
import org.optaplanner.core.impl.score.director.ScoreDirector;
import org.optaplanner.examples.scrabble.domain.ScrabbleCell;
import org.optaplanner.examples.scrabble.domain.ScrabbleSolution;
import org.optaplanner.examples.scrabble.domain.ScrabbleWordAssignment;
import org.optaplanner.examples.scrabble.domain.ScrabbleWordDirection;

public class CellUpdatingVariableListener implements VariableListener {

    @Override
    public boolean requiresUniqueEntityEvents() {
        return true;
    }

    @Override
    public void beforeEntityAdded(ScoreDirector scoreDirector, ScrabbleWordAssignment wordAssignment) {
        // Do nothing
    }

    @Override
    public void afterEntityAdded(ScoreDirector scoreDirector, ScrabbleWordAssignment wordAssignment) {
        insertWord(scoreDirector, wordAssignment);
    }

    @Override
    public void beforeVariableChanged(ScoreDirector scoreDirector, ScrabbleWordAssignment wordAssignment) {
        retractWord(scoreDirector, wordAssignment);
    }

    @Override
    public void afterVariableChanged(ScoreDirector scoreDirector, ScrabbleWordAssignment wordAssignment) {
        insertWord(scoreDirector, wordAssignment);
    }

    @Override
    public void beforeEntityRemoved(ScoreDirector scoreDirector, ScrabbleWordAssignment wordAssignment) {
        retractWord(scoreDirector, wordAssignment);
    }

    @Override
    public void afterEntityRemoved(ScoreDirector scoreDirector, ScrabbleWordAssignment wordAssignment) {
        // Do nothing
    }

    private void insertWord(ScoreDirector scoreDirector, ScrabbleWordAssignment wordAssignment) {
        ScrabbleSolution solution = (ScrabbleSolution) scoreDirector.getWorkingSolution();
        ScrabbleCell startCell = wordAssignment.getStartCell();
        ScrabbleWordDirection direction = wordAssignment.getDirection();
        if (startCell != null && direction != null) {
            int x = startCell.getX();
            int y = startCell.getY();
            String word = wordAssignment.getWord();
            for (int i = 0; i < word.length(); i++) {
                ScrabbleCell cell = solution.getCell(x, y);
                scoreDirector.beforeVariableChanged(cell, "wordSet");
                scoreDirector.beforeVariableChanged(cell, "characterCountMap");
                solution.getCell(x, y).insertWordAssignment(wordAssignment, word.charAt(i));
                scoreDirector.afterVariableChanged(cell, "wordSet");
                scoreDirector.afterVariableChanged(cell, "characterCountMap");
                switch (direction) {
                    case HORIZONTAL:
                        x++;
                        break;
                    case VERTICAL:
                        y++;
                        break;
                    default:
                        throw new IllegalStateException("The direction (" + direction + ") is not implemented.");

                }
                if (x >= solution.getGridWidth() || y >= solution.getGridHeight()) {
                    break;
                }
            }
        }
    }

    private void retractWord(ScoreDirector scoreDirector, ScrabbleWordAssignment wordAssignment) {
        ScrabbleSolution solution = (ScrabbleSolution) scoreDirector.getWorkingSolution();
        ScrabbleCell startCell = wordAssignment.getStartCell();
        ScrabbleWordDirection direction = wordAssignment.getDirection();
        if (startCell != null && direction != null) {
            int x = startCell.getX();
            int y = startCell.getY();
            String word = wordAssignment.getWord();
            for (int i = 0; i < word.length(); i++) {
                ScrabbleCell cell = solution.getCell(x, y);
                scoreDirector.beforeVariableChanged(cell, "wordSet");
                scoreDirector.beforeVariableChanged(cell, "characterCountMap");
                cell.retractWordAssignment(wordAssignment, word.charAt(i));
                scoreDirector.afterVariableChanged(cell, "wordSet");
                scoreDirector.afterVariableChanged(cell, "characterCountMap");
                switch (direction) {
                    case HORIZONTAL:
                        x++;
                        break;
                    case VERTICAL:
                        y++;
                        break;
                    default:
                        throw new IllegalStateException("The direction (" + direction + ") is not implemented.");

                }
                if (x >= solution.getGridWidth() || y >= solution.getGridHeight()) {
                    break;
                }
            }
        }

    }

}