Package org.ivoa.dm.execution

Class ParameterValue

java.lang.Object
org.ivoa.dm.execution.ParameterValue
All Implemented Interfaces:
org.ivoa.vodml.jpa.JPAManipulations, org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
@Entity @VoDml(id="execution:ParameterValue", role=objectType) public class ParameterValue extends Object implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
the value of a parameter for a job execution. objectType: ParameterValue

  • Field Details

    • _id

      protected Long _id
      inserted database key

    • definition

      @VoDml(id="execution:ParameterValue.definition", role=reference, type="pdl:ParameterDefinition", typeRole=objectType) protected ParameterDefinition definition
      ReferenceObject definition : the definition of the parameter. ( Multiplicity : 1 )

    • value

      @VoDml(id="execution:ParameterValue.value", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String value
      the value of the parameter - this is intentionally very flexible to allow for different types of parameters - e.g. atomic values, files, etc. : Attribute value type ivoa:string : multiplicity 1

    • isIndirect

      @VoDml(id="execution:ParameterValue.isIndirect", role=attribute, type="ivoa:boolean", typeRole=primitiveType) protected Boolean isIndirect
      whether the value is an indirect reference to the actual value - e.g. a file path or a URL. : Attribute isIndirect type ivoa:boolean : multiplicity 1

  • Constructor Details

    • ParameterValue

      public ParameterValue()
      Creates a new ParameterValue

    • ParameterValue

      public ParameterValue(ParameterDefinition definition, String value, Boolean isIndirect)
      full parameter constructor.
      Parameters:
      definition - the definition of the parameter.
      value - the value of the parameter - this is intentionally very flexible to allow for different types of parameters - e.g. atomic values, files, etc.
      isIndirect - whether the value is an indirect reference to the actual value - e.g. a file path or a URL.

    • ParameterValue

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

  • Method Details

    • getId

      public Long getId()
      Specified by:
      getId in interface org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
      Returns:
      the id

    • updateClonedReferences

      public void updateClonedReferences()
      updates any cloned references that are contained within the hierarchy.

    • updateUsing

      public void updateUsing(ParameterValue 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.

    • getDefinition

      public ParameterDefinition getDefinition()
      Returns definition Reference
      Returns:
      definition Reference

    • setDefinition

      public void setDefinition(ParameterDefinition pDefinition)
      Defines definition Reference
      Parameters:
      pDefinition - reference to set

    • getValue

      public String getValue()
      Returns value Attribute.
      Returns:
      value Attribute

    • setValue

      public void setValue(String pValue)
      Set value Attribute.
      Parameters:
      pValue - value to set

    • withValue

      public ParameterValue withValue(String pValue)
      fluent setter for value Attribute.
      Parameters:
      pValue - value to set
      Returns:
      ParameterValue

    • getIsIndirect

      public Boolean getIsIndirect()
      Returns isIndirect Attribute.
      Returns:
      isIndirect Attribute

    • setIsIndirect

      public void setIsIndirect(Boolean pIsIndirect)
      Set isIndirect Attribute.
      Parameters:
      pIsIndirect - value to set

    • withIsIndirect

      public ParameterValue withIsIndirect(Boolean pIsIndirect)
      fluent setter for isIndirect Attribute.
      Parameters:
      pIsIndirect - value to set
      Returns:
      ParameterValue

    • createParameterValue

      public static ParameterValue createParameterValue(Consumer<ParameterValue.ParameterValueBuilder> f)
      create a ParameterValue 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

    • delete

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