org.optaplanner.examples.tsp.domain.Visit 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 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.optaplanner.examples.tsp.domain;
import com.thoughtworks.xstream.annotations.XStreamAlias;
import org.apache.commons.lang.builder.EqualsBuilder;
import org.apache.commons.lang.builder.HashCodeBuilder;
import org.optaplanner.core.api.domain.entity.PlanningEntity;
import org.optaplanner.core.api.domain.variable.PlanningVariable;
import org.optaplanner.examples.common.domain.AbstractPersistable;
import org.optaplanner.examples.tsp.domain.solver.LatitudeVisitDifficultyComparator;
@PlanningEntity(difficultyComparatorClass = LatitudeVisitDifficultyComparator.class)
@XStreamAlias("Visit")
public class Visit extends AbstractPersistable implements Standstill {
private City city; // the destinationCity
// Planning variables: changes during planning, between score calculations.
private Standstill previousStandstill;
public City getCity() {
return city;
}
public void setCity(City city) {
this.city = city;
}
@PlanningVariable(chained = true, valueRangeProviderRefs = {"domicileRange", "visitRange"})
public Standstill getPreviousStandstill() {
return previousStandstill;
}
public void setPreviousStandstill(Standstill previousStandstill) {
this.previousStandstill = previousStandstill;
}
// ************************************************************************
// Complex methods
// ************************************************************************
public int getDistanceToPreviousStandstill() {
if (previousStandstill == null) {
return 0;
}
return getDistanceTo(previousStandstill);
}
public int getDistanceTo(Standstill standstill) {
return city.getDistance(standstill.getCity());
}
/**
* The normal methods {@link #equals(Object)} and {@link #hashCode()} cannot be used because the rule engine already
* requires them (for performance in their original state).
* @see #solutionHashCode()
*/
public boolean solutionEquals(Object o) {
if (this == o) {
return true;
} else if (o instanceof Visit) {
Visit other = (Visit) o;
return new EqualsBuilder()
.append(id, other.id)
.append(city, other.city) // TODO performance leak: not needed?
.append(previousStandstill, other.previousStandstill) // TODO performance leak: not needed?
.isEquals();
} else {
return false;
}
}
/**
* The normal methods {@link #equals(Object)} and {@link #hashCode()} cannot be used because the rule engine already
* requires them (for performance in their original state).
* @see #solutionEquals(Object)
*/
public int solutionHashCode() {
return new HashCodeBuilder()
.append(id)
.append(city) // TODO performance leak: not needed?
.append(previousStandstill) // TODO performance leak: not needed?
.toHashCode();
}
@Override
public String toString() {
return city + "(after " + (previousStandstill == null ? "null" : previousStandstill.getCity()) + ")";
}
}