Package org.ivoa.dm.caom2

Class Provenance

java.lang.Object
org.ivoa.dm.caom2.Provenance
All Implemented Interfaces:
org.ivoa.vodml.jpa.JPAManipulations, org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
@Entity @VoDml(id="caom2:Provenance", role=objectType) public class Provenance extends Object implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
description of how this data was produced. objectType: Provenance

  • Field Details

    • _id

      protected Long _id
      inserted database key

    • name

      @VoDml(id="caom2:Provenance.name", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String name
      collection-specific common name of the process. : Attribute name : multiplicity 1

    • reference

      @VoDml(id="caom2:Provenance.reference", role=attribute, type="ivoa:anyURI", typeRole=primitiveType) protected String reference
      identifier for external resource with proposal details. : Attribute reference : multiplicity 0..1

    • version

      @VoDml(id="caom2:Provenance.version", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String version
      version of the software or process that produced the data. : Attribute version : multiplicity 0..1

    • project

      @VoDml(id="caom2:Provenance.project", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String project
      name of the project that produced the data; data produced in a uniform way are typically labelled with the same project name. : Attribute project : multiplicity 0..1

    • producer

      @VoDml(id="caom2:Provenance.producer", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String producer
      common name of the entity (person, institute, etc) responsible for producing the data. : Attribute producer : multiplicity 0..1

    • runID

      @VoDml(id="caom2:Provenance.runID", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String runID
      collection-specific identifier for the processing instance that produced the data; this identifier can typcially be traced in log files or logging systems. : Attribute runID : multiplicity 0..1

    • lastExecuted

      @VoDml(id="caom2:Provenance.lastExecuted", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String lastExecuted
      timestamp describing when this process last ran and produced data. : Attribute lastExecuted : multiplicity 0..1

    • keywords

      @VoDml(id="caom2:Provenance.keywords", role=attribute, type="ivoa:string", typeRole=primitiveType) protected List<String> keywords
      additional keywords that describe the processing; this may include both general descriptive words and those specific to this particular execution of the processing; keywords cannot contain the pipe (|) character - it is reserved for use in persistence systems (e.g. to store all keywords in a single column in a table). : Attribute keywords : multiplicity 0..*

    • inputs

      @VoDml(id="caom2:Provenance.inputs", role=attribute, type="ivoa:anyURI", typeRole=primitiveType) protected List<String> inputs
      local identifier for input planes; these are the actual inputs that went into the product. : Attribute inputs : multiplicity 0..*

  • Constructor Details

    • Provenance

      public Provenance()
      Creates a new Provenance

    • Provenance

      public Provenance(String name, String reference, String version, String project, String producer, String runID, String lastExecuted, List<String> keywords, List<String> inputs)
      full parameter constructor.
      Parameters:
      name - collection-specific common name of the process.
      reference - identifier for external resource with proposal details.
      version - version of the software or process that produced the data.
      project - name of the project that produced the data; data produced in a uniform way are typically labelled with the same project name.
      producer - common name of the entity (person, institute, etc) responsible for producing the data.
      runID - collection-specific identifier for the processing instance that produced the data; this identifier can typcially be traced in log files or logging systems.
      lastExecuted - timestamp describing when this process last ran and produced data.
      keywords - additional keywords that describe the processing; this may include both general descriptive words and those specific to this particular execution of the processing; keywords cannot contain the pipe (|) character - it is reserved for use in persistence systems (e.g. to store all keywords in a single column in a table).
      inputs - local identifier for input planes; these are the actual inputs that went into the product.

    • Provenance

      public Provenance(Provenance 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(Provenance 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 Provenance withName(String pName)
      fluent setter for name Attribute.
      Parameters:
      pName - value to set
      Returns:
      Provenance

    • getReference

      public String getReference()
      Returns reference Attribute.
      Returns:
      reference Attribute

    • setReference

      public void setReference(String pReference)
      Set reference Attribute.
      Parameters:
      pReference - value to set

    • withReference

      public Provenance withReference(String pReference)
      fluent setter for reference Attribute.
      Parameters:
      pReference - value to set
      Returns:
      Provenance

    • 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 Provenance withVersion(String pVersion)
      fluent setter for version Attribute.
      Parameters:
      pVersion - value to set
      Returns:
      Provenance

    • getProject

      public String getProject()
      Returns project Attribute.
      Returns:
      project Attribute

    • setProject

      public void setProject(String pProject)
      Set project Attribute.
      Parameters:
      pProject - value to set

    • withProject

      public Provenance withProject(String pProject)
      fluent setter for project Attribute.
      Parameters:
      pProject - value to set
      Returns:
      Provenance

    • getProducer

      public String getProducer()
      Returns producer Attribute.
      Returns:
      producer Attribute

    • setProducer

      public void setProducer(String pProducer)
      Set producer Attribute.
      Parameters:
      pProducer - value to set

    • withProducer

      public Provenance withProducer(String pProducer)
      fluent setter for producer Attribute.
      Parameters:
      pProducer - value to set
      Returns:
      Provenance

    • getRunID

      public String getRunID()
      Returns runID Attribute.
      Returns:
      runID Attribute

    • setRunID

      public void setRunID(String pRunID)
      Set runID Attribute.
      Parameters:
      pRunID - value to set

    • withRunID

      public Provenance withRunID(String pRunID)
      fluent setter for runID Attribute.
      Parameters:
      pRunID - value to set
      Returns:
      Provenance

    • getLastExecuted

      public String getLastExecuted()
      Returns lastExecuted Attribute.
      Returns:
      lastExecuted Attribute

    • setLastExecuted

      public void setLastExecuted(String pLastExecuted)
      Set lastExecuted Attribute.
      Parameters:
      pLastExecuted - value to set

    • withLastExecuted

      public Provenance withLastExecuted(String pLastExecuted)
      fluent setter for lastExecuted Attribute.
      Parameters:
      pLastExecuted - value to set
      Returns:
      Provenance

    • 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 Provenance withKeywords(List<String> pKeywords)
      fluent setter for keywords Attribute.
      Parameters:
      pKeywords - value to set
      Returns:
      Provenance

    • getInputs

      public List<String> getInputs()
      Returns inputs Attribute.
      Returns:
      inputs Attribute

    • setInputs

      public void setInputs(List<String> pInputs)
      Set inputs Attribute.
      Parameters:
      pInputs - value to set

    • withInputs

      public Provenance withInputs(List<String> pInputs)
      fluent setter for inputs Attribute.
      Parameters:
      pInputs - value to set
      Returns:
      Provenance

    • createProvenance

      public static Provenance createProvenance(Consumer<Provenance.ProvenanceBuilder> f)
      create a Provenance 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>