com.dna.jopt.member.bucket.entity

Interface IEntity

All Superinterfaces:

Cloneable, Serializable

All Known Implementing Classes:

Entity

public interface IEntity
extends Cloneable, Serializable

An Entity contains all ILogicEntityRoute, IResource, INode etc. of a current IOptimization.

This interface provides methods to add or remove Routes, get the costs getJoinedCost(), get the first matching Route of a Node etc.

Since:

02/08/2019

Version:

10/02/2020

Author:

DNA

Method Summary

Modifier and Type	Method and Description
void	addRoute(ILogicEntityRoute logicRoute) Adds an ILogicEntityRoute.
void	addRoute(int index, ILogicEntityRoute logicRoute) Adds a ILogicEntityRoute at the index position, shifting the Route at that position to the right and updating all indexes
IEntity	copy() Copies the current IEntity.
List<ILogicEntityRoute>	exchangeExistingRoutesWithClones(List<ILogicEntityRoute> existingRoutes) Replaces the input ILogicEntityRoutes with clones within the Solution.
ILogicEntityRoute	exchangeExistingRouteWithClone(ILogicEntityRoute existingRoute) Replaces the input ILogicEntityRoute with a clone within the Entity.
boolean	exchangeExistingRouteWithExistingRoute(ILogicEntityRoute existingRouteOrg, ILogicEntityRoute existingRouteReplace) Replaces an ILogicEntityRoute with another ILogicEntityRoute in all the Entities.
List<IOptimizationElement>	getAllEntityElements() Gets all IOptimizationElements of the IEntity.
List<IOptimizationElement>	getAllRoutesElements(String resourceId) Gets all IOptimizationElements Ids who's visiting resource id equal to the input String.
List<ILogicEntityRoute>	getAnchoredRoutes() Returns all ILogicEntityRoute with anchorNodes, which are essentially IPillarNodes overwriting the start or end of a Route.
long	getBuildTimeStamp()
Optional<IOptimizationElement>	getElement(String id)
Optional<IOptimizationElement>	getElement(String id, boolean ignoreStartEnd)
com.dna.jopt.framework.firstentitycreation.IEntityArranger	getEntityArranger() Gets the IEntityArranger, responsible for creating a hard constraints free IEntity.
IEntityCostAndViolationController	getEntityCostAndViolationController() Gets the IEntityCostAndViolationController, responsible for internal cost and IViolations.
IEntityInvokedOperatorController	getEntityInvokedOperatorController() Gets the IEntityInvokedOperatorController.
Optional<ILogicEntityRoute>	getFirstMatchingRoute(INode node) Gets the first ILogicEntityRoute in the Entity which contains the input INode.
Optional<ILogicEntityRoute>	getFirstMatchingRoute(String nodeId) Returns the first ILogicEntityRoute in which the INode or IPillarNode with the input nodeId was found.
double	getJoinedCost() Gets the joined cost which is the accumulated sum of internal cost of all IlogicEntityRoutes of the IEntity.
IJoinedEntityDetailController	getJoinedDetailController() Gets the IJoinedEntityDetailController which is assessing the times and distances of the ILogicEntityRoutes.
IMultiWorkingHoursConstraintController	getMultiWorkingHoursConstraintController() Gets the IMultiWorkingHoursConstraintController which controls the costs for violating IConstraints or IWorkingHours.
List<IOptimizationElement>	getNoneOptimizableElements() Gets all the IOptimizationElements that will not be optimized anymore because they are in the past for example.
List<IOptimizationElement>	getOptimizableElements() Gets all IOptimizationElement of all ILogicEntityRoutes.
IRelationshipController	getRelationshipController() Gets the IRelationshipController, containing the map with the INode2NodeRelations.
Map<IResource,Integer>	getResourceFirstOccurenceAbsoluteIndexMap()
ILogicEntityRoute	getRoute(int index) Gets the ILogicEntityRoute according to the index.
int	getRouteCount() Gets the current number of Routes.
ListIterator<ILogicEntityRoute>	getRouteIterator() Gets the route iterator.
List<ILogicEntityRoute>	getRoutes() Gets the whole list of ILogicEntityRoutes.
List<ILogicEntityRoute>	getRoutesByResource(IResource res)
List<ILogicEntityRoute>	getRoutesContainingElementId(String elementId)
List<ILogicEntityRoute>	getRoutesContainingElementId(String elementId, boolean ignoreStartEnd)
Optional<ILogicEntityRoute>	getRoutesContainingElementId(String elementId, String visitor, boolean ignoreStartEnd)
List<IViolationSummary>	getRouteViolationSummaries() Gets the all of the IViolations in the IEntity and summarizes them in an IViolationSummary.
int	getTotalRoutesDistinctElementsCount() Gets the number of all IOptimizationElement.
int	getTotalRoutesOptimizableElementsCount() Gets the total number of IOptimizationElements within the ILogicEntityRoutes.
boolean	hasNode(String nodeId) Checks if a INode or IPIllarNode contains the input Id.
boolean	hasResource(String resourceId) Check if a IResource contains the input Id.
boolean	isUnassessed() Checks whether the IEntity is unassessed, the default value is true.
IEntity	partialCopy(List<ILogicEntityRoute> routes2BeCopied) Returns an IEntity in which only the input ILogicEntityRoutes are actual copies, the rest of the IEntity consists of references to the original Object.
IEntity	partialCopyExchangeExistingRoute(ILogicEntityRoute existingRouteOrg, ILogicEntityRoute existingRouteReplace)
void	removeRoute(ILogicEntityRoute remRoute) Removes an ILogicEntityRoute from an IEntity.
void	removeRoute(int index) Removes an ILogicEntityRoute from an IEntity by the index number.
void	setEntityArranger(com.dna.jopt.framework.firstentitycreation.IEntityArranger entityArranger) Sets the IEntityArranger.
void	setEntityCostAndViolationController(IEntityCostAndViolationController controller) Sets the IEntityCostAndViolationController responsible for internal cost and IViolations.
void	setEntityInvokedOperatorController(IEntityInvokedOperatorController opc) Sets the IEntityInvokedOperatorController which holds information on cost advantage of the last used Operator etc.
void	setIsRequestAllRoutesElementDetails(boolean requestAllElementDetails) Sets the resultrequested value of all ILogicEntityRoutes.
void	setIsUnassessed(boolean isUnassessed) Sets the unassessed status.
void	setJoinedCost(double cost) Sets the joined cost which is the accumulated sum of internal cost of all IlogicEntityRoutes of the IEntity.
void	setJoinedDetailController(IJoinedEntityDetailController joinedDetailController) Sets the IJoinedEntityDetailController which is assessing the times and distances of the ILogicEntityRoutes.
void	setMultiWorkingHoursConstraintController(IMultiWorkingHoursConstraintController controller) Sets the IMultiWorkingHoursConstraintController which controls the costs for violating IConstraints or IWorkingHours.
void	setRelationShipController(IRelationshipController relationshipController) Sets the IRelationshipController, containing the map with the INode2NodeRelation.
void	setRoutes(List<ILogicEntityRoute> routes) Sets the input ILogicEntityRoute as the ILogicEntityRoutes of an IEntity .
String	toOverviewResult() Prints the result of the IOptimization with the number of ILogicEntityRoute, number of IOptimizationElement, total time, distance, idle time etc.
String	toString() Returns a String representing the IEntity object.
String	toString(boolean showNonSchedudledRoutes)
void	updateJointEntityBaseValueWithOwnRoutes() Instantiates a new IJoinedEntityDetailController and adds the values of all ILogicEntityRoute that were not unassigned.
void	updateJointEntityBaseValueWithRoute(ILogicEntityRoute route) Adds the value of distance, idle time, productive time, transit time etc of the input ILogicEntityRoute to the IJoinedEntityDetailController of the IEntity.

Method Detail

getRouteIterator

ListIterator<ILogicEntityRoute> getRouteIterator()

Gets the route iterator.

Returns:

the route iterator

addRoute

void addRoute(ILogicEntityRoute logicRoute)

Adds an ILogicEntityRoute.

Parameters:

logicRoute - the route

getRouteCount

int getRouteCount()

Gets the current number of Routes.

Returns:

the route count

See Also:

addRoute(ILogicEntityRoute)

getTotalRoutesOptimizableElementsCount

int getTotalRoutesOptimizableElementsCount()

Gets the total number of IOptimizationElements within the ILogicEntityRoutes.

Returns:

the total route element count

getRoute

ILogicEntityRoute getRoute(int index)

Gets the ILogicEntityRoute according to the index.

Parameters:

index - the int index

Returns:

the iLogicEntityRoute route

getRoutes

List<ILogicEntityRoute> getRoutes()

Gets the whole list of ILogicEntityRoutes.

Returns:

all the routes in the IEntity

copy

IEntity copy()

Copies the current IEntity.

Returns:

the copy of the IEntity

setRoutes

void setRoutes(List<ILogicEntityRoute> routes)

Sets the input ILogicEntityRoute as the ILogicEntityRoutes of an IEntity . This method should ONLY be used for copy/clone. In addition this method is not adapting the tutorEntity automatically. This has to be done externally.

Parameters:

routes - the iLogicEntityRoutes that are copied to the copy of the IEntity

removeRoute

void removeRoute(ILogicEntityRoute remRoute)

Removes an ILogicEntityRoute from an IEntity.

Parameters:

remRoute - the route to remove

removeRoute

void removeRoute(int index)

Removes an ILogicEntityRoute from an IEntity by the index number.

Parameters:

index - the int index

toString

String toString()

Returns a String representing the IEntity object.

Some information is given on the ILogicEntityRoutes like the productive time and the idle time.

Overrides:

toString in class Object

Returns:

the string representation

getJoinedDetailController

IJoinedEntityDetailController getJoinedDetailController()

Gets the IJoinedEntityDetailController which is assessing the times and distances of the ILogicEntityRoutes.

Returns:

the IJoinedEntityDetailController

setJoinedDetailController

void setJoinedDetailController(IJoinedEntityDetailController joinedDetailController)

Sets the IJoinedEntityDetailController which is assessing the times and distances of the ILogicEntityRoutes.

Parameters:

joinedDetailController - the iJoinedEntityDetailController to set

getRouteViolationSummaries

List<IViolationSummary> getRouteViolationSummaries()

Gets the all of the IViolations in the IEntity and summarizes them in an IViolationSummary.

Returns:

the summarized IViolations

setEntityArranger

void setEntityArranger(com.dna.jopt.framework.firstentitycreation.IEntityArranger entityArranger)

Sets the IEntityArranger.

Parameters:

entityArranger - the iEntityArranger

getEntityArranger

com.dna.jopt.framework.firstentitycreation.IEntityArranger getEntityArranger()

Gets the IEntityArranger, responsible for creating a hard constraints free IEntity.

Returns:

the IEntityArranger

getEntityCostAndViolationController

IEntityCostAndViolationController getEntityCostAndViolationController()

Gets the IEntityCostAndViolationController, responsible for internal cost and IViolations.

Returns:

the IEntityCostAndViolationController

setEntityCostAndViolationController

void setEntityCostAndViolationController(IEntityCostAndViolationController controller)

Sets the IEntityCostAndViolationController responsible for internal cost and IViolations.

Parameters:

controller - the iEntityCostAndViolationController

setJoinedCost

void setJoinedCost(double cost)

Sets the joined cost which is the accumulated sum of internal cost of all IlogicEntityRoutes of the IEntity.

Parameters:

cost - the double internal costs of the whole IEntity

getJoinedCost

double getJoinedCost()

Gets the joined cost which is the accumulated sum of internal cost of all IlogicEntityRoutes of the IEntity.

Returns:

the total of internal costs of the IEntity

getAllEntityElements

List<IOptimizationElement> getAllEntityElements()

Gets all IOptimizationElements of the IEntity.

Returns:

all IOptimizationElements

getNoneOptimizableElements

List<IOptimizationElement> getNoneOptimizableElements()

Gets all the IOptimizationElements that will not be optimized anymore because they are in the past for example.

Returns:

the list of noneOptimizableElements

getOptimizableElements

List<IOptimizationElement> getOptimizableElements()

Gets all IOptimizationElement of all ILogicEntityRoutes.

Returns:

all optimizable Elements

getAllRoutesElements

List<IOptimizationElement> getAllRoutesElements(String resourceId)

Gets all IOptimizationElements Ids who's visiting resource id equal to the input String.

Parameters:

resourceId - the string to search for

Returns:

the search results containing the input

hasResource

boolean hasResource(String resourceId)

Check if a IResource contains the input Id.

Parameters:

resourceId - the string Id to search for

Returns:

true if a Resource containing this Id exists

hasNode

boolean hasNode(String nodeId)

Checks if a INode or IPIllarNode contains the input Id.

Parameters:

nodeId - the string Id to search for

Returns:

true if any of the Elements contains the Id

addRoute

void addRoute(int index,
              ILogicEntityRoute logicRoute)

Adds a ILogicEntityRoute at the index position, shifting the Route at that position to the right and updating all indexes

Parameters:

index - the int index which the Route will have

logicRoute - the iLogicEntityRoute to add

setIsRequestAllRoutesElementDetails

void setIsRequestAllRoutesElementDetails(boolean requestAllElementDetails)

Sets the resultrequested value of all ILogicEntityRoutes. If set to true the ILogicRouteElementDetailItems are getting saved.

Parameters:

requestAllElementDetails - the boolean to set

partialCopy

IEntity partialCopy(List<ILogicEntityRoute> routes2BeCopied)

Returns an IEntity in which only the input ILogicEntityRoutes are actual copies, the rest of the IEntity consists of references to the original Object. This shallow copy allows to make modifications to the respective Routes of an IEntity while demanding less performance than a full copy.

Parameters:

routes2BeCopied - the iLogicEntityRoutes which are copied

Returns:

an Object containing references to the original IEntity while the input Routes are copies

exchangeExistingRouteWithClone

ILogicEntityRoute exchangeExistingRouteWithClone(ILogicEntityRoute existingRoute)

Replaces the input ILogicEntityRoute with a clone within the Entity.

Parameters:

existingRoute - the iLogicEntityRoute that is replaced with a copy

Returns:

the cloned ILogicEntityRoute

exchangeExistingRoutesWithClones

List<ILogicEntityRoute> exchangeExistingRoutesWithClones(List<ILogicEntityRoute> existingRoutes)

Replaces the input ILogicEntityRoutes with clones within the Solution.

Parameters:

existingRoutes - the iLogicEntityRoutes that are replaced with a copy

Returns:

the copied list of the input

exchangeExistingRouteWithExistingRoute

boolean exchangeExistingRouteWithExistingRoute(ILogicEntityRoute existingRouteOrg,
                                               ILogicEntityRoute existingRouteReplace)

Replaces an ILogicEntityRoute with another ILogicEntityRoute in all the Entities.

This is used in lockdown.

Parameters:

existingRouteOrg - the iLogicEntityRoute to replace

existingRouteReplace - the ILogicEntityRoute that will be put in its stead

Returns:

true if the operation was successful

getTotalRoutesDistinctElementsCount

int getTotalRoutesDistinctElementsCount()

Gets the number of all IOptimizationElement.

Returns:

the number of Elements in all the Route

toOverviewResult

String toOverviewResult()

Prints the result of the IOptimization with the number of ILogicEntityRoute, number of IOptimizationElement, total time, distance, idle time etc.

Returns:

an overview of the result

getRelationshipController

IRelationshipController getRelationshipController()

Gets the IRelationshipController, containing the map with the INode2NodeRelations.

Returns:

details on the relationship

setRelationShipController

void setRelationShipController(IRelationshipController relationshipController)

Sets the IRelationshipController, containing the map with the INode2NodeRelation.

Parameters:

relationshipController - the iRelationshipController to set

getEntityInvokedOperatorController

IEntityInvokedOperatorController getEntityInvokedOperatorController()

Gets the IEntityInvokedOperatorController.

Returns:

the IEntityInvokedOperatorController which holds information on cost advantage of the last Operator etc.

setEntityInvokedOperatorController

void setEntityInvokedOperatorController(IEntityInvokedOperatorController opc)

Sets the IEntityInvokedOperatorController which holds information on cost advantage of the last used Operator etc.

Parameters:

opc - the iEntityInvokedOperatorController

getFirstMatchingRoute

Optional<ILogicEntityRoute> getFirstMatchingRoute(INode node)

Gets the first ILogicEntityRoute in the Entity which contains the input INode.

Parameters:

node - the iNode to look for

Returns:

the first found Route containing the Node

getFirstMatchingRoute

Optional<ILogicEntityRoute> getFirstMatchingRoute(String nodeId)

Returns the first ILogicEntityRoute in which the INode or IPillarNode with the input nodeId was found.

Parameters:

nodeId - the string Id of the Node to look for.

Returns:

the Route in which the Node or Pillar was found.

getAnchoredRoutes

List<ILogicEntityRoute> getAnchoredRoutes()

Returns all ILogicEntityRoute with anchorNodes, which are essentially IPillarNodes overwriting the start or end of a Route.

Returns:

the list of Routes with anchorNodes

updateJointEntityBaseValueWithRoute

void updateJointEntityBaseValueWithRoute(ILogicEntityRoute route)

Adds the value of distance, idle time, productive time, transit time etc of the input ILogicEntityRoute to the IJoinedEntityDetailController of the IEntity.

Parameters:

route - the iLogicEntityRoute of which the values should be added

updateJointEntityBaseValueWithOwnRoutes

void updateJointEntityBaseValueWithOwnRoutes()

Instantiates a new IJoinedEntityDetailController and adds the values of all ILogicEntityRoute that were not unassigned.

setMultiWorkingHoursConstraintController

void setMultiWorkingHoursConstraintController(IMultiWorkingHoursConstraintController controller)

Sets the IMultiWorkingHoursConstraintController which controls the costs for violating IConstraints or IWorkingHours.

Parameters:

controller - the iMultiWorkingHoursConstraintController to set

getMultiWorkingHoursConstraintController

IMultiWorkingHoursConstraintController getMultiWorkingHoursConstraintController()

Gets the IMultiWorkingHoursConstraintController which controls the costs for violating IConstraints or IWorkingHours.

Returns:

the IMultiWorkingHoursConstraintController

setIsUnassessed

void setIsUnassessed(boolean isUnassessed)

Sets the unassessed status.

Being marked as unassessed means that this Object will have to go through assessment again. For complete solutions the ILogicEntityRoutes and all IEntities have to be assessed. When an INode is shifted from one Route to another by an IOperator the respective Routes and Entity need to be marked as unassessed in order to get assessed again updating their costs since they might have changed. An Entity also needs to be set as unassessed when setIsRequestAllRoutesElementDetails(boolean) is set to true. By doing this the Routes will automatically be set to unassessed since they need to go through a new assessment in order to save the ILogicRouteElementDetailItem

Parameters:

isUnassessed - the boolean to set

isUnassessed

boolean isUnassessed()

Checks whether the IEntity is unassessed, the default value is true.

Returns:

the set value

partialCopyExchangeExistingRoute

IEntity partialCopyExchangeExistingRoute(ILogicEntityRoute existingRouteOrg,
                                         ILogicEntityRoute existingRouteReplace)

toString

String toString(boolean showNonSchedudledRoutes)

getResourceFirstOccurenceAbsoluteIndexMap

Map<IResource,Integer> getResourceFirstOccurenceAbsoluteIndexMap()

getRoutesByResource

List<ILogicEntityRoute> getRoutesByResource(IResource res)

getRoutesContainingElementId

List<ILogicEntityRoute> getRoutesContainingElementId(String elementId)

getElement

Optional<IOptimizationElement> getElement(String id)

getBuildTimeStamp

long getBuildTimeStamp()

getElement

Optional<IOptimizationElement> getElement(String id,
                                          boolean ignoreStartEnd)

getRoutesContainingElementId

List<ILogicEntityRoute> getRoutesContainingElementId(String elementId,
                                                     boolean ignoreStartEnd)

getRoutesContainingElementId

Optional<ILogicEntityRoute> getRoutesContainingElementId(String elementId,
                                                         String visitor,
                                                         boolean ignoreStartEnd)