com.dna.jopt.member.unit

Class AbstractOptimizationElement

java.lang.Object

com.dna.jopt.member.unit.AbstractOptimizationElement

All Implemented Interfaces:

IOptimizationElement, Serializable

Direct Known Subclasses:

AbstractBasicCapacityResource, AbstractNode

public abstract class AbstractOptimizationElement
extends Object
implements IOptimizationElement

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.dna.jopt.member.unit.IOptimizationElement

IOptimizationElement.OptimizationElementFlavour

Field Summary

Fields

Modifier and Type	Field and Description
protected List<IDutyHours>	dutyHours

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractOptimizationElement()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
void	forceSetId(String id) Force set a new Id after construction of the element if absolutely necessary.
Optional<String>	getConstraintAliasId() Gets the constraint alias id.
int	getDistMatrixId() Deprecated.
List<IDutyHours>	getDutyHours() Gets the IDutyHours of the element.
Optional<String>	getExtraInfo() Gets the extra info.
String	getId() Gets the unique id.
double	getLatitude() Gets the latitude of the element.
String	getLocationId() Gets the location id.
double	getLongitude() Gets the longitude of the element.
INodeConnectorItem	getNodeConnection(IOptimizationElement toElement) Gets the node connection from this element to another element.
Set<IOptimizationElement>	getNodeConnectionKeySet() Gets the node connection key set.
List<INodeConnectorItem>	getNodeConnections() Gets the list of node connections seen by this element.
com.dna.jopt.config.types.Position	getPosition()
IPreferredHoursInteractionController	getPreferredHoursInteractionController()
int	hashCode()
void	putNodeConnection(IOptimizationElement toElement, INodeConnectorItem conncetorItem) Deprecated.
void	putNodeConnectionFromElement(INodeConnectorItem conncetorItem) Put a new node connection from this element to another element.
void	removeNodeConnection(IOptimizationElement toElement) Removes a node connection.
void	setConstraintAliasId(String constraintAliasId) Sets the constraint alias id.
void	setDistMatrixId(int matrixId) Deprecated.
void	setDutyHours(List<? extends IDutyHours> dutyHours) Sets the duty hours.
void	setExtraInfo(String extraInfo) Sets a custom extra info.
void	setId(String id) Sets the unique id.
void	setLatitude(double latitude) Sets the latitude of the element.
void	setLocationId(String locationId) Sets the location id.
void	setLongitude(double longitude) Sets the longitude of the element.
void	setPosition(com.dna.jopt.config.types.Position position)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.dna.jopt.member.unit.IOptimizationElement

getFlavour, hasRealGeoLocation

Field Detail

dutyHours

protected List<IDutyHours> dutyHours

Constructor Detail

AbstractOptimizationElement

protected AbstractOptimizationElement()

Method Detail

getId

public String getId()

Description copied from interface: IOptimizationElement

Gets the unique id.

Specified by:

getId in interface IOptimizationElement

Returns:

the id

setId

public void setId(String id)

Description copied from interface: IOptimizationElement

Sets the unique id. By default this value is provided on construction.

Specified by:

setId in interface IOptimizationElement

Parameters:

id - the new id

forceSetId

public void forceSetId(String id)

Description copied from interface: IOptimizationElement

Force set a new Id after construction of the element if absolutely necessary. Usually the id should be set on construction.

Specified by:

forceSetId in interface IOptimizationElement

Parameters:

id - the id

setLocationId

public void setLocationId(String locationId)

Description copied from interface: IOptimizationElement

Sets the location id. A location id does not need to be unique. Moreover, the more elements can share the same locations id the better, as less connections need to be created. For elements the same location id, means they have the same geographical position.

Specified by:

setLocationId in interface IOptimizationElement

Parameters:

locationId - the new location id

getConstraintAliasId

public Optional<String> getConstraintAliasId()

Description copied from interface: IOptimizationElement

Gets the constraint alias id.

Specified by:

getConstraintAliasId in interface IOptimizationElement

Returns:

the constraint alias id

setConstraintAliasId

public void setConstraintAliasId(String constraintAliasId)

Description copied from interface: IOptimizationElement

Sets the constraint alias id. For example, a constraint requires the resource Jane. However, Jane is split into multiple resources. Let's assume, those ids are Jane_Morning, Jane_Noon and so on. Now, we can simply set the constraintAliasId for all resources to be "Jane". The constraint, now treats all the resources the same.

Specified by:

setConstraintAliasId in interface IOptimizationElement

Parameters:

constraintAliasId - the new constraint alias id

setExtraInfo

public void setExtraInfo(String extraInfo)

Description copied from interface: IOptimizationElement

Sets a custom extra info. For example, use JSON to encode your custom data.

Specified by:

setExtraInfo in interface IOptimizationElement

Parameters:

extraInfo - the new extra info

getExtraInfo

public Optional<String> getExtraInfo()

Description copied from interface: IOptimizationElement

Gets the extra info.

Specified by:

getExtraInfo in interface IOptimizationElement

Returns:

the extra info

getLocationId

public String getLocationId()

Description copied from interface: IOptimizationElement

Gets the location id. In case no location id was defined, the mandatory unique id is used as location id.

Specified by:

getLocationId in interface IOptimizationElement

Returns:

the location id

setPosition

public void setPosition(com.dna.jopt.config.types.Position position)

Specified by:

setPosition in interface IOptimizationElement

getPosition

public com.dna.jopt.config.types.Position getPosition()

Specified by:

getPosition in interface IOptimizationElement

setLatitude

public void setLatitude(double latitude)

Description copied from interface: IOptimizationElement

Sets the latitude of the element.

Specified by:

setLatitude in interface IOptimizationElement

Parameters:

latitude - the new latitude

getLatitude

public double getLatitude()

Description copied from interface: IOptimizationElement

Gets the latitude of the element.

Specified by:

getLatitude in interface IOptimizationElement

Returns:

the latitude

setLongitude

public void setLongitude(double longitude)

Description copied from interface: IOptimizationElement

Sets the longitude of the element.

Specified by:

setLongitude in interface IOptimizationElement

Parameters:

longitude - the new longitude

getLongitude

public double getLongitude()

Description copied from interface: IOptimizationElement

Gets the longitude of the element.

Specified by:

getLongitude in interface IOptimizationElement

Returns:

the longitude

setDutyHours

public void setDutyHours(List<? extends IDutyHours> dutyHours)

Description copied from interface: IOptimizationElement

Sets the duty hours.

Attention: Make sure that each Resource/Node has its own independent list of WorkingHours/OpeningHours (WorkingHours and OpeningHours are both derived from DutyHours). Further, make sure that each WorkingHour Object/ OpeningHours Object is also unique and is not shared in the List of another Resource/Node.

Specified by:

setDutyHours in interface IOptimizationElement

Parameters:

dutyHours - the new duty hours

getPreferredHoursInteractionController

public IPreferredHoursInteractionController getPreferredHoursInteractionController()

Specified by:

getPreferredHoursInteractionController in interface IOptimizationElement

getDutyHours

public List<IDutyHours> getDutyHours()

Description copied from interface: IOptimizationElement

Gets the IDutyHours of the element.

Specified by:

getDutyHours in interface IOptimizationElement

Returns:

the duty hours

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getNodeConnection

public INodeConnectorItem getNodeConnection(IOptimizationElement toElement)

Description copied from interface: IOptimizationElement

Gets the node connection from this element to another element. During the optimization connections gathered from the INodeEdgeConnector are saved also in the element. This speeds up the optimization as frequently seen connections can be directly extracted from the element instead of invoking a table lookup in the INodeEdgeConnector.

Specified by:

getNodeConnection in interface IOptimizationElement

Parameters:

toElement - the end element of the connection

Returns:

the node connection or null if not present

getNodeConnections

public List<INodeConnectorItem> getNodeConnections()

Description copied from interface: IOptimizationElement

Gets the list of node connections seen by this element.

Specified by:

getNodeConnections in interface IOptimizationElement

Returns:

the node connections

putNodeConnectionFromElement

public void putNodeConnectionFromElement(INodeConnectorItem conncetorItem)

Description copied from interface: IOptimizationElement

Put a new node connection from this element to another element.

Specified by:

putNodeConnectionFromElement in interface IOptimizationElement

Parameters:

conncetorItem - the new found INodeConnectorItem

putNodeConnection

@Deprecated
public void putNodeConnection(IOptimizationElement toElement,
                                          INodeConnectorItem conncetorItem)

Deprecated.

Description copied from interface: IOptimizationElement

Deprecated method.

Put node connection.

Specified by:

putNodeConnection in interface IOptimizationElement

Parameters:

toElement - the to element

conncetorItem - the conncetor item

removeNodeConnection

public void removeNodeConnection(IOptimizationElement toElement)

Description copied from interface: IOptimizationElement

Removes a node connection. This method is most often used to clean up connections which are not in use any longer.

Specified by:

removeNodeConnection in interface IOptimizationElement

Parameters:

toElement - the to element

getNodeConnectionKeySet

public Set<IOptimizationElement> getNodeConnectionKeySet()

Description copied from interface: IOptimizationElement

Gets the node connection key set.

Specified by:

getNodeConnectionKeySet in interface IOptimizationElement

Returns:

the node connection key set

setDistMatrixId

@Deprecated
public void setDistMatrixId(int matrixId)

Deprecated.

Description copied from interface: IOptimizationElement

Sets the dist matrix id.

Specified by:

setDistMatrixId in interface IOptimizationElement

Parameters:

matrixId - the new dist matrix id

getDistMatrixId

@Deprecated
public int getDistMatrixId()

Deprecated.

Description copied from interface: IOptimizationElement

Gets the dist matrix id.

Specified by:

getDistMatrixId in interface IOptimizationElement

Returns:

the dist matrix id