org.optaweb.vehiclerouting.service.route

Class ShallowRoute

java.lang.Object

org.optaweb.vehiclerouting.service.route.ShallowRoute

public class ShallowRoute
extends Object

Lightweight route description consisting of vehicle and location IDs instead of entities. This makes it easier to quickly construct and share result of route optimization without converting planning domain objects to business domain objects. Specifically, some information may be lost when converting business domain objects to planning domain because it's not needed for optimization (e.g. location address) and so it's impossible to reconstruct the original business object without looking into the repository.

Field Summary

Fields

Modifier and Type	Field and Description
Long	depotId Depot ID (never null).
Long	vehicleId Vehicle ID (never null).
List<Long>	visitIds Visit IDs (immutable).

Constructor Summary

Constructors

Constructor and Description
ShallowRoute(Long vehicleId, Long depotId, List<Long> visitIds) Create shallow route.

Method Summary

Modifier and Type	Method and Description
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

vehicleId

public final Long vehicleId

Vehicle ID (never null).

depotId

public final Long depotId

Depot ID (never null).

visitIds

public final List<Long> visitIds

Visit IDs (immutable).

Constructor Detail

ShallowRoute

public ShallowRoute(Long vehicleId,
                    Long depotId,
                    List<Long> visitIds)

Create shallow route.

Parameters:

vehicleId - vehicle ID (never null)

depotId - depot ID (never null)

visitIds - visit IDs

Method Detail

toString

public String toString()

Overrides:

toString in class Object