Class DefaultProcessStep

All Implemented Interfaces:
Serializable, Emptiable, LenientComparable, IdentifiedObject, org.opengis.metadata.lineage.ProcessStep
Direct Known Subclasses:
LE_ProcessStep

@TitleProperty(name="description") public class DefaultProcessStep extends ISOMetadata implements org.opengis.metadata.lineage.ProcessStep
Information about an event or transformation in the life of a resource. Includes the process used to maintain the resource. The following property is mandatory in a well-formed metadata according ISO 19115:
LI_ProcessStep   └─description…… Description of the event, including related parameters or tolerances.

Limitations

  • Instances of this class are not synchronized for multi-threading. Synchronization, if needed, is caller's responsibility.
  • Serialized objects of this class are not guaranteed to be compatible with future Apache SIS releases. Serialization support is appropriate for short term storage or RMI between applications running the same version of Apache SIS. For long term storage, use XML instead.
Since:
0.3
Version:
1.0
See Also:
  • Nested Class Summary

    Nested classes/interfaces inherited from class org.apache.sis.metadata.ModifiableMetadata

    ModifiableMetadata.State
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private org.opengis.util.InternationalString
    Description of the event, including related parameters or tolerances.
    private Collection<org.opengis.metadata.lineage.Source>
    Description of the product generated as a result of the process step.
    private org.opengis.metadata.lineage.Processing
    Comprehensive information about the procedure by which the algorithm was applied to derive geographic data from the raw instrument measurements, such as datasets, software used, and the processing environment.
    private Collection<org.opengis.metadata.citation.ResponsibleParty>
    Identification of, and means of communication with, person(s) and organization(s) associated with the process step.
    private org.opengis.util.InternationalString
    Requirement or purpose for the process step.
    private Collection<org.opengis.metadata.citation.Citation>
    Process step documentation.
    private Collection<org.opengis.metadata.lineage.ProcessStepReport>
    Report generated by the process step.
    private org.opengis.metadata.quality.Scope
    Type of resource and / or extent to which the process step applies.
    private static final long
    Serial number for inter-operability with different versions.
    private Collection<org.opengis.metadata.lineage.Source>
    Information about the source data used in creating the data specified by the scope.
    private org.opengis.temporal.TemporalPrimitive
    Date, time or range of date and time over which the process step occurred.

    Fields inherited from class org.apache.sis.metadata.iso.ISOMetadata

    identifiers
  • Constructor Summary

    Constructors
    Constructor
    Description
    Creates an initially empty process step.
    Creates a process step initialized to the given description.
    DefaultProcessStep(org.opengis.metadata.lineage.ProcessStep object)
    Constructs a new instance initialized with the values from the specified metadata object.
  • Method Summary

    Modifier and Type
    Method
    Description
    castOrCopy(org.opengis.metadata.lineage.ProcessStep object)
    Returns a SIS metadata implementation with the values of the given arbitrary implementation.
    Deprecated.
    As of ISO 19115-1:2014, replaced by getStepDateTime().
    org.opengis.util.InternationalString
    Returns the description of the event, including related parameters or tolerances.
    Collection<org.opengis.metadata.lineage.Source>
    Returns the description of the product generated as a result of the process step.
    org.opengis.metadata.lineage.Processing
    Returns the comprehensive information about the procedure by which the algorithm was applied to derive geographic data from the raw instrument measurements, such as datasets, software used, and the processing environment.
    Collection<org.opengis.metadata.citation.ResponsibleParty>
    Returns the identification of, and means of communication with, person(s) and organization(s) associated with the process step.
    org.opengis.util.InternationalString
    Returns the requirement or purpose for the process step.
    private Collection<org.opengis.metadata.citation.Citation>
    Invoked by JAXB at both marshalling and unmarshalling time.
    Collection<org.opengis.metadata.citation.Citation>
    Returns the process step documentation.
    Collection<org.opengis.metadata.lineage.ProcessStepReport>
    Returns the report generated by the process step.
    org.opengis.metadata.quality.Scope
    Returns the type of resource and / or extent to which the process step applies.
    Collection<org.opengis.metadata.lineage.Source>
    Returns the information about the source data used in creating the data specified by the scope.
    org.opengis.temporal.TemporalPrimitive
    Returns the date, time or range of date and time over which the process step occurred.
    void
    setDate(Date newValue)
    Deprecated.
    As of ISO 19115-1:2014, replaced by setStepDateTime(TemporalPrimitive).
    void
    setDescription(org.opengis.util.InternationalString newValue)
    Sets the description of the event, including related parameters or tolerances.
    void
    setOutputs(Collection<? extends org.opengis.metadata.lineage.Source> newValues)
    Sets the description of the product generated as a result of the process step.
    void
    setProcessingInformation(org.opengis.metadata.lineage.Processing newValue)
    Sets the comprehensive information about the procedure by which the algorithm was applied to derive geographic data from the raw instrument measurements, such as datasets, software used, and the processing environment.
    void
    setProcessors(Collection<? extends org.opengis.metadata.citation.ResponsibleParty> newValues)
    Identification of, and means of communication with, person(s) and organization(s) associated with the process step.
    void
    setRationale(org.opengis.util.InternationalString newValue)
    Sets the requirement or purpose for the process step.
    void
    setReferences(Collection<? extends org.opengis.metadata.citation.Citation> newValues)
    Sets the process step documentation.
    void
    setReports(Collection<? extends org.opengis.metadata.lineage.ProcessStepReport> newValues)
    Sets the report generated by the process step.
    void
    setScope(org.opengis.metadata.quality.Scope newValue)
    Sets the type of resource and / or extent to which the process step applies.
    void
    setSources(Collection<? extends org.opengis.metadata.lineage.Source> newValues)
    Information about the source data used in creating the data specified by the scope.
    void
    setStepDateTime(org.opengis.temporal.TemporalPrimitive newValue)
    Sets the date, time or range of date and time over which the process step occurred.

    Methods inherited from class org.apache.sis.metadata.iso.ISOMetadata

    getIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionTo

    Methods inherited from class org.apache.sis.metadata.AbstractMetadata

    asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      Serial number for inter-operability with different versions.
      See Also:
    • description

      private org.opengis.util.InternationalString description
      Description of the event, including related parameters or tolerances.
    • rationale

      private org.opengis.util.InternationalString rationale
      Requirement or purpose for the process step.
    • stepDateTime

      private org.opengis.temporal.TemporalPrimitive stepDateTime
      Date, time or range of date and time over which the process step occurred.
    • processors

      private Collection<org.opengis.metadata.citation.ResponsibleParty> processors
      Identification of, and means of communication with, person(s) and organization(s) associated with the process step.
    • references

      private Collection<org.opengis.metadata.citation.Citation> references
      Process step documentation.
    • scope

      private org.opengis.metadata.quality.Scope scope
      Type of resource and / or extent to which the process step applies.
    • sources

      private Collection<org.opengis.metadata.lineage.Source> sources
      Information about the source data used in creating the data specified by the scope.
    • outputs

      private Collection<org.opengis.metadata.lineage.Source> outputs
      Description of the product generated as a result of the process step.
    • processingInformation

      private org.opengis.metadata.lineage.Processing processingInformation
      Comprehensive information about the procedure by which the algorithm was applied to derive geographic data from the raw instrument measurements, such as datasets, software used, and the processing environment.
    • reports

      private Collection<org.opengis.metadata.lineage.ProcessStepReport> reports
      Report generated by the process step.
  • Constructor Details

    • DefaultProcessStep

      public DefaultProcessStep()
      Creates an initially empty process step.
    • DefaultProcessStep

      public DefaultProcessStep(CharSequence description)
      Creates a process step initialized to the given description.
      Parameters:
      description - description of the event, including related parameters or tolerances.
    • DefaultProcessStep

      public DefaultProcessStep(org.opengis.metadata.lineage.ProcessStep object)
      Constructs a new instance initialized with the values from the specified metadata object. This is a shallow copy constructor, because the other metadata contained in the given object are not recursively copied.
      Parameters:
      object - the metadata to copy values from, or null if none.
      See Also:
  • Method Details

    • castOrCopy

      public static DefaultProcessStep castOrCopy(org.opengis.metadata.lineage.ProcessStep object)
      Returns a SIS metadata implementation with the values of the given arbitrary implementation. This method performs the first applicable action in the following choices:
      • If the given object is null, then this method returns null.
      • Otherwise if the given object is already an instance of DefaultProcessStep, then it is returned unchanged.
      • Otherwise a new DefaultProcessStep instance is created using the copy constructor and returned. Note that this is a shallow copy operation, because the other metadata contained in the given object are not recursively copied.
      Parameters:
      object - the object to get as a SIS implementation, or null if none.
      Returns:
      a SIS implementation containing the values of the given object (may be the given object itself), or null if the argument was null.
    • getDescription

      public org.opengis.util.InternationalString getDescription()
      Returns the description of the event, including related parameters or tolerances.
      Specified by:
      getDescription in interface org.opengis.metadata.lineage.ProcessStep
      Returns:
      description of the event, or null.
    • setDescription

      public void setDescription(org.opengis.util.InternationalString newValue)
      Sets the description of the event, including related parameters or tolerances.
      Parameters:
      newValue - the new description.
    • getRationale

      public org.opengis.util.InternationalString getRationale()
      Returns the requirement or purpose for the process step.
      Specified by:
      getRationale in interface org.opengis.metadata.lineage.ProcessStep
      Returns:
      requirement or purpose for the process step, or null.
    • setRationale

      public void setRationale(org.opengis.util.InternationalString newValue)
      Sets the requirement or purpose for the process step.
      Parameters:
      newValue - the new rationale.
    • getStepDateTime

      public org.opengis.temporal.TemporalPrimitive getStepDateTime()
      Returns the date, time or range of date and time over which the process step occurred.
      Returns:
      date, time or period over which the process step occurred, or null.
      Since:
      1.0
    • setStepDateTime

      public void setStepDateTime(org.opengis.temporal.TemporalPrimitive newValue)
      Sets the date, time or range of date and time over which the process step occurred.
      Parameters:
      newValue - the new date, time or period.
      Since:
      1.0
    • getDate

      @Deprecated public Date getDate()
      Deprecated.
      As of ISO 19115-1:2014, replaced by getStepDateTime().
      Returns the date and time or range of date and time on or over which the process step occurred.
      Specified by:
      getDate in interface org.opengis.metadata.lineage.ProcessStep
      Returns:
      date on or over which the process step occurred, or null.
    • setDate

      @Deprecated public void setDate(Date newValue)
      Deprecated.
      As of ISO 19115-1:2014, replaced by setStepDateTime(TemporalPrimitive).
      Sets the date and time or range of date and time on or over which the process step occurred.
      Parameters:
      newValue - the new date.
    • getProcessors

      public Collection<org.opengis.metadata.citation.ResponsibleParty> getProcessors()
      Returns the identification of, and means of communication with, person(s) and organization(s) associated with the process step.
      Upcoming API change — generalization
      As of ISO 19115:2014, ResponsibleParty is replaced by the Responsibility parent interface. This change may be applied in GeoAPI 4.0.
      Specified by:
      getProcessors in interface org.opengis.metadata.lineage.ProcessStep
      Returns:
      means of communication with person(s) and organization(s) associated with the process step.
    • setProcessors

      public void setProcessors(Collection<? extends org.opengis.metadata.citation.ResponsibleParty> newValues)
      Identification of, and means of communication with, person(s) and organization(s) associated with the process step.
      Upcoming API change — generalization
      As of ISO 19115:2014, ResponsibleParty is replaced by the Responsibility parent interface. This change may be applied in GeoAPI 4.0.
      Parameters:
      newValues - the new processors.
    • getReferences

      @UML(identifier="reference", obligation=OPTIONAL, specification=ISO_19115) public Collection<org.opengis.metadata.citation.Citation> getReferences()
      Returns the process step documentation.
      Returns:
      process step documentation.
      Since:
      0.5
    • setReferences

      public void setReferences(Collection<? extends org.opengis.metadata.citation.Citation> newValues)
      Sets the process step documentation.
      Parameters:
      newValues - the new documentation.
      Since:
      0.5
    • getScope

      @UML(identifier="scope", obligation=OPTIONAL, specification=ISO_19115) public org.opengis.metadata.quality.Scope getScope()
      Returns the type of resource and / or extent to which the process step applies.
      Returns:
      type of resource, or null if none.
      Since:
      0.5
    • setScope

      public void setScope(org.opengis.metadata.quality.Scope newValue)
      Sets the type of resource and / or extent to which the process step applies.
      Parameters:
      newValue - the new type of resource.
      Since:
      0.5
    • getSources

      public Collection<org.opengis.metadata.lineage.Source> getSources()
      Returns the information about the source data used in creating the data specified by the scope.
      Specified by:
      getSources in interface org.opengis.metadata.lineage.ProcessStep
      Returns:
      information about the source data used in creating the data.
    • setSources

      public void setSources(Collection<? extends org.opengis.metadata.lineage.Source> newValues)
      Information about the source data used in creating the data specified by the scope.
      Parameters:
      newValues - the new sources.
    • getOutputs

      public Collection<org.opengis.metadata.lineage.Source> getOutputs()
      Returns the description of the product generated as a result of the process step.
      Specified by:
      getOutputs in interface org.opengis.metadata.lineage.ProcessStep
      Returns:
      product generated as a result of the process step.
    • setOutputs

      public void setOutputs(Collection<? extends org.opengis.metadata.lineage.Source> newValues)
      Sets the description of the product generated as a result of the process step.
      Parameters:
      newValues - the new output values.
    • getProcessingInformation

      public org.opengis.metadata.lineage.Processing getProcessingInformation()
      Returns the comprehensive information about the procedure by which the algorithm was applied to derive geographic data from the raw instrument measurements, such as datasets, software used, and the processing environment.
      Specified by:
      getProcessingInformation in interface org.opengis.metadata.lineage.ProcessStep
      Returns:
      procedure by which the algorithm was applied to derive geographic data, or null.
    • setProcessingInformation

      public void setProcessingInformation(org.opengis.metadata.lineage.Processing newValue)
      Sets the comprehensive information about the procedure by which the algorithm was applied to derive geographic data from the raw instrument measurements, such as datasets, software used, and the processing environment.
      Parameters:
      newValue - the new processing information value.
    • getReports

      public Collection<org.opengis.metadata.lineage.ProcessStepReport> getReports()
      Returns the report generated by the process step.
      Specified by:
      getReports in interface org.opengis.metadata.lineage.ProcessStep
      Returns:
      report generated by the process step.
    • setReports

      public void setReports(Collection<? extends org.opengis.metadata.lineage.ProcessStepReport> newValues)
      Sets the report generated by the process step.
      Parameters:
      newValues - the new process step report values.
    • getReference

      private Collection<org.opengis.metadata.citation.Citation> getReference()
      Invoked by JAXB at both marshalling and unmarshalling time. This attribute has been added by ISO 19115:2014 standard. If (and only if) marshalling an older standard version, we omit this attribute.