Class Optimization

java.lang.Object

com.dna.jopt.framework.body.Optimization

All Implemented Interfaces:

IOptimizationEventListener, IOptimization

public class Optimization
extends Object
implements IOptimization

In the Optimization the license and the IOptimizationScheme are set, all the INode, IResource and Properties are added and the IEntity can be accessed.

Since:

Sep 27, 2019

Version:

Sep 27, 2019

Author:

Jens Richter

Field Summary

Fields

Modifier and Type	Field	Description
protected com.dna.jopt.revision.algorithm.IOptimizationAlgorithm.OptimizationAlgorithmStart	initialOptimizationModeGE	The initial optimization mode GE.
protected com.dna.jopt.revision.algorithm.IOptimizationAlgorithm.OptimizationAlgorithmStart	initialOptimizationModeSA	The initial optimization mode SA.
protected String	jsonLic

Constructor Summary

Constructors

Constructor	Description
Optimization()	Instantiates a new optimization.
Optimization(com.dna.jopt.framework.body.setup.IOptimizationSetup optimizationSetup)	Instantiates a new optimization.
Optimization(com.dna.jopt.framework.body.setup.IOptimizationSetup optimizationSetup, OptimizationEvents optimizationEvents)	Instantiates a new optimization.

Method Summary

Modifier and Type	Method	Description
void	addDistanceMatrix(double[][] distanceMatrix)	Deprecated.
void	addElement(INode node)	Adds an INode to the optimization.
void	addElement(IPillarNode pillarnode)	Adds a IPillarNode to the optimization.
void	addElement(IResource res)	Adds an IResource to the optimization.
void	addElement(Properties properties)	Sets the given properties as getUserProperties() and invokes the user properties.
void	addNodes(List<INode> nodes)	Adds all nodes in the list to the optimization.
void	addReassignNodes(List<INode> nodes)	Adds reassign nodes.
void	addReassignResources(List<IResource> ress)	Adds reassign resources.
void	addResources(List<IResource> resources)	Adds all resources in the list to the optimization.
void	addTimeMatrix(double[][] timeMatrix)	Deprecated.
void	cleanUpNoneOptimizableElementsDetailHolder(Set<String> deadIds)	Clean up none optimizable elements detail holder.
boolean	cleanUpOptimization()	Clean up optimization boolean.
List<IOptimizationElement>	getAllElements()	Calls IEntity.getAllEntityElements() and INodeUnassigner.getUnassignedNodes() , then returns all of these elements.
List<IOptimizationElement>	getAllPriorSubNodes()
List<IOptimizationElement>	getAllRoutesElements(String resourceId)	Calls IEntity.getAllRoutesElements(String), if IOptimization.getWorkEntity() is not null.
List<IOptimizationElement>	getAllSubsequentSubNodes()
List<ILogicEntityRoute>	getAnchoredRoutes()	Invokes IEntity.getAnchoredRoutes() if workEntity is not null.
String	getCoreVersion()	Gets the OptimizationVersionHelper.getCoreVersionProperties() of myVersionHelper.
Properties	getCoreVersionProperties()	Gets the OptimizationVersionHelper.getCoreVersionProperties() of myVersionHelper.
com.dna.jopt.revision.algorithm.IOptimizationAlgorithm	getCurrentOptimizationAlgo()	Calls OptimizationSubController.getCurrentOptimizationAlgo().
Optional<ILogicEntityRoute>	getFirstMatchingRoute(INode node)	Invokes IEntity.getFirstMatchingRoute(INode) if workEntity is not null.
Optional<ILogicEntityRoute>	getFirstMatchingRoute(String nodeId)	Invokes IEntity.getFirstMatchingRoute(String) if workEntity is not null.
long	getId()	Gets the id of the current thread.
INodeEdgeConnector	getNodeConnector()	Gets the getNodeConnector().
List<IOptimizationElement>	getNoneOptimizableElements()	Calls IEntity.getNoneOptimizableElements() if getWorkEntity() is not null.
protected Map<String, ILogicRouteElementDetailItem>	getNoneOptimizableElementsDetailHolder()	Gets the none optimizable elements detail holder.
Map<String, ILogicRouteElementDetailItem>	getNoneOptimizableElementsDetails()	Gets the getNoneOptimizableElementsDetailHolder().
ILogicRouteElementDetailItem	getNoneOptimizableNodDetail(String elementId)	Gets the value in the getNoneOptimizableElementsDetailHolder() for the given elementId.
List<IOptimizationElement>	getOptimizableElements()	Calls IEntity.getNoneOptimizableElements() if the IOptimization.getWorkEntity() is not null.
Optional<String>	getOptimizationCreator()
Optional<IOptimizationElement>	getOptimizationElement(String id)	/////
Optional<IOptimizationElement>	getOptimizationElement(String id, boolean includeUnassignedElements)	Gets the optimization element.
OptimizationEvents	getOptimizationEvents()	Gets the OptimizationEvents which are backed by multiple ReplaySubject and CompletableFuture.
String	getOptimizationRunIdent()	Gets the optimization run ident.
IOptimizationScheme	getOptimizationScheme()	Gets the defined IOptimizationScheme.
com.dna.jopt.framework.body.setup.IOptimizationSetup	getOptimizationSetup()	Gets the IOptimizationSetup.
int	getOptimizationStage()	Calls OptimizationSubController.getCurrentOptimizationAlgo().
com.dna.jopt.framework.inputplausibility.properties.IPropertyProvider	getPropertyProvider()	Gets the property provider through IOptimizationSetup.getPropertyProvider().
List<INode>	getReassignNodes()
List<IResource>	getReassignResources()
String	getThreadPrefix()	Gets the threadPrefix, the standard value is "JOPT-".
ITypeDictionaryManager	getTypeDictionaryManager()
Optional<IOptimizationElement>	getUnassignedElement(String id)	Gets an unassigned element if present.
INodeUnassigner	getUnassignNodeManager()	Gets the INodeUnassigner of the optimization.
Optional<Properties>	getUserEntityCoreBuildOptions()	Gets the userEntityCoreBuildOptionsOpt.
Optional<Properties>	getUserProperties()	Gets the getUserProperties(), if null returns empty().
String	getVersion()	Deprecated.
String	getVersionForStatus(String desc, String propertyPrefix, Properties props)
IEntity	getWorkEntity()	Gets the workEntity.
void	handleOnErrorInterruptionState(Throwable e)	Restores the interrupted state of the calling thread after a failed run start.
boolean	hasEntitySetByUser()	Checks hasEntitySetByUser(), the default value is false.
boolean	isStopOptimization()	Used internally to keep track if the optimization is stopped.
void	jumpToNextStage()	Checks that getCurrentOptimizationAlgo() is not null, then calls IOptimizationAlgorithm.jumpToEnd().
void	onAfterNodeFilteringOptimizationResult(IOptimizationResult requestedresult)
void	onAsynchronousOptimizationResult(IOptimizationResult rapoptResult)	On asynchronous optimization result.
void	onBeforeNodeFilteringOptimizationResult(IOptimizationResult requestedresult)
void	onError(int code, String message)	On error.
void	onError(IErrorEvent errorEvent)	On error.
void	onNodeFiltering(int code, String message, List<INodeFilterReason> filterReasons)	On node filtering.
void	onNodeFiltering(NodeFilteringEvent nodeFilteringEvent)	On node filtering.
void	onProgress(IOptimizationProgress progress)	On progress.
void	onProgress(String progressString)	Deprecated.
void	onRequestCodeExecutionDone(String executionId)	On asynch execution done.
void	onStatus(int code, String message)	On status.
void	onStatus(IStatusEvent statusEvent)	On status.
void	onWarning(int code, String message)	On warning.
void	onWarning(IWarningEvent warningEvent)	On warning.
void	pause()	Checks that getCurrentOptimizationAlgo() is not null, then calls IOptimizationAlgorithm.pause().
void	prePreparation()
void	proceed()	Checks that getCurrentOptimizationAlgo() is not null, then calls IOptimizationAlgorithm.proceed() which wakes up all threads that are waiting on this object's monitor.
protected void	putAllNoneOptimizableNodDetail(Map<String, ILogicRouteElementDetailItem> noneOptimizableElementsDetailHolder)	Put all none optimizable nod detail.
void	putNoneOptimizableNodDetail(String elementId, ILogicRouteElementDetailItem details)	Puts a value at elementId in getNoneOptimizableElementsDetailHolder().
void	requestedAsynchronousOptimizationResult(IOptimizationResult result)	Requested asynchronous optimization result.
void	requestExportState(OutputStream output, String executionId)	Request export state with 100 Days of internal timeOut.
void	requestExportState(OutputStream output, String executionId, Duration timeOut)	Request export state with time out.
void	requestProgress()	Requesting a IOptimizationProgress progress which will be provided in an async.
void	requestResult()	Requesting an intermediate IOptimizationResult result which will be provided in an async.
void	resetInitialEntity()	Reset initial entity.
void	setAutoFilterExecutionSchedule(List<Double> userExecutionList)	Sets hasUserAutoFilterExectuionList to true, then sets the input as the userExecutionList.
void	setInitialEntity(IEntity initialEntity)	Sets the initial IEntity as the workEntity and hasEntitySetByUser() to true.
void	setInitialEntity(IEntity initialEntity, boolean reassignUnassignedNode)	Sets the given IEntity as the initial Entity.
void	setInitialEntityRenewAutoFilterControllers(IEntity initialEntity)	Deprecated.
void	setLicenseJSON(File file)	Sets the license from a file: a signed license of the scheme jopt-ed25519-v1 in UTF-8, checked as IOptimization.setLicenseJSON(String) describes.
void	setLicenseJSON(String jsonLic)	Sets the license as text: a signed license of the scheme jopt-ed25519-v1.
void	setNodeConnector(INodeEdgeConnector nodeConnector)	Sets the getNodeConnector().
void	setOptimizationAlgorithmStart(com.dna.jopt.revision.algorithm.IOptimizationAlgorithm.OptimizationAlgorithmStart modeSA, com.dna.jopt.revision.algorithm.IOptimizationAlgorithm.OptimizationAlgorithmStart modeGE)	Sets the initialOptimizationModeGE and initialOptimizationModeSA, both have the default value STATE_MODE_BATCH.
boolean	setOptimizationCreator(String creator)
boolean	setOptimizationRunIdent(String ident)	Sets the optimization run identification string.
void	setOptimizationScheme(IOptimizationScheme optimizationScheme)	Sets the IOptimizationScheme.
void	setThreadPrefix(String threadPrefix)	Sets the getThreadPrefix() , the default value is "JOPT-".
void	settleOptimization()	Internally called to settle the optimization, e.g.
void	setTypeDictionaryManager(ITypeDictionaryManager typeDictionaryManager)
void	setUnassignNodeManager(INodeUnassigner unassignNodeManager)	Sets the INodeUnassigner.
void	setUserEntityCoreBuildOptions(Properties userEntityCoreBuildOptions)	Sets userEntityCoreBuildOptionsOpt as an Optional with the parameter values if not null.
void	setWorkEntity(IEntity workEntity)	Sets the workEntity.
void	startAsynchronousOptimizationRun()	Deprecated.
CompletableFuture<IOptimizationResult>	startRunAsync()	Start run async.
IOptimizationResult	startRunSync(long timeout, TimeUnit unit)	Start run sync.
void	stopOptimization()	Checks that getCurrentOptimizationAlgo() is not null, then sets isStopOptimization() to true and calls IOptimizationAlgorithm.jumpToEnd().

Methods inherited from class Object

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

Field Details

initialOptimizationModeSA

protected com.dna.jopt.revision.algorithm.IOptimizationAlgorithm.OptimizationAlgorithmStart initialOptimizationModeSA

The initial optimization mode SA.

initialOptimizationModeGE

protected com.dna.jopt.revision.algorithm.IOptimizationAlgorithm.OptimizationAlgorithmStart initialOptimizationModeGE

The initial optimization mode GE.

jsonLic

protected String jsonLic

Constructor Details

Optimization

public Optimization()

Instantiates a new optimization.

Optimization

public Optimization(com.dna.jopt.framework.body.setup.IOptimizationSetup optimizationSetup)

Instantiates a new optimization.

Parameters:

optimizationSetup - the optimization setup

Optimization

public Optimization(com.dna.jopt.framework.body.setup.IOptimizationSetup optimizationSetup,
 OptimizationEvents optimizationEvents)

Instantiates a new optimization.

Parameters:

optimizationSetup - the optimization setup

optimizationEvents - the optimization events

Method Details

setOptimizationCreator

public boolean setOptimizationCreator(String creator)

Specified by:

setOptimizationCreator in interface IOptimization

getOptimizationCreator

public Optional<String> getOptimizationCreator()

Specified by:

getOptimizationCreator in interface IOptimization

setOptimizationRunIdent

public boolean setOptimizationRunIdent(String ident)

Description copied from interface: IOptimization

Sets the optimization run identification string. This can be an arbitrary user provided String to identify a run. If no ident is provided, the Optimizer will generate an ident whenever the optimization is saved.

Specified by:

setOptimizationRunIdent in interface IOptimization

Parameters:

ident - the ident

Returns:

true, if accepted

getOptimizationRunIdent

public String getOptimizationRunIdent()

Description copied from interface: IOptimization

Gets the optimization run ident. If no ident was provided the Optimizer creates an ident on the first call of this method.

Specified by:

getOptimizationRunIdent in interface IOptimization

Returns:

the optimization run ident

setAutoFilterExecutionSchedule

public void setAutoFilterExecutionSchedule(List<Double> userExecutionList)

Description copied from interface: IOptimization

Sets hasUserAutoFilterExectuionList to true, then sets the input as the userExecutionList.

Specified by:

setAutoFilterExecutionSchedule in interface IOptimization

Parameters:

userExecutionList - the List<Double> to be set as userExecutionList

getId

public long getId()

Description copied from interface: IOptimization

Gets the id of the current thread.

Specified by:

getId in interface IOptimization

Returns:

the long thread id

See Also:

• Thread#getId()

getOptimizationEvents

public OptimizationEvents getOptimizationEvents()

Description copied from interface: IOptimization

Gets the OptimizationEvents which are backed by multiple ReplaySubject and CompletableFuture. OptimizationEvents can be used to subscribe to different events of the optimization.

Specified by:

getOptimizationEvents in interface IOptimization

Returns:

the optimizationevents

setOptimizationAlgorithmStart

public void setOptimizationAlgorithmStart(com.dna.jopt.revision.algorithm.IOptimizationAlgorithm.OptimizationAlgorithmStart modeSA,
 com.dna.jopt.revision.algorithm.IOptimizationAlgorithm.OptimizationAlgorithmStart modeGE)

Description copied from interface: IOptimization

Sets the initialOptimizationModeGE and initialOptimizationModeSA, both have the default value STATE_MODE_BATCH.

Specified by:

setOptimizationAlgorithmStart in interface IOptimization

Parameters:

modeSA - the modeSA

modeGE - the modeGE

putNoneOptimizableNodDetail

public void putNoneOptimizableNodDetail(String elementId,
 ILogicRouteElementDetailItem details)

Description copied from interface: IOptimization

Puts a value at elementId in getNoneOptimizableElementsDetailHolder().

Specified by:

putNoneOptimizableNodDetail in interface IOptimization

Parameters:

elementId - the string id for the value to be put

details - the iLogicRouteElementDetailItem that is supposed to be put

putAllNoneOptimizableNodDetail

protected void putAllNoneOptimizableNodDetail(Map<String, ILogicRouteElementDetailItem> noneOptimizableElementsDetailHolder)

Put all none optimizable nod detail.

Parameters:

noneOptimizableElementsDetailHolder - the none optimizable elements detail holder

getNoneOptimizableNodDetail

public ILogicRouteElementDetailItem getNoneOptimizableNodDetail(String elementId)

Description copied from interface: IOptimization

Gets the value in the getNoneOptimizableElementsDetailHolder() for the given elementId. This method is primarily used for internal purpose. Please try to extract details from the route itself.

Specified by:

getNoneOptimizableNodDetail in interface IOptimization

Parameters:

elementId - the string key for the value

Returns:

the value of the elementId in noneOptimizableElementsDetailHolder

getNoneOptimizableElementsDetailHolder

protected Map<String, ILogicRouteElementDetailItem> getNoneOptimizableElementsDetailHolder()

Gets the none optimizable elements detail holder.

Returns:

the none optimizable elements detail holder

cleanUpNoneOptimizableElementsDetailHolder

public void cleanUpNoneOptimizableElementsDetailHolder(Set<String> deadIds)

Description copied from interface: IOptimization

Clean up none optimizable elements detail holder.

Specified by:

cleanUpNoneOptimizableElementsDetailHolder in interface IOptimization

Parameters:

deadIds - the dead ids

getNoneOptimizableElementsDetails

public Map<String, ILogicRouteElementDetailItem> getNoneOptimizableElementsDetails()

Description copied from interface: IOptimization

Gets the getNoneOptimizableElementsDetailHolder().

Specified by:

getNoneOptimizableElementsDetails in interface IOptimization

Returns:

none optimizable elements details

requestedAsynchronousOptimizationResult

public void requestedAsynchronousOptimizationResult(IOptimizationResult result)

Description copied from interface: IOptimization

Requested asynchronous optimization result.

Specified by:

requestedAsynchronousOptimizationResult in interface IOptimization

Specified by:

requestedAsynchronousOptimizationResult in interface IOptimizationEventListener

Parameters:

result - the result to print

getOptimizationSetup

public com.dna.jopt.framework.body.setup.IOptimizationSetup getOptimizationSetup()

Description copied from interface: IOptimization

Gets the IOptimizationSetup.

Specified by:

getOptimizationSetup in interface IOptimization

Returns:

the optimizationSetup

setOptimizationScheme

public void setOptimizationScheme(IOptimizationScheme optimizationScheme)

Description copied from interface: IOptimization

Sets the IOptimizationScheme.

Specified by:

setOptimizationScheme in interface IOptimization

Parameters:

optimizationScheme - the iOptimizationscheme to add

getOptimizationScheme

public IOptimizationScheme getOptimizationScheme()

Description copied from interface: IOptimization

Gets the defined IOptimizationScheme.

Specified by:

getOptimizationScheme in interface IOptimization

Returns:

the optimizationscheme

setNodeConnector

public void setNodeConnector(INodeEdgeConnector nodeConnector)

Description copied from interface: IOptimization

Sets the getNodeConnector().

Cannot be null.

Specified by:

setNodeConnector in interface IOptimization

Parameters:

nodeConnector - the new node connector

getNodeConnector

public INodeEdgeConnector getNodeConnector()

Description copied from interface: IOptimization

Gets the getNodeConnector().

Specified by:

getNodeConnector in interface IOptimization

Returns:

the node connector

getUnassignNodeManager

public INodeUnassigner getUnassignNodeManager()

Description copied from interface: IOptimization

Gets the INodeUnassigner of the optimization.

Specified by:

getUnassignNodeManager in interface IOptimization

Returns:

the unassignNodeManager

setUnassignNodeManager

public void setUnassignNodeManager(INodeUnassigner unassignNodeManager)

Description copied from interface: IOptimization

Sets the INodeUnassigner.

Cannot be null.

Specified by:

setUnassignNodeManager in interface IOptimization

Parameters:

unassignNodeManager - the unassign node manager

getTypeDictionaryManager

public ITypeDictionaryManager getTypeDictionaryManager()

Specified by:

getTypeDictionaryManager in interface IOptimization

setTypeDictionaryManager

public void setTypeDictionaryManager(ITypeDictionaryManager typeDictionaryManager)

Specified by:

setTypeDictionaryManager in interface IOptimization

getPropertyProvider

public com.dna.jopt.framework.inputplausibility.properties.IPropertyProvider getPropertyProvider()

Description copied from interface: IOptimization

Gets the property provider through IOptimizationSetup.getPropertyProvider().

Specified by:

getPropertyProvider in interface IOptimization

Returns:

the propertyProvider

addElement

public void addElement(INode node)

Description copied from interface: IOptimization

Adds an INode to the optimization.

Specified by:

addElement in interface IOptimization

Parameters:

node - the element to be added.

addNodes

public void addNodes(List<INode> nodes)

Description copied from interface: IOptimization

Adds all nodes in the list to the optimization.

Specified by:

addNodes in interface IOptimization

Parameters:

nodes - the list<INode> of nodes to be added

addReassignNodes

public void addReassignNodes(List<INode> nodes)

Description copied from interface: IOptimization

Adds reassign nodes. In case a custom solution is used IOptimization.setInitialEntity(IEntity), or the optimization is resumed from a snapshot additional nodes can be added. In contrast to IOptimization.addElement(INode), nodes are put in an optimized fashion into the existing solution.

If no solution by the user is provided, calling this method has the same effect as IOptimization.addElement(INode).

Specified by:

addReassignNodes in interface IOptimization

Parameters:

nodes - the nodes

getReassignNodes

public List<INode> getReassignNodes()

Specified by:

getReassignNodes in interface IOptimization

addReassignResources

public void addReassignResources(List<IResource> ress)

Description copied from interface: IOptimization

Adds reassign resources. In case a custom solution is used IOptimization.setInitialEntity(IEntity), or the optimization is resumed from a snapshot additional resources can be added.

If no solution by the user is provided, calling this method has the same effect as IOptimization.addElement(INode).

Specified by:

addReassignResources in interface IOptimization

Parameters:

ress - the resources

getReassignResources

public List<IResource> getReassignResources()

Specified by:

getReassignResources in interface IOptimization

addResources

public void addResources(List<IResource> resources)

Description copied from interface: IOptimization

Adds all resources in the list to the optimization.

Specified by:

addResources in interface IOptimization

Parameters:

resources - the list<IResource> to be added

addElement

public void addElement(IPillarNode pillarnode)

Description copied from interface: IOptimization

Adds a IPillarNode to the optimization.

Specified by:

addElement in interface IOptimization

Parameters:

pillarnode - the pillarnode to be added

addElement

public void addElement(IResource res)

Description copied from interface: IOptimization

Adds an IResource to the optimization.

Specified by:

addElement in interface IOptimization

Parameters:

res - the resource

addElement

public void addElement(Properties properties)

Description copied from interface: IOptimization

Sets the given properties as getUserProperties() and invokes the user properties.

A list of all properties can be generated by the following code example:

  public static void printJOptProperties() {

List<String> categories = new ArrayList<>();
categories.add("CATEGORY_MISC");
categories.add("CATEGORY_SYSTEM");
categories.add("CATEGORY_OPTIMIZATION_GENERAL_SETUP");
categories.add("CATEGORY_OPTIMIZATION_CONSTRUCTION");
categories.add("CATEGORY_OPTIMIZATION_PRE_OPTIMIZATION_SETUP");
categories.add("CATEGORY_OPTIMIZATION_GENETIC_SETUP");
categories.add("CATEGORY_OPTIMIZATION_2OPT");
categories.add("CATEGORY_OPTIMIZATION_WEIGHTS");
categories.add("CATEGORY_OPTIMIZATION_AUTOFILTER");
categories.add("CATEGORY_OPTIMIZATION_CO_SETUP");
categories.add("CATEGORY_OPTIMIZATION_DEPRECATED");

IOptimization myDummyOptimization =  new Optimization();

// Read out current properties
List<PropertyItem> categorySortedPropItems =
myDummyOptimization.getPropertyProvider()
.getPropertyItems()
.stream()
.sorted((o1,o2)->Integer.compare(o1.getCategoryIdent(), o2.getCategoryIdent()))
.collect(Collectors.toList());

categorySortedPropItems
.stream()
.forEach(
i -> {
if (i.getCategoryIdent() == PropertyItem.CATEGORY_OPTIMIZATION_DEPRECATED) {
System.out.print("\n-== DEPRECATED PROPERTY ==-");
} else {
System.out.print("\n");
}

System.out.print(
"\nCategory: "
+ categories.get(i.getCategoryIdent())
+ "\nDescription: "
+ i.getDescription()
+ "\nDefault Key: "
+ i.getValidatedPropertyName()
+ "\nDefault Value: "
+ i.getDefaultValue()
+ "\nAllowed Values: "
+ i.getAllowedValues()
+ "\n");
});
}

Specified by:

addElement in interface IOptimization

Parameters:

properties - the properties

getUserProperties

public Optional<Properties> getUserProperties()

Description copied from interface: IOptimization

Gets the getUserProperties(), if null returns empty().

Specified by:

getUserProperties in interface IOptimization

Returns:

the userProperties

setLicenseJSON

public void setLicenseJSON(String jsonLic)

Description copied from interface: IOptimization

Sets the license as text: a signed license of the scheme jopt-ed25519-v1. The license is checked at run start (signature, due date, and its modules against the run). If the license or the run is refused, the start ends with an InvalidLicenceException whose message begins with the cause of the refusal, for example LEGACY_SCHEME or ELEMENT_LIMIT.

An empty text, as without a call, stands for the free license embedded in this core, which is checked like any other license.

Specified by:

setLicenseJSON in interface IOptimization

Parameters:

jsonLic - the license text

setLicenseJSON

public void setLicenseJSON(File file)
                    throws IOException

Description copied from interface: IOptimization

Sets the license from a file: a signed license of the scheme jopt-ed25519-v1 in UTF-8, checked as IOptimization.setLicenseJSON(String) describes.

Specified by:

setLicenseJSON in interface IOptimization

Parameters:

file - the license file

Throws:

IOException - if the file cannot be read

startAsynchronousOptimizationRun

@Deprecated
public void startAsynchronousOptimizationRun()
                                      throws InvalidLicenceException

Deprecated.

Description copied from interface: IOptimization

Calls IOptimization.startRunSync(long, TimeUnit) with MAX_VALUE as long and MILLISECONDS as TimeUnit.

Specified by:

startAsynchronousOptimizationRun in interface IOptimization

Throws:

InvalidLicenceException - the invalid licence exception

startRunSync

public IOptimizationResult startRunSync(long timeout,
 TimeUnit unit)
                                 throws InvalidLicenceException,
InterruptedException,
ExecutionException,
TimeoutException

Description copied from interface: IOptimization

Start run sync. internally creates a completable future. The optimization is started within a ForkJoinPool. Internally get() is called on it so that the code will block until the completable future returns. However, as the run is outsourced into multiple threads the Optimization object itself stays responsive to allow for example to request an intermediate optimization result.

The timeout sets the time within which the completable future needs to return, otherwise a TimeoutException is thrown

For use without a timeout please use IOptimization.startRunAsync()

Specified by:

startRunSync in interface IOptimization

Parameters:

timeout - the long number of the to be defined time unit until timeout

unit - the timeUnit of the timeout

Returns:

the ioptimization result

Throws:

InvalidLicenceException - the invalid licence exception

InterruptedException - the interrupted exception if the calling thread is interrupted while it waits, for example after a second start of the same optimization

ExecutionException - the execution exception; its cause is the exception that ended the run, for example a LicenseRefusedException if the license check refused the run, or the refusal of the input check (see IOptimization.startRunAsync())

TimeoutException - the timeout exception if the completable future has not been done within the timeout

startRunAsync

public CompletableFuture<IOptimizationResult> startRunAsync()
                                                     throws InvalidLicenceException

Description copied from interface: IOptimization

Start run async. creates a completable future which is returned.

An exception that ends the run completes the completable future exceptionally, with the exception as the cause.

A run that the license check refuses at its start streams one error event with ErrorCode.LICENSE_REFUSED, and the returned completable future is already completed exceptionally, with a LicenseRefusedException as the cause that carries the cause of the refusal. The calling thread is not interrupted.

A run whose input the input check refuses at its start (see JOpt.plausibility.doInputCheck) streams one error event with the code of the refusal, for example ErrorCode.ENTITY_CORRUPT_NOTENOUGHTWORKINGTIME, and the returned completable future is already completed exceptionally. Its cause is an InvalidEntityException if the entity created from the added elements is refused, and an IllegalStateException if a provided solution is refused, also after the reassignment of nodes and resources. The calling thread is not interrupted.

Any other exception at the start is reported to the uncaught exception handler (the default handler streams one error event with ErrorCode.UNCAUGHT_EXCEPTION_IN_OPTIMIZATION), and the returned completable future is already completed exceptionally with the exception as the cause. The calling thread is interrupted only if the exception is an InterruptedException or has one among its causes.

An optimization can be started once. A second start is reported to the uncaught exception handler with an IllegalStateException and interrupts the calling thread; the returned completable future completes with the run of the first start.

Specified by:

startRunAsync in interface IOptimization

Returns:

completable future

Throws:

InvalidLicenceException - the invalid licence exception

handleOnErrorInterruptionState

public void handleOnErrorInterruptionState(Throwable e)

Description copied from interface: IOptimization

Restores the interrupted state of the calling thread after a failed run start. IOptimization.startRunAsync() calls it if an exception in the preparation of the run is an InterruptedException or has one among its causes, and on a second start of the same optimization. The default implementation interrupts the calling thread.

Specified by:

handleOnErrorInterruptionState in interface IOptimization

Parameters:

e - the exception

prePreparation

public void prePreparation()

getVersionForStatus

public String getVersionForStatus(String desc,
 String propertyPrefix,
 Properties props)

setInitialEntity

public void setInitialEntity(IEntity initialEntity)

Description copied from interface: IOptimization

Sets the initial IEntity as the workEntity and hasEntitySetByUser() to true. This method is used to load custom solutions and is used during the loading of a snapshot.

Will throw an IllegalStateException if the initial entity is null.

Specified by:

setInitialEntity in interface IOptimization

Parameters:

initialEntity - the new initial entity

resetInitialEntity

public void resetInitialEntity()

Description copied from interface: IOptimization

Reset initial entity. This method will reset an entity that was assigned to the optimization. It is only allowed to reset an entity before the optimization is started.

This methods helps to use an existing solution to be used only as data provider, ignoring an existing solution.

Specified by:

resetInitialEntity in interface IOptimization

setInitialEntityRenewAutoFilterControllers

@Deprecated
public void setInitialEntityRenewAutoFilterControllers(IEntity initialEntity)

Deprecated.

Description copied from interface: IOptimization

Sets hasEntitySetByUser() and tryRenewAutoFilterController to true, then sets the input initialEntity as the getWorkEntity().

Specified by:

setInitialEntityRenewAutoFilterControllers in interface IOptimization

Parameters:

initialEntity - the iEntity to be set as workEntity

hasEntitySetByUser

public boolean hasEntitySetByUser()

Description copied from interface: IOptimization

Checks hasEntitySetByUser(), the default value is false.

Specified by:

hasEntitySetByUser in interface IOptimization

Returns:

the boolean hasUserEntity

setInitialEntity

public void setInitialEntity(IEntity initialEntity,
 boolean reassignUnassignedNode)

Description copied from interface: IOptimization

Sets the given IEntity as the initial Entity.

Specified by:

setInitialEntity in interface IOptimization

Parameters:

initialEntity - the entity to be set

reassignUnassignedNode - the reassign unassigned node

setWorkEntity

public void setWorkEntity(IEntity workEntity)

Description copied from interface: IOptimization

Sets the workEntity.

Specified by:

setWorkEntity in interface IOptimization

Parameters:

workEntity - the workEntity to be set

setUserEntityCoreBuildOptions

public void setUserEntityCoreBuildOptions(Properties userEntityCoreBuildOptions)

Description copied from interface: IOptimization

Sets userEntityCoreBuildOptionsOpt as an Optional with the parameter values if not null. Will set it as an empty Optional if null.

Specified by:

setUserEntityCoreBuildOptions in interface IOptimization

Parameters:

userEntityCoreBuildOptions - the optional with the given parameters

getUserEntityCoreBuildOptions

public Optional<Properties> getUserEntityCoreBuildOptions()

Description copied from interface: IOptimization

Gets the userEntityCoreBuildOptionsOpt. The default value is an empty Optional.

Specified by:

getUserEntityCoreBuildOptions in interface IOptimization

Returns:

the optional userEntityCoreBuildOptionsOpt

getWorkEntity

public IEntity getWorkEntity()

Description copied from interface: IOptimization

Gets the workEntity.

Specified by:

getWorkEntity in interface IOptimization

Returns:

the iEntity workEntity

getOptimizationElement

public Optional<IOptimizationElement> getOptimizationElement(String id)

/////

Specified by:

getOptimizationElement in interface IOptimization

Parameters:

id - the id

Returns:

the optimization element

getOptimizationElement

public Optional<IOptimizationElement> getOptimizationElement(String id,
 boolean includeUnassignedElements)

Description copied from interface: IOptimization

Gets the optimization element. Extracts an element (Resource or Node) that is member of any route of the current optimization run. Unassigned elements can be found if includeUnassignedElements is true.

Specified by:

getOptimizationElement in interface IOptimization

Parameters:

id - the id

includeUnassignedElements - the include unassigned elements

Returns:

the optimization element

getUnassignedElement

public Optional<IOptimizationElement> getUnassignedElement(String id)

Description copied from interface: IOptimization

Gets an unassigned element if present.

Specified by:

getUnassignedElement in interface IOptimization

Parameters:

id - the id

Returns:

the unassigned element

getAllElements

public List<IOptimizationElement> getAllElements()

Description copied from interface: IOptimization

Calls IEntity.getAllEntityElements() and INodeUnassigner.getUnassignedNodes() , then returns all of these elements. Returns a new Arraylist if these are null.

Specified by:

getAllElements in interface IOptimization

Returns:

the List<IOptimizationElement> with all the elements

getAllSubsequentSubNodes

public List<IOptimizationElement> getAllSubsequentSubNodes()

Specified by:

getAllSubsequentSubNodes in interface IOptimization

getAllPriorSubNodes

public List<IOptimizationElement> getAllPriorSubNodes()

Specified by:

getAllPriorSubNodes in interface IOptimization

getNoneOptimizableElements

public List<IOptimizationElement> getNoneOptimizableElements()

Description copied from interface: IOptimization

Calls IEntity.getNoneOptimizableElements() if getWorkEntity() is not null. Otherwise returns a new Arraylist.

Specified by:

getNoneOptimizableElements in interface IOptimization

Returns:

a List<IOptimizationElement>

getOptimizableElements

public List<IOptimizationElement> getOptimizableElements()

Description copied from interface: IOptimization

Calls IEntity.getNoneOptimizableElements() if the IOptimization.getWorkEntity() is not null. Otherwise returns a new Arraylist.

Specified by:

getOptimizableElements in interface IOptimization

Returns:

the List<IOptimizationElement>

getAllRoutesElements

public List<IOptimizationElement> getAllRoutesElements(String resourceId)

Description copied from interface: IOptimization

Calls IEntity.getAllRoutesElements(String), if IOptimization.getWorkEntity() is not null.

If the route of the given resource does not have any elements returns a new ArrayList<>.

Specified by:

getAllRoutesElements in interface IOptimization

Parameters:

resourceId - the string resourceId

Returns:

the ArrayList<> of the route elements

getFirstMatchingRoute

public Optional<ILogicEntityRoute> getFirstMatchingRoute(String nodeId)

Description copied from interface: IOptimization

Invokes IEntity.getFirstMatchingRoute(String) if workEntity is not null.

Specified by:

getFirstMatchingRoute in interface IOptimization

Parameters:

nodeId - the string of the nodeId that is supposed to match

Returns:

an optional with the matching route or an empty optional

getFirstMatchingRoute

public Optional<ILogicEntityRoute> getFirstMatchingRoute(INode node)

Description copied from interface: IOptimization

Invokes IEntity.getFirstMatchingRoute(INode) if workEntity is not null.

Specified by:

getFirstMatchingRoute in interface IOptimization

Parameters:

node - the iNode that is supposed to match

Returns:

an optional with the matching route or an empty optional

getAnchoredRoutes

public List<ILogicEntityRoute> getAnchoredRoutes()

Description copied from interface: IOptimization

Invokes IEntity.getAnchoredRoutes() if workEntity is not null. Otherwise returns a new ArrayList.

Specified by:

getAnchoredRoutes in interface IOptimization

Returns:

the anchored routes

setThreadPrefix

public void setThreadPrefix(String threadPrefix)

Description copied from interface: IOptimization

Sets the getThreadPrefix() , the default value is "JOPT-". This helps to identify the running optimization thread on the user system.

Specified by:

setThreadPrefix in interface IOptimization

Parameters:

threadPrefix - the prefix to be set

getThreadPrefix

public String getThreadPrefix()

Description copied from interface: IOptimization

Gets the threadPrefix, the standard value is "JOPT-".

Specified by:

getThreadPrefix in interface IOptimization

Returns:

the string threadPrefix

getOptimizationStage

public int getOptimizationStage()

Description copied from interface: IOptimization

Calls OptimizationSubController.getCurrentOptimizationAlgo(). For example, in case three optimization algorithms and currently the second algorithm is running the stage identifier is one. The first algorithm would have the stage identifier zero.

Specified by:

getOptimizationStage in interface IOptimization

Returns:

returns the optimizationAlgo

getCurrentOptimizationAlgo

public com.dna.jopt.revision.algorithm.IOptimizationAlgorithm getCurrentOptimizationAlgo()

Description copied from interface: IOptimization

Calls OptimizationSubController.getCurrentOptimizationAlgo(). Returns the currently running optimization algorithm.

Specified by:

getCurrentOptimizationAlgo in interface IOptimization

Returns:

the current optimizationalgorithm

settleOptimization

public void settleOptimization()

Description copied from interface: IOptimization

Internally called to settle the optimization, e.g. finishing all running postStepManagers.

Specified by:

settleOptimization in interface IOptimization

requestResult

public void requestResult()

Description copied from interface: IOptimization

Requesting an intermediate IOptimizationResult result which will be provided in an async. manner.

Checks that getCurrentOptimizationAlgo() is not null, then calls IOptimizationAlgorithm.requestResult().

Specified by:

requestResult in interface IOptimization

requestProgress

public void requestProgress()

Description copied from interface: IOptimization

Requesting a IOptimizationProgress progress which will be provided in an async. manner.

Checks that getCurrentOptimizationAlgo() is not null, then calls IOptimizationAlgorithm.requestProgress().

Specified by:

requestProgress in interface IOptimization

requestExportState

public void requestExportState(OutputStream output,
 String executionId)

Description copied from interface: IOptimization

Request export state with 100 Days of internal timeOut. The optimization will be saved as JSON to the provided outputStream. Further, when the saving is done, to returned CompletableFuture is completed with the provided executionId.

Specified by:

requestExportState in interface IOptimization

Parameters:

output - the output

executionId - the execution id

requestExportState

public void requestExportState(OutputStream output,
 String executionId,
 Duration timeOut)
                        throws TimeoutException

Description copied from interface: IOptimization

Request export state with time out. The optimization will be saved as JSON to the provided outputStream. Further, when the saving is done, to returned CompletableFuture is completed with the provided executionId.

Specified by:

requestExportState in interface IOptimization

Parameters:

output - the output

executionId - the execution id

timeOut - the time out

Throws:

TimeoutException - the timeout exception

jumpToNextStage

public void jumpToNextStage()

Description copied from interface: IOptimization

Checks that getCurrentOptimizationAlgo() is not null, then calls IOptimizationAlgorithm.jumpToEnd().

Specified by:

jumpToNextStage in interface IOptimization

stopOptimization

public void stopOptimization()

Description copied from interface: IOptimization

Checks that getCurrentOptimizationAlgo() is not null, then sets isStopOptimization() to true and calls IOptimizationAlgorithm.jumpToEnd(). This call will trigger a graceful optimization stop triggering the optimization result.

Specified by:

stopOptimization in interface IOptimization

isStopOptimization

public boolean isStopOptimization()

Description copied from interface: IOptimization

Used internally to keep track if the optimization is stopped.

Specified by:

isStopOptimization in interface IOptimization

Returns:

the boolean optimizationWasStopped

proceed

public void proceed()

Description copied from interface: IOptimization

Checks that getCurrentOptimizationAlgo() is not null, then calls IOptimizationAlgorithm.proceed() which wakes up all threads that are waiting on this object's monitor.

Specified by:

proceed in interface IOptimization

See Also:

• IOptimization.pause()

pause

public void pause()

Description copied from interface: IOptimization

Checks that getCurrentOptimizationAlgo() is not null, then calls IOptimizationAlgorithm.pause().

Specified by:

pause in interface IOptimization

See Also:

• IOptimization.proceed()

getVersion

@Deprecated
public String getVersion()

Deprecated.

Description copied from interface: IOptimization

Gets information about the build of the library.

Specified by:

getVersion in interface IOptimization

Returns:

the string myVersion

getCoreVersionProperties

public Properties getCoreVersionProperties()

Description copied from interface: IOptimization

Gets the OptimizationVersionHelper.getCoreVersionProperties() of myVersionHelper.

Specified by:

getCoreVersionProperties in interface IOptimization

Returns:

the versionCoreProperties

getCoreVersion

public String getCoreVersion()

Description copied from interface: IOptimization

Gets the OptimizationVersionHelper.getCoreVersionProperties() of myVersionHelper.

Specified by:

getCoreVersion in interface IOptimization

Returns:

the versionCoreProperties

cleanUpOptimization

public boolean cleanUpOptimization()

Description copied from interface: IOptimization

Clean up optimization boolean. Returns true.

Specified by:

cleanUpOptimization in interface IOptimization

Returns:

true

addDistanceMatrix

@Deprecated
public void addDistanceMatrix(double[][] distanceMatrix)

Deprecated.

Adds the distance matrix.

Specified by:

addDistanceMatrix in interface IOptimization

Parameters:

distanceMatrix - the distance matrix

Category:

Legacy

Adds the distance matrix.

addTimeMatrix

@Deprecated
public void addTimeMatrix(double[][] timeMatrix)

Deprecated.

Adds the time matrix.

Specified by:

addTimeMatrix in interface IOptimization

Parameters:

timeMatrix - the time matrix

Category:

Legacy

Adds the time matrix.

onProgress

@Deprecated
public void onProgress(String progressString)

Deprecated.

Description copied from interface: IOptimizationEventListener

On progress. Use IOptimizationEventListener.onProgress(IOptimizationProgress) instead

Specified by:

onProgress in interface IOptimizationEventListener

Parameters:

progressString - the winner progress string

onProgress

public void onProgress(IOptimizationProgress progress)

Description copied from interface: IOptimizationEventListener

On progress.

Specified by:

onProgress in interface IOptimizationEventListener

Parameters:

progress - the cur best entity

onAsynchronousOptimizationResult

public void onAsynchronousOptimizationResult(IOptimizationResult rapoptResult)

Description copied from interface: IOptimizationEventListener

On asynchronous optimization result.

Specified by:

onAsynchronousOptimizationResult in interface IOptimizationEventListener

Parameters:

rapoptResult - the winner

onError

public void onError(int code,
 String message)

Description copied from interface: IOptimizationEventListener

On error.

Specified by:

onError in interface IOptimizationEventListener

Parameters:

code - the code

message - the message

onError

public void onError(IErrorEvent errorEvent)

Description copied from interface: IOptimizationEventListener

On error.

Specified by:

onError in interface IOptimizationEventListener

Parameters:

errorEvent - the error event

onWarning

public void onWarning(int code,
 String message)

Description copied from interface: IOptimizationEventListener

On warning.

Specified by:

onWarning in interface IOptimizationEventListener

Parameters:

code - the code

message - the message

onWarning

public void onWarning(IWarningEvent warningEvent)

Description copied from interface: IOptimizationEventListener

On warning.

Specified by:

onWarning in interface IOptimizationEventListener

Parameters:

warningEvent - the i warning event

onStatus

public void onStatus(int code,
 String message)

Description copied from interface: IOptimizationEventListener

On status.

Specified by:

onStatus in interface IOptimizationEventListener

Parameters:

code - the code

message - the message

onStatus

public void onStatus(IStatusEvent statusEvent)

Description copied from interface: IOptimizationEventListener

On status.

Specified by:

onStatus in interface IOptimizationEventListener

Parameters:

statusEvent - the status event

onNodeFiltering

public void onNodeFiltering(int code,
 String message,
 List<INodeFilterReason> filterReasons)

Description copied from interface: IOptimizationEventListener

On node filtering.

Specified by:

onNodeFiltering in interface IOptimizationEventListener

Parameters:

code - the code

message - the message

filterReasons - the filter reasons

onNodeFiltering

public void onNodeFiltering(NodeFilteringEvent nodeFilteringEvent)

Description copied from interface: IOptimizationEventListener

On node filtering.

Specified by:

onNodeFiltering in interface IOptimizationEventListener

Parameters:

nodeFilteringEvent - the node filtering event

onRequestCodeExecutionDone

public void onRequestCodeExecutionDone(String executionId)

Description copied from interface: IOptimizationEventListener

On asynch execution done.

Specified by:

onRequestCodeExecutionDone in interface IOptimizationEventListener

Parameters:

executionId - the execution id

onBeforeNodeFilteringOptimizationResult

public void onBeforeNodeFilteringOptimizationResult(IOptimizationResult requestedresult)

Specified by:

onBeforeNodeFilteringOptimizationResult in interface IOptimizationEventListener

onAfterNodeFilteringOptimizationResult

public void onAfterNodeFilteringOptimizationResult(IOptimizationResult requestedresult)

Specified by:

onAfterNodeFilteringOptimizationResult in interface IOptimizationEventListener