Package org.ivoa.dm.tool

Class Discovery

java.lang.Object
org.ivoa.dm.tool.Discovery
All Implemented Interfaces:
org.ivoa.vodml.jpa.JPAManipulations, org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
@Entity @VoDml(id="tool:Discovery", role=objectType) public class Discovery extends Object implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
Discovery metadata mapped to OCI labels/annotations. objectType: Discovery

  • Field Details

    • _id

      protected Long _id
      inserted database key

    • imageTitle

      @VoDml(id="tool:Discovery.imageTitle", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String imageTitle
      Human-readable title (schema field: title). : Attribute imageTitle type ivoa:string : multiplicity 1

    • description

      @VoDml(id="tool:Discovery.description", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String description
      Human-readable description (1..255 chars). : Attribute description type ivoa:string : multiplicity 1

    • source

      @VoDml(id="tool:Discovery.source", role=attribute, type="ivoa:anyURI", typeRole=primitiveType) protected String source
      Source code URL. : Attribute source type ivoa:anyURI : multiplicity 1

    • url

      @VoDml(id="tool:Discovery.url", role=attribute, type="ivoa:anyURI", typeRole=primitiveType) protected String url
      Project URL . : Attribute url type ivoa:anyURI : multiplicity 0..1

    • documentation

      @VoDml(id="tool:Discovery.documentation", role=attribute, type="ivoa:anyURI", typeRole=primitiveType) protected String documentation
      Documentation URL . : Attribute documentation type ivoa:anyURI : multiplicity 0..1

    • version

      @VoDml(id="tool:Discovery.version", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String version
      Packaged software version. : Attribute version type ivoa:string : multiplicity 1

    • revision

      @VoDml(id="tool:Discovery.revision", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String revision
      Source control revision; default unknown. : Attribute revision type ivoa:string : multiplicity 0..1

    • created

      @VoDml(id="tool:Discovery.created", role=attribute, type="ivoa:datetime", typeRole=primitiveType) protected Date created
      Metadata processing timestamp (UTC). : Attribute created type ivoa:datetime : multiplicity 0..1

    • authors

      @VoDml(id="tool:Discovery.authors", role=reference, type="tool:Author", typeRole=objectType) protected List<Author> authors
      ReferenceObject authors : Responsible people/organization. ( Multiplicity : 1..* )

    • licenses

      @VoDml(id="tool:Discovery.licenses", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String licenses
      SPDX license expression. : Attribute licenses type ivoa:string : multiplicity 1

    • keywords

      @VoDml(id="tool:Discovery.keywords", role=attribute, type="ivoa:string", typeRole=primitiveType) protected List<String> keywords
      Discovery/search keywords. : Attribute keywords type ivoa:string : multiplicity 0..*

    • domain

      @VoDml(id="tool:Discovery.domain", role=attribute, type="ivoa:string", typeRole=primitiveType) protected List<String> domain
      Scientific domains; default astronomy; min_length=1. : Attribute domain type ivoa:string : multiplicity 1..*

    • kind

      @VoDml(id="tool:Discovery.kind", role=attribute, type="ivoa:string", typeRole=primitiveType) protected List<String> kind
      . : Attribute kind type ivoa:string : multiplicity 1..*

    • tools

      @VoDml(id="tool:Discovery.tools", role=attribute, type="ivoa:string", typeRole=primitiveType) protected List<String> tools
      Scientific software packages included. : Attribute tools type ivoa:string : multiplicity 0..*

    • isBase

      @VoDml(id="tool:Discovery.isBase", role=attribute, type="ivoa:boolean", typeRole=primitiveType) protected Boolean isBase
      Whether this is a certified base image that should be used as a parent image for derived images. : Attribute isBase type ivoa:boolean : multiplicity 1

    • deprecated

      @VoDml(id="tool:Discovery.deprecated", role=attribute, type="ivoa:boolean", typeRole=primitiveType) protected Boolean deprecated
      Deprecation status; default false. : Attribute deprecated type ivoa:boolean : multiplicity 0..1

  • Constructor Details

    • Discovery

      public Discovery()
      Creates a new Discovery

    • Discovery

      public Discovery(String imageTitle, String description, String source, String url, String documentation, String version, String revision, Date created, List<Author> authors, String licenses, List<String> keywords, List<String> domain, List<String> kind, List<String> tools, Boolean isBase, Boolean deprecated)
      full parameter constructor.
      Parameters:
      imageTitle - Human-readable title (schema field: title).
      description - Human-readable description (1..255 chars).
      source - Source code URL.
      url - Project URL .
      documentation - Documentation URL .
      version - Packaged software version.
      revision - Source control revision; default unknown.
      created - Metadata processing timestamp (UTC).
      authors - Responsible people/organization.
      licenses - SPDX license expression.
      keywords - Discovery/search keywords.
      domain - Scientific domains; default astronomy; min_length=1.
      kind - .
      tools - Scientific software packages included.
      isBase - Whether this is a certified base image that should be used as a parent image for derived images.
      deprecated - Deprecation status; default false.

    • Discovery

      public Discovery(Discovery 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(Discovery 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.

    • getImageTitle

      public String getImageTitle()
      Returns imageTitle Attribute.
      Returns:
      imageTitle Attribute

    • setImageTitle

      public void setImageTitle(String pImageTitle)
      Set imageTitle Attribute.
      Parameters:
      pImageTitle - value to set

    • withImageTitle

      public Discovery withImageTitle(String pImageTitle)
      fluent setter for imageTitle Attribute.
      Parameters:
      pImageTitle - value to set
      Returns:
      Discovery

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

    • getSource

      public String getSource()
      Returns source Attribute.
      Returns:
      source Attribute

    • setSource

      public void setSource(String pSource)
      Set source Attribute.
      Parameters:
      pSource - value to set

    • withSource

      public Discovery withSource(String pSource)
      fluent setter for source Attribute.
      Parameters:
      pSource - value to set
      Returns:
      Discovery

    • getUrl

      public String getUrl()
      Returns url Attribute.
      Returns:
      url Attribute

    • setUrl

      public void setUrl(String pUrl)
      Set url Attribute.
      Parameters:
      pUrl - value to set

    • withUrl

      public Discovery withUrl(String pUrl)
      fluent setter for url Attribute.
      Parameters:
      pUrl - value to set
      Returns:
      Discovery

    • getDocumentation

      public String getDocumentation()
      Returns documentation Attribute.
      Returns:
      documentation Attribute

    • setDocumentation

      public void setDocumentation(String pDocumentation)
      Set documentation Attribute.
      Parameters:
      pDocumentation - value to set

    • withDocumentation

      public Discovery withDocumentation(String pDocumentation)
      fluent setter for documentation Attribute.
      Parameters:
      pDocumentation - value to set
      Returns:
      Discovery

    • getVersion

      public String getVersion()
      Returns version Attribute.
      Returns:
      version Attribute

    • setVersion

      public void setVersion(String pVersion)
      Set version Attribute.
      Parameters:
      pVersion - value to set

    • withVersion

      public Discovery withVersion(String pVersion)
      fluent setter for version Attribute.
      Parameters:
      pVersion - value to set
      Returns:
      Discovery

    • getRevision

      public String getRevision()
      Returns revision Attribute.
      Returns:
      revision Attribute

    • setRevision

      public void setRevision(String pRevision)
      Set revision Attribute.
      Parameters:
      pRevision - value to set

    • withRevision

      public Discovery withRevision(String pRevision)
      fluent setter for revision Attribute.
      Parameters:
      pRevision - value to set
      Returns:
      Discovery

    • getCreated

      public Date getCreated()
      Returns created Attribute.
      Returns:
      created Attribute

    • setCreated

      public void setCreated(Date pCreated)
      Set created Attribute.
      Parameters:
      pCreated - value to set

    • withCreated

      public Discovery withCreated(Date pCreated)
      fluent setter for created Attribute.
      Parameters:
      pCreated - value to set
      Returns:
      Discovery

    • getAuthors

      public List<Author> getAuthors()
      Returns authors Reference
      Returns:
      authors Reference

    • setAuthors

      public void setAuthors(List<Author> pAuthors)
      Defines authors Reference
      Parameters:
      pAuthors - references to set

    • getLicenses

      public String getLicenses()
      Returns licenses Attribute.
      Returns:
      licenses Attribute

    • setLicenses

      public void setLicenses(String pLicenses)
      Set licenses Attribute.
      Parameters:
      pLicenses - value to set

    • withLicenses

      public Discovery withLicenses(String pLicenses)
      fluent setter for licenses Attribute.
      Parameters:
      pLicenses - value to set
      Returns:
      Discovery

    • getKeywords

      public List<String> getKeywords()
      Returns keywords Attribute.
      Returns:
      keywords Attribute

    • setKeywords

      public void setKeywords(List<String> pKeywords)
      Set keywords Attribute.
      Parameters:
      pKeywords - value to set

    • withKeywords

      public Discovery withKeywords(List<String> pKeywords)
      fluent setter for keywords Attribute.
      Parameters:
      pKeywords - value to set
      Returns:
      Discovery

    • getDomain

      public List<String> getDomain()
      Returns domain Attribute.
      Returns:
      domain Attribute

    • setDomain

      public void setDomain(List<String> pDomain)
      Set domain Attribute.
      Parameters:
      pDomain - value to set

    • withDomain

      public Discovery withDomain(List<String> pDomain)
      fluent setter for domain Attribute.
      Parameters:
      pDomain - value to set
      Returns:
      Discovery

    • getKind

      public List<String> getKind()
      Returns kind Attribute.
      Returns:
      kind Attribute

    • setKind

      public void setKind(List<String> pKind)
      Set kind Attribute.
      Parameters:
      pKind - value to set

    • withKind

      public Discovery withKind(List<String> pKind)
      fluent setter for kind Attribute.
      Parameters:
      pKind - value to set
      Returns:
      Discovery

    • getTools

      public List<String> getTools()
      Returns tools Attribute.
      Returns:
      tools Attribute

    • setTools

      public void setTools(List<String> pTools)
      Set tools Attribute.
      Parameters:
      pTools - value to set

    • withTools

      public Discovery withTools(List<String> pTools)
      fluent setter for tools Attribute.
      Parameters:
      pTools - value to set
      Returns:
      Discovery

    • getIsBase

      public Boolean getIsBase()
      Returns isBase Attribute.
      Returns:
      isBase Attribute

    • setIsBase

      public void setIsBase(Boolean pIsBase)
      Set isBase Attribute.
      Parameters:
      pIsBase - value to set

    • withIsBase

      public Discovery withIsBase(Boolean pIsBase)
      fluent setter for isBase Attribute.
      Parameters:
      pIsBase - value to set
      Returns:
      Discovery

    • getDeprecated

      public Boolean getDeprecated()
      Returns deprecated Attribute.
      Returns:
      deprecated Attribute

    • setDeprecated

      public void setDeprecated(Boolean pDeprecated)
      Set deprecated Attribute.
      Parameters:
      pDeprecated - value to set

    • withDeprecated

      public Discovery withDeprecated(Boolean pDeprecated)
      fluent setter for deprecated Attribute.
      Parameters:
      pDeprecated - value to set
      Returns:
      Discovery

    • createDiscovery

      public static Discovery createDiscovery(Consumer<Discovery.DiscoveryBuilder> f)
      create a Discovery 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>