IRelationshipController (JOpt Java Core 7.5.0-rc1 API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

RelationshipController
```
public interface IRelationshipController
extends Serializable
```
The Interface IRelationshipController.

Since:

27/09/2019

Version:

16/04/2023

Author:

Jens Richter

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addRelationShipCost(double addCost)` Adds the `relationship cost` to the already existing `relationship cost`.
`void`	`addRelationShipDetails(ILogicRouteElementDetailItem details)` Adds the input `ILogicRouteElementDetailItem` on the `RelationshipController.node2DetailsPersistendMap` as well as on the `RelationshipController.node2DetailsMap`.
`IRelationshipController`	`copy()` Returns a copy of the `IRelationshipController`.
`Map<IOptimizationElement,ILogicRouteElementDetailItem>`	`getPersistendRelationShipDetailMap()` Gets the persistent map with the `IOptimizationElement` and the `ILogicRouteElementDetailItem`.
`Map<INode2NodeRelation,RelationShipCostItem>`	`getRelation2CostItemMap()` Gets the map containing all `INode2NodeRelations` and the linked `cost`
`double`	`getRelationShipCost()` Gets the `relationship cost`.
`Map<IOptimizationElement,ILogicRouteElementDetailItem>`	`getRelationShipDetailMap()` Gets the `map` with the `IOptimizationElements` and the `ILogicRouteElementDetailItems`.
`Optional<ILogicRouteElementDetailItem>`	`getRelationShipDetails(IOptimizationElement el)` Gets the `Optional` `ILogicRouteElementDetailItem`.
`IRelationshipController`	`partialCopy()` Returns a copy of the `IRelationshipController`.
`void`	`putRelation2CostItem(INode2NodeRelation rel, RelationShipCostItem cost)` Puts a cost of a certain `INode2NodeRelation` in the map.
`void`	`setPersistentRelationShipDetailMap(Map<IOptimizationElement,ILogicRouteElementDetailItem> map)` Sets the persistent map with the `IOptimizationElement` and the `ILogicRouteElementDetailItem`.
`void`	`setRelation2CostItemMap(Map<INode2NodeRelation,RelationShipCostItem> map)` Sets the `INode2NodeRelation` to `cost` item map.
`void`	`setRelationShipCost(double cost)` Sets the relationship cost.
`void`	`setRelationShipDetailMap(Map<IOptimizationElement,ILogicRouteElementDetailItem> map)` Sets the map with the `IOptimizationElement` and the `ILogicRouteElementDetailItem`.

- Method Detail
  - putRelation2CostItem
```
void putRelation2CostItem(INode2NodeRelation rel,
                          RelationShipCostItem cost)
```
    Puts a cost of a certain INode2NodeRelation in the map.
    
    Parameters:
    
    rel - the iNode2NodeRelation
    
    cost - the double cost
  - getRelation2CostItemMap
```
Map<INode2NodeRelation,RelationShipCostItem> getRelation2CostItemMap()
```
    Gets the map containing all INode2NodeRelations and the linked cost
    
    Returns:
    
    the relation to cost item map
  - setRelation2CostItemMap
```
void setRelation2CostItemMap(Map<INode2NodeRelation,RelationShipCostItem> map)
```
    Sets the INode2NodeRelation to cost item map.
    
    Parameters:
    
    map - the map to set
  - setRelationShipCost
```
void setRelationShipCost(double cost)
```
    Sets the relationship cost.
    
    Parameters:
    
    cost - the double new relation ship cost
  - addRelationShipCost
```
void addRelationShipCost(double addCost)
```
    Adds the relationship cost to the already existing relationship cost.
    
    Parameters:
    
    addCost - the double cost to add
  - getRelationShipCost
```
double getRelationShipCost()
```
    Gets the relationship cost.
    
    Returns:
    
    the relation ship cost
  - copy
```
IRelationshipController copy()
```
    Returns a copy of the IRelationshipController.
    
    Returns:
    
    the copy
  - addRelationShipDetails
```
void addRelationShipDetails(ILogicRouteElementDetailItem details)
```
    Adds the input ILogicRouteElementDetailItem on the RelationshipController.node2DetailsPersistendMap as well as on the RelationshipController.node2DetailsMap.
    
    Parameters:
    
    details - the iLogicRouteElementDetailItem to add
  - getRelationShipDetails
```
Optional<ILogicRouteElementDetailItem> getRelationShipDetails(IOptimizationElement el)
```
    Gets the Optional ILogicRouteElementDetailItem.
    If the RelationshipController.node2DetailsMap is empty returns RelationshipController.node2DetailsPersistendMap.
    
    Parameters:
    
    el - the iLogicRouteElementDetailItem of the ILogicRouteElementDetailItem
    
    Returns:
    
    the map
  - getRelationShipDetailMap
```
Map<IOptimizationElement,ILogicRouteElementDetailItem> getRelationShipDetailMap()
```
    Gets the map with the IOptimizationElements and the ILogicRouteElementDetailItems.
    
    Returns:
    
    the map
  - setRelationShipDetailMap
```
void setRelationShipDetailMap(Map<IOptimizationElement,ILogicRouteElementDetailItem> map)
```
    Sets the map with the IOptimizationElement and the ILogicRouteElementDetailItem.
    
    Parameters:
    
    map - the map to set
  - getPersistendRelationShipDetailMap
```
Map<IOptimizationElement,ILogicRouteElementDetailItem> getPersistendRelationShipDetailMap()
```
    Gets the persistent map with the IOptimizationElement and the ILogicRouteElementDetailItem.
    
    Returns:
    
    the map
  - setPersistentRelationShipDetailMap
```
void setPersistentRelationShipDetailMap(Map<IOptimizationElement,ILogicRouteElementDetailItem> map)
```
    Sets the persistent map with the IOptimizationElement and the ILogicRouteElementDetailItem.
    
    Parameters:
    
    map - the map to set
  - partialCopy
```
IRelationshipController partialCopy()
```
    Returns a copy of the IRelationshipController.
    
    Returns:
    
    the controller

Interface IRelationshipController

Method Summary

Method Detail

putRelation2CostItem

getRelation2CostItemMap

setRelation2CostItemMap

setRelationShipCost

addRelationShipCost

getRelationShipCost

copy

addRelationShipDetails

getRelationShipDetails

getRelationShipDetailMap

setRelationShipDetailMap

getPersistendRelationShipDetailMap

setPersistentRelationShipDetailMap

partialCopy