Package org.ivoa.dm.registry.standard

Class StandardKey

java.lang.Object
org.ivoa.dm.registry.standard.StandardKey
All Implemented Interfaces:
org.ivoa.vodml.jpa.JPAManipulations, org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
@Entity @VoDml(id="StandardsRegExt:StandardKey", role=objectType) public class StandardKey extends Object implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
The name and definition of a key--a named concept, feature, or property. This key can be identified via an IVOA identifier of the form ivo://authority/resource#name where name is the value of the child name element. This type can be extended if the key has other metadata associated with it. objectType: StandardKey

  • Field Details

    • _id

      protected Long _id
      inserted database key

    • name

      @VoDml(id="StandardsRegExt:StandardKey.name", role=attribute, type="StandardsRegExt:fragment", typeRole=primitiveType) protected Fragment name
      The property identifier which would appear as the fragment (string after the pound sign, #) in an IVOA identifier. : Attribute name : multiplicity 1

    • description

      @VoDml(id="StandardsRegExt:StandardKey.description", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String description
      A human-readable definition of this property. : Attribute description : multiplicity 1

  • Constructor Details

    • StandardKey

      public StandardKey()
      Creates a new StandardKey

    • StandardKey

      public StandardKey(Fragment name, String description)
      full parameter constructor.
      Parameters:
      name - The property identifier which would appear as the fragment (string after the pound sign, #) in an IVOA identifier.
      description - A human-readable definition of this property.

    • StandardKey

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

    • updateUsing

      public void updateUsing(StandardKey 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 Fragment getName()
      Returns name Attribute.
      Returns:
      name Attribute

    • setName

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

    • withName

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

    • 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 StandardKey withDescription(String pDescription)
      fluent setter for description Attribute.
      Parameters:
      pDescription - value to set
      Returns:
      StandardKey

    • createStandardKey

      public static StandardKey createStandardKey(Consumer<StandardKey.StandardKeyBuilder> f)
      create a StandardKey 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>