Package org.ivoa.dm.executionbroker

Class IntegerDeltaOption

java.lang.Object
org.ivoa.dm.executionbroker.AbstractOption
org.ivoa.dm.executionbroker.IntegerDeltaOption
All Implemented Interfaces:
org.ivoa.vodml.jpa.JPAManipulations, org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
@Entity @VoDml(id="execbroker:IntegerDeltaOption", role=objectType) public class IntegerDeltaOption extends AbstractOption implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
A simple integer delta option. This option enables the client to increment or decrement an integer value pointed to by the path. objectType: IntegerDeltaOption

  • Field Details

    • min

      @VoDml(id="execbroker:IntegerDeltaOption.min", role=attribute, type="ivoa:integer", typeRole=primitiveType) protected Integer min
      The minimum change that can be applied. : Attribute min : multiplicity 1

    • max

      @VoDml(id="execbroker:IntegerDeltaOption.max", role=attribute, type="ivoa:integer", typeRole=primitiveType) protected Integer max
      The maximum change that can be applied. : Attribute max : multiplicity 1

    • units

      @VoDml(id="execbroker:IntegerDeltaOption.units", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String units
      The units used for the maximum and minimum values and the default units used for the update. The client may specify different units in the update if they need to. : Attribute units : multiplicity 1

  • Constructor Details

    • IntegerDeltaOption

      public IntegerDeltaOption()
      Creates a new IntegerDeltaOption

    • IntegerDeltaOption

      public IntegerDeltaOption(Integer min, Integer max, String units, String kind, String path)
      full parameter constructor.
      Parameters:
      min - The minimum change that can be applied.
      max - The maximum change that can be applied.
      units - The units used for the maximum and minimum values and the default units used for the update. The client may specify different units in the update if they need to.
      kind - The kind of option.
      path - The path this option applies to.

    • IntegerDeltaOption

      public IntegerDeltaOption(IntegerDeltaOption other)
      Copy Constructor. Note that references will remain as is rather than be copied.
      Parameters:
      other - the object to be copied.

    • IntegerDeltaOption

      public IntegerDeltaOption(AbstractOption superinstance, Integer min, Integer max, String units)
      Constructor from supertype instance.
      Parameters:
      superinstance - The supertype.
      min - The minimum change that can be applied.
      max - The maximum change that can be applied.
      units - The units used for the maximum and minimum values and the default units used for the update. The client may specify different units in the update if they need to.

  • Method Details

    • copyMe

      public AbstractOption copyMe()
      make a clone of the object taking into account current polymorhic type.
      Overrides:
      copyMe in class AbstractOption
      Returns:
      the cloned object.

    • updateUsing

      public void updateUsing(IntegerDeltaOption other)
      Update this object with the content of the given object. Note that references will remain as is rather than be copied.
      Parameters:
      other - the object to be copied.

    • getMin

      public Integer getMin()
      Returns min Attribute.
      Returns:
      min Attribute

    • setMin

      public void setMin(Integer pMin)
      Set min Attribute.
      Parameters:
      pMin - value to set

    • withMin

      public IntegerDeltaOption withMin(Integer pMin)
      fluent setter for min Attribute.
      Parameters:
      pMin - value to set
      Returns:
      IntegerDeltaOption

    • getMax

      public Integer getMax()
      Returns max Attribute.
      Returns:
      max Attribute

    • setMax

      public void setMax(Integer pMax)
      Set max Attribute.
      Parameters:
      pMax - value to set

    • withMax

      public IntegerDeltaOption withMax(Integer pMax)
      fluent setter for max Attribute.
      Parameters:
      pMax - value to set
      Returns:
      IntegerDeltaOption

    • getUnits

      public String getUnits()
      Returns units Attribute.
      Returns:
      units Attribute

    • setUnits

      public void setUnits(String pUnits)
      Set units Attribute.
      Parameters:
      pUnits - value to set

    • withUnits

      public IntegerDeltaOption withUnits(String pUnits)
      fluent setter for units Attribute.
      Parameters:
      pUnits - value to set
      Returns:
      IntegerDeltaOption

    • createIntegerDeltaOption

      public static IntegerDeltaOption createIntegerDeltaOption(Consumer<IntegerDeltaOption.IntegerDeltaOptionBuilder> f)
      create a IntegerDeltaOption in functional builder style.
      Parameters:
      f - the functional builder.
      Returns:
      an object initialized from the builder.

    • forceLoad

      public void forceLoad()
      Specified by:
      forceLoad in interface org.ivoa.vodml.jpa.JPAManipulations
      Overrides:
      forceLoad in class AbstractOption

    • delete

      public void delete(jakarta.persistence.EntityManager em)
      Specified by:
      delete in interface org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
      Overrides:
      delete in class AbstractOption