org.geotoolkit.metadata.iso.lineage
Class DefaultProcessStep

Object
  extended by AbstractMetadata
      extended by ModifiableMetadata
          extended by MetadataEntity
              extended by DefaultProcessStep
All Implemented Interfaces:
Serializable, Cloneable, LenientComparable, IdentifiedObject, ProcessStep

@ThreadSafe
public class DefaultProcessStep
extends MetadataEntity
implements ProcessStep

Description of the event, including related parameters or tolerances.

Since:
2.1
Version:
3.19
Author:
Martin Desruisseaux (IRD, Geomatys), Touraïvane (IRD), Cédric Briançon (Geomatys)
See Also:
Serialized Form
Module:
metadata/geotk-metadata (download)    View source code for this class

Field Summary
 
Fields inherited from class MetadataEntity
identifiers
 
Fields inherited from class AbstractMetadata
LOGGER
 
Constructor Summary
DefaultProcessStep()
          Creates an initially empty process step.
DefaultProcessStep(InternationalString description)
          Creates a process step initialized to the given description.
DefaultProcessStep(ProcessStep source)
          Constructs a metadata entity initialized with the values from the specified metadata.
 
Method Summary
static DefaultProcessStep castOrCopy(ProcessStep object)
          Returns a Geotk metadata implementation with the same values than the given arbitrary implementation.
 Date getDate()
          Returns the date and time or range of date and time on or over which the process step occurred.
 InternationalString getDescription()
          Returns the description of the event, including related parameters or tolerances.
 Collection<Source> getOutputs()
          Returns the description of the product generated as a result of the process step.
 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.
 Collection<ResponsibleParty> getProcessors()
          Returns the identification of, and means of communication with, person(s) and organization(s) associated with the process step.
 InternationalString getRationale()
          Returns the requirement or purpose for the process step.
 Collection<ProcessStepReport> getReports()
          Returns the report generated by the process step.
 Collection<Source> getSources()
          Returns the information about the source data used in creating the data specified by the scope.
 void setDate(Date newValue)
          Sets the date and time or range of date and time on or over which the process step occurred.
 void setDescription(InternationalString newValue)
          Sets the description of the event, including related parameters or tolerances.
 void setOutputs(Collection<? extends Source> newValues)
          Sets the description of the product generated as a result of the process step.
 void setProcessingInformation(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 ResponsibleParty> newValues)
          Identification of, and means of communication with, person(s) and organization(s) associated with the process step.
 void setRationale(InternationalString newValue)
          Sets the requirement or purpose for the process step.
 void setReports(Collection<? extends ProcessStepReport> newValues)
          Sets the report generated by the process step.
 void setSources(Collection<? extends Source> newValues)
          Information about the source data used in creating the data specified by the scope.
 
Methods inherited from class MetadataEntity
getIdentifier, getIdentifierMap, getIdentifiers, getStandard
 
Methods inherited from class ModifiableMetadata
checkWritePermission, clone, collectionType, copyCollection, copyList, copySet, freeze, isModifiable, nonNullCollection, nonNullList, nonNullSet, prune, unmodifiable
 
Methods inherited from class AbstractMetadata
asMap, asTree, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, parse, toString
 
Methods inherited from class Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DefaultProcessStep

public DefaultProcessStep()
Creates an initially empty process step.


DefaultProcessStep

public DefaultProcessStep(ProcessStep source)
Constructs a metadata entity initialized with the values from the specified metadata.

Parameters:
source - The metadata to copy, or null if none.
Since:
2.4

DefaultProcessStep

public DefaultProcessStep(InternationalString description)
Creates a process step initialized to the given description.

Parameters:
description - Description of the event, including related parameters or tolerances.
Method Detail

castOrCopy

public static DefaultProcessStep castOrCopy(ProcessStep object)
Returns a Geotk metadata implementation with the same values than the given arbitrary implementation. If the given object is null, then this method returns null. Otherwise if the given object is already a Geotk implementation, then the given object is returned unchanged. Otherwise a new Geotk implementation is created and initialized to the attribute values of the given object, using a shallow copy operation (i.e. attributes are not cloned).

Parameters:
object - The object to get as a Geotk implementation, or null if none.
Returns:
A Geotk implementation containing the values of the given object (may be the given object itself), or null if the argument was null.
Since:
3.18

getDescription

public InternationalString getDescription()
Returns the description of the event, including related parameters or tolerances.

Specified by:
getDescription in interface ProcessStep

setDescription

public void setDescription(InternationalString newValue)
Sets the description of the event, including related parameters or tolerances.

Parameters:
newValue - The new description.

getRationale

public InternationalString getRationale()
Returns the requirement or purpose for the process step.

Specified by:
getRationale in interface ProcessStep

setRationale

public void setRationale(InternationalString newValue)
Sets the requirement or purpose for the process step.

Parameters:
newValue - The new rationale.

getDate

public Date getDate()
Returns the date and time or range of date and time on or over which the process step occurred.

Specified by:
getDate in interface ProcessStep

setDate

public void setDate(Date newValue)
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<ResponsibleParty> getProcessors()
Returns the identification of, and means of communication with, person(s) and organization(s) associated with the process step.

Specified by:
getProcessors in interface ProcessStep

setProcessors

public void setProcessors(Collection<? extends ResponsibleParty> newValues)
Identification of, and means of communication with, person(s) and organization(s) associated with the process step.

Parameters:
newValues - The new processors.

getSources

public Collection<Source> getSources()
Returns the information about the source data used in creating the data specified by the scope.

Specified by:
getSources in interface ProcessStep

setSources

public void setSources(Collection<? extends Source> newValues)
Information about the source data used in creating the data specified by the scope.

Parameters:
newValues - The new sources.

getOutputs

public Collection<Source> getOutputs()
Returns the description of the product generated as a result of the process step.

Specified by:
getOutputs in interface ProcessStep
Since:
3.03

setOutputs

public void setOutputs(Collection<? extends Source> newValues)
Sets the description of the product generated as a result of the process step.

Parameters:
newValues - The new output values.
Since:
3.03

getProcessingInformation

public 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. null if unspecified.

Specified by:
getProcessingInformation in interface ProcessStep
Since:
3.03

setProcessingInformation

public void setProcessingInformation(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.
Since:
3.03

getReports

public Collection<ProcessStepReport> getReports()
Returns the report generated by the process step.

Specified by:
getReports in interface ProcessStep
Since:
3.03

setReports

public void setReports(Collection<? extends ProcessStepReport> newValues)
Sets the report generated by the process step.

Parameters:
newValues - The new process step report values.
Since:
3.03


Copyright © 2009-2012 Geotoolkit.org. All Rights Reserved.