Package org.ivoa.dm.executionbroker

Class IntegerValueOption

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

  • Field Details

    • min

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

    • max

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

    • units

      @VoDml(id="execbroker:IntegerValueOption.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

    • IntegerValueOption

      public IntegerValueOption()
      Creates a new IntegerValueOption

    • IntegerValueOption

      public IntegerValueOption(Integer min, Integer max, String units, String kind, String path)
      full parameter constructor.
      Parameters:
      min - The minimum value that can be set.
      max - The maximum value that can be set.
      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.

    • IntegerValueOption

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

    • IntegerValueOption

      public IntegerValueOption(AbstractOption superinstance, Integer min, Integer max, String units)
      Constructor from supertype instance.
      Parameters:
      superinstance - The supertype.
      min - The minimum value that can be set.
      max - The maximum value that can be set.
      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(IntegerValueOption 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 IntegerValueOption withMin(Integer pMin)
      fluent setter for min Attribute.
      Parameters:
      pMin - value to set
      Returns:
      IntegerValueOption

    • 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 IntegerValueOption withMax(Integer pMax)
      fluent setter for max Attribute.
      Parameters:
      pMax - value to set
      Returns:
      IntegerValueOption

    • 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 IntegerValueOption withUnits(String pUnits)
      fluent setter for units Attribute.
      Parameters:
      pUnits - value to set
      Returns:
      IntegerValueOption

    • createIntegerValueOption

      public static IntegerValueOption createIntegerValueOption(Consumer<IntegerValueOption.IntegerValueOptionBuilder> f)
      create a IntegerValueOption 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