org.optaplanner.examples.common.persistence.AbstractXlsxSolutionFileIO Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of optaplanner-examples Show documentation
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.
package org.optaplanner.examples.common.persistence;
import static org.optaplanner.examples.common.persistence.XSSFColorUtil.getXSSFColor;
import java.time.format.DateTimeFormatter;
import java.util.Arrays;
import java.util.Collection;
import java.util.Comparator;
import java.util.Iterator;
import java.util.Locale;
import java.util.Map;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.function.Supplier;
import java.util.regex.Pattern;
import org.apache.poi.ss.usermodel.Cell;
import org.apache.poi.ss.usermodel.CellType;
import org.apache.poi.ss.usermodel.CreationHelper;
import org.apache.poi.ss.usermodel.Drawing;
import org.apache.poi.ss.usermodel.FillPatternType;
import org.apache.poi.ss.usermodel.Font;
import org.apache.poi.ss.usermodel.HorizontalAlignment;
import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.ss.usermodel.VerticalAlignment;
import org.apache.poi.ss.usermodel.Workbook;
import org.apache.poi.ss.util.CellReference;
import org.apache.poi.xssf.usermodel.XSSFCell;
import org.apache.poi.xssf.usermodel.XSSFCellStyle;
import org.apache.poi.xssf.usermodel.XSSFColor;
import org.apache.poi.xssf.usermodel.XSSFRow;
import org.apache.poi.xssf.usermodel.XSSFSheet;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;
import org.optaplanner.core.api.score.Score;
import org.optaplanner.core.api.score.ScoreExplanation;
import org.optaplanner.core.api.score.constraint.ConstraintMatch;
import org.optaplanner.core.api.score.constraint.ConstraintMatchTotal;
import org.optaplanner.core.api.score.constraint.Indictment;
import org.optaplanner.core.api.solver.SolutionManager;
import org.optaplanner.core.api.solver.SolverFactory;
import org.optaplanner.core.impl.score.definition.ScoreDefinition;
import org.optaplanner.core.impl.score.director.InnerScoreDirectorFactory;
import org.optaplanner.core.impl.score.director.ScoreDirectorFactory;
import org.optaplanner.core.impl.solver.DefaultSolverFactory;
import org.optaplanner.persistence.common.api.domain.solution.SolutionFileIO;
import org.optaplanner.swing.impl.TangoColorFactory;
public abstract class AbstractXlsxSolutionFileIO implements SolutionFileIO {
public static final DateTimeFormatter DAY_FORMATTER = DateTimeFormatter.ofPattern("E yyyy-MM-dd", Locale.ENGLISH);
public static final DateTimeFormatter MONTH_FORMATTER = DateTimeFormatter.ofPattern("MMM yyyy", Locale.ENGLISH);
public static final DateTimeFormatter TIME_FORMATTER = DateTimeFormatter.ofPattern("HH:mm", Locale.ENGLISH);
public static final DateTimeFormatter DATE_TIME_FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm", Locale.ENGLISH);
protected static final Pattern VALID_TAG_PATTERN = Pattern
.compile("(?U)^[\\w&\\-\\.\\/\\(\\)\\'][\\w&\\-\\.\\/\\(\\)\\' ]*[\\w&\\-\\.\\/\\(\\)\\']?$");
protected static final Pattern VALID_NAME_PATTERN = AbstractXlsxSolutionFileIO.VALID_TAG_PATTERN;
protected static final Pattern VALID_CODE_PATTERN = Pattern.compile("(?U)^[\\w\\-\\.\\/\\(\\)]+$");
protected static final XSSFColor VIEW_TAB_COLOR = getXSSFColor(TangoColorFactory.BUTTER_1);
protected static final XSSFColor DISABLED_COLOR = getXSSFColor(TangoColorFactory.ALUMINIUM_3);
protected static final XSSFColor UNAVAILABLE_COLOR = getXSSFColor(TangoColorFactory.ALUMINIUM_5);
protected static final XSSFColor PINNED_COLOR = getXSSFColor(TangoColorFactory.PLUM_1);
protected static final XSSFColor HARD_PENALTY_COLOR = getXSSFColor(TangoColorFactory.SCARLET_1);
protected static final XSSFColor MEDIUM_PENALTY_COLOR = getXSSFColor(TangoColorFactory.SCARLET_3);
protected static final XSSFColor SOFT_PENALTY_COLOR = getXSSFColor(TangoColorFactory.ORANGE_1);
protected static final XSSFColor PLANNING_VARIABLE_COLOR = getXSSFColor(TangoColorFactory.BUTTER_1);
protected static final XSSFColor REPUBLISHED_COLOR = getXSSFColor(TangoColorFactory.MAGENTA);
@Override
public String getInputFileExtension() {
return "xlsx";
}
public static abstract class AbstractXlsxReader> {
protected final XSSFWorkbook workbook;
protected final ScoreDefinition scoreDefinition;
protected Solution_ solution;
protected XSSFSheet currentSheet;
protected Iterator currentRowIterator;
protected XSSFRow currentRow;
protected int currentRowNumber;
protected int currentColumnNumber;
public AbstractXlsxReader(XSSFWorkbook workbook, String solverConfigResource) {
this.workbook = workbook;
SolverFactory solverFactory = SolverFactory.createFromXmlResource(solverConfigResource);
ScoreDirectorFactory scoreDirectorFactory =
((DefaultSolverFactory) solverFactory).getScoreDirectorFactory();
scoreDefinition = ((InnerScoreDirectorFactory) scoreDirectorFactory).getScoreDefinition();
}
public abstract Solution_ read();
protected void readIntConstraintParameterLine(String name, Consumer consumer, String constraintDescription) {
nextRow();
readHeaderCell(name);
XSSFCell weightCell = nextCell();
if (consumer != null) {
if (weightCell.getCellType() != CellType.NUMERIC) {
throw new IllegalArgumentException(currentPosition() + ": The value ("
+ weightCell.getStringCellValue()
+ ") for constraint (" + name + ") must be a number and the cell type must be numeric.");
}
double value = weightCell.getNumericCellValue();
if (((int) value) != value) {
throw new IllegalArgumentException(currentPosition() + ": The value (" + value
+ ") for constraint (" + name + ") must be an integer.");
}
consumer.accept((int) value);
} else {
if (weightCell.getCellType() == CellType.NUMERIC
|| !weightCell.getStringCellValue().equals("n/a")) {
throw new IllegalArgumentException(currentPosition() + ": The value ("
+ weightCell.getStringCellValue()
+ ") for constraint (" + name + ") must be an n/a.");
}
}
readHeaderCell(constraintDescription);
}
protected void readLongConstraintParameterLine(String name, Consumer consumer, String constraintDescription) {
nextRow();
readHeaderCell(name);
XSSFCell weightCell = nextCell();
if (consumer != null) {
if (weightCell.getCellType() != CellType.NUMERIC) {
throw new IllegalArgumentException(currentPosition() + ": The value ("
+ weightCell.getStringCellValue()
+ ") for constraint (" + name + ") must be a number and the cell type must be numeric.");
}
double value = weightCell.getNumericCellValue();
if (((long) value) != value) {
throw new IllegalArgumentException(currentPosition() + ": The value (" + value
+ ") for constraint (" + name + ") must be a (long) integer.");
}
consumer.accept((long) value);
} else {
if (weightCell.getCellType() == CellType.NUMERIC
|| !weightCell.getStringCellValue().equals("n/a")) {
throw new IllegalArgumentException(currentPosition() + ": The value ("
+ weightCell.getStringCellValue()
+ ") for constraint (" + name + ") must be an n/a.");
}
}
readHeaderCell(constraintDescription);
}
protected void readScoreConstraintHeaders() {
nextRow(true);
readHeaderCell("Constraint");
readHeaderCell("Score weight");
readHeaderCell("Description");
}
protected Score_ readScoreConstraintLine(String constraintName, String constraintDescription) {
nextRow();
readHeaderCell(constraintName);
String scoreString = nextStringCell().getStringCellValue();
readHeaderCell(constraintDescription);
return scoreDefinition.parseScore(scoreString);
}
protected String currentPosition() {
return "Sheet (" + currentSheet.getSheetName() + ") cell ("
+ (currentRowNumber + 1) + CellReference.convertNumToColString(currentColumnNumber) + ")";
}
protected boolean hasSheet(String sheetName) {
return workbook.getSheet(sheetName) != null;
}
protected void nextSheet(String sheetName) {
currentSheet = workbook.getSheet(sheetName);
if (currentSheet == null) {
throw new IllegalStateException("The workbook does not contain a sheet with name ("
+ sheetName + ").");
}
currentRowIterator = currentSheet.rowIterator();
if (currentRowIterator == null) {
throw new IllegalStateException(currentPosition() + ": The sheet has no rows.");
}
currentRowNumber = -1;
}
protected boolean nextRow() {
return nextRow(true);
}
protected boolean nextRow(boolean skipEmptyRows) {
currentRowNumber++;
currentColumnNumber = -1;
if (!currentRowIterator.hasNext()) {
currentRow = null;
return false;
}
currentRow = (XSSFRow) currentRowIterator.next();
while (skipEmptyRows && currentRowIsEmpty()) {
if (!currentRowIterator.hasNext()) {
currentRow = null;
return false;
}
currentRow = (XSSFRow) currentRowIterator.next();
}
if (currentRow.getRowNum() != currentRowNumber) {
if (currentRow.getRowNum() == currentRowNumber + 1) {
currentRowNumber++;
} else {
throw new IllegalStateException(currentPosition() + ": The next row (" + currentRow.getRowNum()
+ ") has a gap of more than 1 empty line with the previous.");
}
}
return true;
}
protected boolean currentRowIsEmpty() {
if (currentRow.getPhysicalNumberOfCells() == 0) {
return true;
}
for (Cell cell : currentRow) {
if (cell.getCellType() == CellType.STRING) {
if (!cell.getStringCellValue().isEmpty()) {
return false;
}
} else if (cell.getCellType() != CellType.BLANK) {
return false;
}
}
return true;
}
protected void readHeaderCell(String value) {
XSSFCell cell = currentRow == null ? null : nextStringCell();
if (cell == null || !cell.getStringCellValue().equals(value)) {
throw new IllegalStateException(currentPosition() + ": The cell ("
+ (cell == null ? null : cell.getStringCellValue())
+ ") does not contain the expected value (" + value + ").");
}
}
protected void readHeaderCell(double value) {
XSSFCell cell = currentRow == null ? null : nextNumericCell();
if (cell == null || cell.getNumericCellValue() != value) {
throw new IllegalStateException(currentPosition() + ": The cell does not contain the expected value ("
+ value + ").");
}
}
protected XSSFCell nextStringCell() {
XSSFCell cell = nextCell();
if (cell.getCellType() == CellType.NUMERIC) {
throw new IllegalStateException(currentPosition() + ": The cell with value ("
+ cell.getNumericCellValue() + ") has a numeric type but should be a string.");
}
return cell;
}
protected XSSFCell nextNumericCell() {
XSSFCell cell = nextCell();
if (cell.getCellType() == CellType.STRING) {
throw new IllegalStateException(currentPosition() + ": The cell with value ("
+ cell.getStringCellValue() + ") has a string type but should be numeric.");
}
return cell;
}
protected XSSFCell nextNumericCellOrBlank() {
XSSFCell cell = nextCell();
if (cell.getCellType() == CellType.BLANK
|| (cell.getCellType() == CellType.STRING && cell.getStringCellValue().isEmpty())) {
return null;
}
if (cell.getCellType() == CellType.STRING) {
throw new IllegalStateException(currentPosition() + ": The cell with value ("
+ cell.getStringCellValue() + ") has a string type but should be numeric.");
}
return cell;
}
protected XSSFCell nextBooleanCell() {
XSSFCell cell = nextCell();
if (cell.getCellType() == CellType.STRING) {
throw new IllegalStateException(currentPosition() + ": The cell with value ("
+ cell.getStringCellValue() + ") has a string type but should be boolean.");
}
if (cell.getCellType() == CellType.NUMERIC) {
throw new IllegalStateException(currentPosition() + ": The cell with value ("
+ cell.getNumericCellValue() + ") has a numeric type but should be a boolean.");
}
return cell;
}
protected XSSFCell nextCell() {
currentColumnNumber++;
XSSFCell cell = currentRow.getCell(currentColumnNumber);
// TODO HACK to workaround the fact that LibreOffice and Excel automatically remove empty trailing cells
if (cell == null) {
// Return dummy cell
return currentRow.createCell(currentColumnNumber);
}
return cell;
}
protected XSSFColor extractColor(XSSFCell cell, XSSFColor... acceptableColors) {
XSSFCellStyle cellStyle = cell.getCellStyle();
FillPatternType fillPattern = cellStyle.getFillPattern();
if (fillPattern == null || fillPattern == FillPatternType.NO_FILL) {
return null;
}
if (fillPattern != FillPatternType.SOLID_FOREGROUND) {
throw new IllegalStateException(currentPosition() + ": The fill pattern (" + fillPattern
+ ") should be either " + FillPatternType.NO_FILL
+ " or " + FillPatternType.SOLID_FOREGROUND + ".");
}
XSSFColor color = cellStyle.getFillForegroundColorColor();
for (XSSFColor acceptableColor : acceptableColors) {
if (acceptableColor.equals(color)) {
return acceptableColor;
}
}
throw new IllegalStateException(currentPosition() + ": The fill color (" + color
+ ") is not one of the acceptableColors (" + Arrays.toString(acceptableColors) + ").");
}
}
public static abstract class AbstractXlsxWriter> {
protected final Solution_ solution;
protected final Score_ score;
protected final Map> constraintMatchTotalsMap;
protected final Map> indictmentMap;
protected XSSFWorkbook workbook;
protected CreationHelper creationHelper;
protected XSSFCellStyle headerStyle;
protected XSSFCellStyle defaultStyle;
protected XSSFCellStyle scoreStyle;
protected XSSFCellStyle disabledScoreStyle;
protected XSSFCellStyle unavailableStyle;
protected XSSFCellStyle pinnedStyle;
protected XSSFCellStyle hardPenaltyStyle;
protected XSSFCellStyle mediumPenaltyStyle;
protected XSSFCellStyle softPenaltyStyle;
protected XSSFCellStyle wrappedStyle;
protected XSSFCellStyle planningVariableStyle;
protected XSSFCellStyle republishedStyle;
protected XSSFSheet currentSheet;
protected Drawing currentDrawing;
protected XSSFRow currentRow;
protected int currentRowNumber;
protected int currentColumnNumber;
protected int headerCellCount;
public AbstractXlsxWriter(Solution_ solution, String solverConfigResource) {
this.solution = solution;
SolverFactory solverFactory = SolverFactory.createFromXmlResource(solverConfigResource);
SolutionManager solutionManager = SolutionManager.create(solverFactory);
ScoreExplanation scoreExplanation = solutionManager.explain(solution);
score = scoreExplanation.getScore();
constraintMatchTotalsMap = scoreExplanation.getConstraintMatchTotalMap();
indictmentMap = scoreExplanation.getIndictmentMap();
}
public abstract Workbook write();
public void writeSetup() {
workbook = new XSSFWorkbook();
creationHelper = workbook.getCreationHelper();
createStyles();
}
protected void createStyles() {
headerStyle = createStyle(null);
Font headerFont = workbook.createFont();
headerFont.setBold(true);
headerStyle.setFont(headerFont);
defaultStyle = createStyle(null);
scoreStyle = createStyle(null);
scoreStyle.setAlignment(HorizontalAlignment.RIGHT);
disabledScoreStyle = createStyle(DISABLED_COLOR);
disabledScoreStyle.setAlignment(HorizontalAlignment.RIGHT);
unavailableStyle = createStyle(UNAVAILABLE_COLOR);
pinnedStyle = createStyle(PINNED_COLOR);
hardPenaltyStyle = createStyle(HARD_PENALTY_COLOR);
mediumPenaltyStyle = createStyle(MEDIUM_PENALTY_COLOR);
softPenaltyStyle = createStyle(SOFT_PENALTY_COLOR);
wrappedStyle = createStyle(null);
planningVariableStyle = createStyle(PLANNING_VARIABLE_COLOR);
republishedStyle = createStyle(REPUBLISHED_COLOR);
}
protected XSSFCellStyle createStyle(XSSFColor color) {
XSSFCellStyle style = workbook.createCellStyle();
if (color != null) {
style.setFillPattern(FillPatternType.SOLID_FOREGROUND);
style.setFillForegroundColor(color);
}
style.setWrapText(true);
style.setVerticalAlignment(VerticalAlignment.CENTER);
return style;
}
protected void writeIntConstraintParameterLine(String name, int value, String constraintDescription) {
nextRow();
nextHeaderCell(name);
XSSFCell weightCell = nextCell();
weightCell.setCellValue(value);
nextHeaderCell(constraintDescription);
}
protected void writeIntConstraintParameterLine(String name, Supplier supplier, String constraintDescription) {
nextRow();
nextHeaderCell(name);
XSSFCell weightCell = nextCell();
if (supplier != null) {
weightCell.setCellValue(supplier.get());
} else {
weightCell.setCellValue("n/a");
}
nextHeaderCell(constraintDescription);
}
protected void writeLongConstraintParameterLine(String name, Supplier supplier, String constraintDescription) {
nextRow();
nextHeaderCell(name);
XSSFCell weightCell = nextCell();
if (supplier != null) {
weightCell.setCellValue(supplier.get());
} else {
weightCell.setCellValue("n/a");
}
nextHeaderCell(constraintDescription);
}
protected void writeScoreConstraintHeaders() {
nextRow();
nextHeaderCell("Constraint");
nextHeaderCell("Score weight");
nextHeaderCell("Description");
}
protected void writeScoreConstraintLine(String constraintName, Score_ constraintScore,
String constraintDescription) {
nextRow();
nextHeaderCell(constraintName);
nextCell(constraintScore.isZero() ? disabledScoreStyle : scoreStyle)
.setCellValue(constraintScore.toString());
nextHeaderCell(constraintDescription);
}
protected void writeScoreView(Function, String> indictmentListFormatter) {
nextSheet("Score view", 1, 3, true);
nextRow();
nextHeaderCell("Score");
nextCell().setCellValue(score.toShortString());
nextRow();
nextRow();
nextHeaderCell("Constraint name");
nextHeaderCell("Constraint weight");
nextHeaderCell("Match count");
nextHeaderCell("Score");
nextHeaderCell("");
nextHeaderCell("Match score");
nextHeaderCell("Justifications");
if (!score.isSolutionInitialized()) {
nextRow();
nextHeaderCell("Unassigned variables");
nextCell();
nextCell();
nextCell().setCellValue(score.initScore());
}
Comparator> constraintWeightComparator = Comparator.comparing(
ConstraintMatchTotal::getConstraintWeight, Comparator.nullsLast(Comparator.reverseOrder()));
constraintMatchTotalsMap.values().stream()
.sorted(constraintWeightComparator
.thenComparing(ConstraintMatchTotal::getConstraintPackage)
.thenComparing(ConstraintMatchTotal::getConstraintName))
.forEach(constraintMatchTotal -> {
nextRow();
nextHeaderCell(constraintMatchTotal.getConstraintName());
Score_ constraintWeight = constraintMatchTotal.getConstraintWeight();
nextCell(scoreStyle).setCellValue(constraintWeight == null ? "N/A" : constraintWeight.toShortString());
nextCell().setCellValue(constraintMatchTotal.getConstraintMatchSet().size());
nextCell(scoreStyle).setCellValue(constraintMatchTotal.getScore().toShortString());
});
nextRow();
nextRow();
Comparator> constraintMatchTotalComparator = Comparator
.comparing(ConstraintMatchTotal::getScore);
constraintMatchTotalComparator = constraintMatchTotalComparator
.thenComparing(ConstraintMatchTotal::getConstraintPackage)
.thenComparing(ConstraintMatchTotal::getConstraintName);
Comparator> constraintMatchComparator = Comparator
.comparing(ConstraintMatch::getScore);
constraintMatchTotalsMap.values().stream()
.sorted(constraintMatchTotalComparator)
.forEach(constraintMatchTotal -> {
nextRow();
nextHeaderCell(constraintMatchTotal.getConstraintName());
Score_ constraintWeight = constraintMatchTotal.getConstraintWeight();
nextCell(scoreStyle).setCellValue(constraintWeight == null ? "N/A" : constraintWeight.toShortString());
nextCell().setCellValue(constraintMatchTotal.getConstraintMatchSet().size());
nextCell(scoreStyle).setCellValue(constraintMatchTotal.getScore().toShortString());
constraintMatchTotal.getConstraintMatchSet().stream()
.sorted(constraintMatchComparator)
.forEach(constraintMatch -> {
nextRow();
nextCell();
nextCell();
nextCell();
nextCell();
nextCell();
nextCell(scoreStyle).setCellValue(constraintMatch.getScore().toShortString());
nextCell().setCellValue(
indictmentListFormatter.apply(constraintMatch.getIndictedObjectList()));
});
});
autoSizeColumnsWithHeader();
}
protected void nextSheet(String sheetName, int colSplit, int rowSplit, boolean view) {
currentSheet = workbook.createSheet(sheetName);
currentDrawing = currentSheet.createDrawingPatriarch();
currentSheet.createFreezePane(colSplit, rowSplit);
currentRowNumber = -1;
headerCellCount = 0;
if (view) {
currentSheet.setTabColor(VIEW_TAB_COLOR);
}
}
protected void nextRow() {
currentRowNumber++;
currentRow = currentSheet.createRow(currentRowNumber);
currentColumnNumber = -1;
}
protected void nextHeaderCell(String value) {
nextCell(headerStyle).setCellValue(value);
headerCellCount++;
}
protected void nextHeaderCell(double value) {
nextCell(headerStyle).setCellValue(value);
headerCellCount++;
}
protected XSSFCell nextCell() {
return nextCell(defaultStyle);
}
protected XSSFCell nextCell(XSSFCellStyle cellStyle) {
currentColumnNumber++;
XSSFCell cell = currentRow.createCell(currentColumnNumber);
cell.setCellStyle(cellStyle);
return cell;
}
protected void nextHeaderCellVertically(String value) {
nextCellVertically(headerStyle).setCellValue(value);
headerCellCount++;
}
protected XSSFCell nextCellVertically() {
return nextCellVertically(defaultStyle);
}
protected XSSFCell nextCellVertically(XSSFCellStyle cellStyle) {
currentRowNumber++;
currentRow = currentSheet.getRow(currentRowNumber);
XSSFCell cell = currentRow.createCell(currentColumnNumber);
cell.setCellStyle(cellStyle);
return cell;
}
protected void autoSizeColumnsWithHeader() {
for (int i = 0; i < headerCellCount; i++) {
currentSheet.autoSizeColumn(i);
}
}
protected void setSizeColumnsWithHeader(int width) {
for (int i = 0; i < headerCellCount; i++) {
currentSheet.setColumnWidth(i, width);
}
}
}
}