Package org.ivoa.dm.caom2

Class Provenance.ProvenanceBuilder

java.lang.Object
org.ivoa.dm.caom2.Provenance.ProvenanceBuilder
Enclosing class:
Provenance
public static class Provenance.ProvenanceBuilder extends Object
A builder class for Provenance, mainly for use in the functional builder pattern.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    List<String>
    inputs
    local identifier for input planes; these are the actual inputs that went into the product.
    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.
    String
    lastExecuted
    timestamp describing when this process last ran and produced data.
    String
    name
    collection-specific common name of the process.
    String
    producer
    common name of the entity (person, institute, etc) responsible for producing the data.
    String
    project
    name of the project that produced the data; data produced in a uniform way are typically labelled with the same project name.
    String
    reference
    identifier for external resource with proposal details.
    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.
    String
    version
    version of the software or process that produced the data.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ProvenanceBuilder()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Provenance
    create()
    create a Provenance from this builder.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • name

      public String name
      collection-specific common name of the process.

    • reference

      public String reference
      identifier for external resource with proposal details.

    • version

      public String version
      version of the software or process that produced the data.

    • project

      public String project
      name of the project that produced the data; data produced in a uniform way are typically labelled with the same project name.

    • producer

      public String producer
      common name of the entity (person, institute, etc) responsible for producing the data.

    • runID

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

    • lastExecuted

      public String lastExecuted
      timestamp describing when this process last ran and produced data.

    • keywords

      public 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).

    • inputs

      public List<String> inputs
      local identifier for input planes; these are the actual inputs that went into the product.

  • Constructor Details

    • ProvenanceBuilder

      public ProvenanceBuilder()

  • Method Details

    • create

      public Provenance create()
      create a Provenance from this builder.
      Returns:
      an object initialized from the builder.