Record Class InputMetricDescriptor

java.lang.Object
java.lang.Record
ai.timefold.solver.service.definition.internal.descriptor.InputMetricDescriptor
public record InputMetricDescriptor(String id, String name, String description, DataFormat type, Integer priority, String example, String exampleFormatted) extends Record
Defines InputMetric of the model where information is retrieved from ModelInputMetric class of the model
  • id - usually the field of the class representing given InputMetric
  • name - human readable name
  • description - human readable description of the InputMetric
  • type - type of the InputMetric that provides information how to handle given InputMetric and what operations can be performed on it e.g. number, duration, distance_meters
  • priority - order in which InputMetric should be presented
  • example - value that this InputMetric can hold
  • exampleFormatted - example but formatted according to given type .e.g distance in meters can be presented in kilometers for better readability

  • Constructor Details

    • InputMetricDescriptor

      public InputMetricDescriptor(String id, String name, String description, DataFormat type, Integer priority, String example, String exampleFormatted)
      Creates an instance of a InputMetricDescriptor record class.
      Parameters:
      id - the value for the id record component
      name - the value for the name record component
      description - the value for the description record component
      type - the value for the type record component
      priority - the value for the priority record component
      example - the value for the example record component
      exampleFormatted - the value for the exampleFormatted record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • id

      public String id()
      Returns the value of the id record component.
      Returns:
      the value of the id record component

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • description

      public String description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component

    • type

      public DataFormat type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • priority

      public Integer priority()
      Returns the value of the priority record component.
      Returns:
      the value of the priority record component

    • example

      public String example()
      Returns the value of the example record component.
      Returns:
      the value of the example record component

    • exampleFormatted

      public String exampleFormatted()
      Returns the value of the exampleFormatted record component.
      Returns:
      the value of the exampleFormatted record component