org.optaplanner.examples.common.persistence.AbstractXmlSolutionImporter 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.
/*
* Copyright 2010 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.common.persistence;
import java.io.BufferedInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import org.apache.commons.io.FilenameUtils;
import org.jdom.Document;
import org.jdom.Element;
import org.jdom.JDOMException;
import org.jdom.input.SAXBuilder;
import org.optaplanner.core.api.domain.solution.PlanningSolution;
/**
* @param the solution type, the class with the {@link PlanningSolution} annotation
*/
public abstract class AbstractXmlSolutionImporter extends AbstractSolutionImporter {
private static final String DEFAULT_INPUT_FILE_SUFFIX = "xml";
@Override
public String getInputFileSuffix() {
return DEFAULT_INPUT_FILE_SUFFIX;
}
public abstract XmlInputBuilder createXmlInputBuilder();
@Override
public Solution_ readSolution(File inputFile) {
try (InputStream in = new BufferedInputStream(new FileInputStream(inputFile))) {
SAXBuilder builder = new SAXBuilder(false);
Document document = builder.build(in);
XmlInputBuilder xmlInputBuilder = createXmlInputBuilder();
xmlInputBuilder.setInputFile(inputFile);
xmlInputBuilder.setDocument(document);
try {
Solution_ solution = xmlInputBuilder.readSolution();
logger.info("Imported: {}", inputFile);
return solution;
} catch (IllegalArgumentException | IllegalStateException e) {
throw new IllegalArgumentException("Exception in inputFile (" + inputFile + ")", e);
}
} catch (IOException e) {
throw new IllegalArgumentException("Could not read the file (" + inputFile.getName() + ").", e);
} catch (JDOMException e) {
throw new IllegalArgumentException("Could not parse the XML file (" + inputFile.getName() + ").", e);
}
}
public static abstract class XmlInputBuilder extends InputBuilder {
protected File inputFile;
protected Document document;
public void setInputFile(File inputFile) {
this.inputFile = inputFile;
}
public void setDocument(Document document) {
this.document = document;
}
public abstract Solution_ readSolution() throws IOException, JDOMException;
// ************************************************************************
// Helper methods
// ************************************************************************
public String getInputId() {
return FilenameUtils.getBaseName(inputFile.getPath());
}
protected void assertElementName(Element element, String name) {
if (!element.getName().equals(name)) {
throw new IllegalStateException("Element name (" + element.getName()
+ ") should be " + name + ".");
}
}
}
}