Interface IViolation

All Superinterfaces:
Cloneable, Serializable
All Known Implementing Classes:
Violation
public interface IViolation extends Serializable, Cloneable
This interface IViolations describes behavior the Optimizer is supposed to avoid like Resources being too late, Nodes not being skipped etc. These Violations are being listed after an optimization run.
Since:
30/09/2019
Version:
30/09/2019
Author:
DNA

  • Method Details

    • getCategory

      String getCategory()
      Gets the category.
      Returns:
      the category

    • getAttribute

      String getAttribute()
      Gets the attribute.
      Returns:
      the attribute

    • setValue

      void setValue(String valueDesc, String violationValue)
      Sets the value.
      Parameters:
      valueDesc - the value desc
      violationValue - the violation value

    • setValue

      default void setValue(String valueDescPrefix, double violationValue)
      Sets a numeric value. The description is valueDescPrefix followed by the number and the violation value is the number alone, both as written by Double.toString(double): the same as setValue(valueDescPrefix + violationValue, String.valueOf(violationValue)). An implementation may build the two texts only when they are read.
      Parameters:
      valueDescPrefix - the text in front of the number in the description
      violationValue - the violation value

    • getValue

      String getValue()
      Deprecated.
      Gets the value.
      Returns:
      the value

    • getViolationDescription

      String getViolationDescription()
      Gets the violation description.
      Returns:
      the violation description

    • getCode

      int getCode()
      Gets the code that is identifying this IViolation
      Returns:
      the code

    • toString

      String toString()
      Returns the category, the attribute, the value and the violationValue. If Violation.getViolationActors() is not empty adds all the ids of all current actors.
      Overrides:
      toString in class Object
      Returns:
      category, attribute, value and id of all actors

    • getViolationValue

      String getViolationValue()
      Gets the Violation.violationValue, the default value is "".
      Returns:
      the violationvalue

    • copy

      IViolation copy()
      Returns a new Violation with the values of Violation.getCategory(), Violation.getAttribute(), Violation.getValue() and Violation.getCode().
      Returns:
      a copy of the Violation with the category, attribute, value and code

    • setViolationActors

      void setViolationActors(List<IOptimizationElement> elements)
      Gets the Violation.violationActors.
      Parameters:
      elements - the arrayList containing IOptimizationElements

    • getViolationActors

      List<IOptimizationElement> getViolationActors()
      Gets the Violation.violationActors.
      Returns:
      the arraylist violationActors containing IOptimizationElements

    • setViolationActorRoutes

      void setViolationActorRoutes(List<ILogicEntityRoute> routes)
      Sets the routes, which are triggering the violation.
      Parameters:
      routes - the new violation actor routes

    • getViolationActorRoutes

      List<ILogicEntityRoute> getViolationActorRoutes()
      Gets the routes, which are triggering the violation. This method may return an empty list even though violations are present
      Returns:
      the violation actor routes

    • getSubAttribute

      String getSubAttribute()
      Gets the Violation.subAttribute.
      Returns:
      the subAttribute

    • setViolationTriggerClassInfo

      void setViolationTriggerClassInfo(Optional<com.dna.jopt.config.types.ConstraintClassInfo> triggerClassinfo)
      Sets the violation trigger class title. If for example a constraint is triggering the violation, the underlying ident of the constraint class might be provided
      Parameters:
      triggerClassinfo - the new violation trigger class info

    • getViolationTriggerClassInfo

      Optional<com.dna.jopt.config.types.ConstraintClassInfo> getViolationTriggerClassInfo()
      Gets the violation trigger class title. If for example a constraint is triggering the violation, the underlying ident of the constraint class might be provided
      Returns:
      the violation trigger class title