Package org.ivoa.dm.pdl

Class ParameterDefinition

java.lang.Object
org.ivoa.dm.pdl.ParameterDefinition
All Implemented Interfaces:
org.ivoa.vodml.jaxb.XmlIdManagement, org.ivoa.vodml.jpa.JPAManipulations, org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
@Entity @VoDml(id="pdl:ParameterDefinition", role=objectType) public class ParameterDefinition extends Object implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>, org.ivoa.vodml.jaxb.XmlIdManagement
the definition of a parameter. objectType: ParameterDefinition

  • Field Details

    • _id

      protected Long _id
      inserted database key

    • name

      @VoDml(id="pdl:ParameterDefinition.name", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String name
      Parameter name. : Attribute name type ivoa:string : multiplicity 1

    • description

      @VoDml(id="pdl:ParameterDefinition.description", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String description
      Parameter description. : Attribute description type ivoa:string : multiplicity 0..1

    • kind

      @VoDml(id="pdl:ParameterDefinition.kind", role=attribute, type="pdl:ParameterType", typeRole=dataType) protected ParameterType kind
      the type of the parameter. : Attribute kind type pdl:ParameterType : multiplicity 1

    • semantics

      @VoDml(id="pdl:ParameterDefinition.semantics", role=attribute, type="pdl:ParameterSemantics", typeRole=dataType) protected ParameterSemantics semantics
      . : Attribute semantics type pdl:ParameterSemantics : multiplicity 0..1

  • Constructor Details

    • ParameterDefinition

      public ParameterDefinition()
      Creates a new ParameterDefinition

    • ParameterDefinition

      public ParameterDefinition(String name, String description, ParameterType kind, ParameterSemantics semantics)
      full parameter constructor.
      Parameters:
      name - Parameter name.
      description - Parameter description.
      kind - the type of the parameter.
      semantics - .

    • ParameterDefinition

      public ParameterDefinition(ParameterDefinition 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

    • getXmlId

      public String getXmlId()
      getter for XMLID
      Specified by:
      getXmlId in interface org.ivoa.vodml.jaxb.XmlIdManagement

    • setXmlId

      public void setXmlId(String id)
      Specified by:
      setXmlId in interface org.ivoa.vodml.jaxb.XmlIdManagement

    • hasNaturalKey

      public boolean hasNaturalKey()
      Specified by:
      hasNaturalKey in interface org.ivoa.vodml.jaxb.XmlIdManagement

    • updateUsing

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

    • getName

      public String getName()
      Returns name Attribute.
      Returns:
      name Attribute

    • setName

      public void setName(String pName)
      Set name Attribute.
      Parameters:
      pName - value to set

    • withName

      public ParameterDefinition withName(String pName)
      fluent setter for name Attribute.
      Parameters:
      pName - value to set
      Returns:
      ParameterDefinition

    • getDescription

      public String getDescription()
      Returns description Attribute.
      Returns:
      description Attribute

    • setDescription

      public void setDescription(String pDescription)
      Set description Attribute.
      Parameters:
      pDescription - value to set

    • withDescription

      public ParameterDefinition withDescription(String pDescription)
      fluent setter for description Attribute.
      Parameters:
      pDescription - value to set
      Returns:
      ParameterDefinition

    • getKind

      public ParameterType getKind()
      Returns kind Attribute.
      Returns:
      kind Attribute

    • setKind

      public void setKind(ParameterType pKind)
      Set kind Attribute.
      Parameters:
      pKind - value to set

    • withKind

      public ParameterDefinition withKind(ParameterType pKind)
      fluent setter for kind Attribute.
      Parameters:
      pKind - value to set
      Returns:
      ParameterDefinition

    • getSemantics

      public ParameterSemantics getSemantics()
      Returns semantics Attribute.
      Returns:
      semantics Attribute

    • setSemantics

      public void setSemantics(ParameterSemantics pSemantics)
      Set semantics Attribute.
      Parameters:
      pSemantics - value to set

    • withSemantics

      public ParameterDefinition withSemantics(ParameterSemantics pSemantics)
      fluent setter for semantics Attribute.
      Parameters:
      pSemantics - value to set
      Returns:
      ParameterDefinition

    • createParameterDefinition

      public static ParameterDefinition createParameterDefinition(Consumer<ParameterDefinition.ParameterDefinitionBuilder> f)
      create a ParameterDefinition 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>