Class DefaultProcessStep
Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
DefaultProcessStep
- All Implemented Interfaces:
- Serializable,- Emptiable,- LenientComparable,- IdentifiedObject,- ProcessStep
@TitleProperty(name="description")
public class DefaultProcessStep
extends ISOMetadata
implements 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 XMLinstead.
- Since:
- 0.3
- See Also:
Defined in the sis-metadata module
- 
Nested Class SummaryNested classes/interfaces inherited from class ModifiableMetadataModifiableMetadata.State
- 
Field SummaryFields inherited from class ISOMetadataidentifiers
- 
Constructor SummaryConstructorsConstructorDescriptionCreates an initially empty process step.DefaultProcessStep(CharSequence description) Creates a process step initialized to the given description.DefaultProcessStep(ProcessStep object) Constructs a new instance initialized with the values from the specified metadata object.
- 
Method SummaryModifier and TypeMethodDescriptionstatic DefaultProcessStepcastOrCopy(ProcessStep object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.getDate()Deprecated.Returns the description of the event, including related parameters or tolerances.Returns the description of the product generated as a result of the process step.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.Returns the identification of, and means of communication with, person(s) and organization(s) associated with the process step.Returns the requirement or purpose for the process step.Returns the process step documentation.Returns the report generated by the process step.Returns the type of resource and / or extent to which the process step applies.Returns the information about the source data used in creating the data specified by the scope.Returns the date, time or range of date and time over which the process step occurred.voidDeprecated.As of ISO 19115-1:2014, replaced bysetStepDateTime(TemporalPrimitive).voidsetDescription(InternationalString newValue) Sets the description of the event, including related parameters or tolerances.voidsetOutputs(Collection<? extends Source> newValues) Sets the description of the product generated as a result of the process step.voidsetProcessingInformation(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.voidsetProcessors(Collection<? extends ResponsibleParty> newValues) Identification of, and means of communication with, person(s) and organization(s) associated with the process step.voidsetRationale(InternationalString newValue) Sets the requirement or purpose for the process step.voidsetReferences(Collection<? extends Citation> newValues) Sets the process step documentation.voidsetReports(Collection<? extends ProcessStepReport> newValues) Sets the report generated by the process step.voidSets the type of resource and / or extent to which the process step applies.voidsetSources(Collection<? extends Source> newValues) Information about the source data used in creating the data specified by the scope.voidsetStepDateTime(TemporalPrimitive newValue) Sets the date, time or range of date and time over which the process step occurred.Methods inherited from class ISOMetadatagetIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionToMethods inherited from class ModifiableMetadatacheckWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSetMethods inherited from class AbstractMetadataasMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
- 
Constructor Details- 
DefaultProcessSteppublic DefaultProcessStep()Creates an initially empty process step.
- 
DefaultProcessStepCreates a process step initialized to the given description.- Parameters:
- description- description of the event, including related parameters or tolerances.
 
- 
DefaultProcessStepConstructs 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- nullif none.
- See Also:
 
 
- 
- 
Method Details- 
castOrCopyReturns 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 returnsnull.
- Otherwise if the given object is already an instance of
       DefaultProcessStep, then it is returned unchanged.
- Otherwise a new DefaultProcessStepinstance 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- nullif none.
- Returns:
- a SIS implementation containing the values of the given object (may be the
         given object itself), or nullif the argument was null.
 
- If the given object is 
- 
getDescriptionReturns the description of the event, including related parameters or tolerances.- Specified by:
- getDescriptionin interface- ProcessStep
- Returns:
- description of the event, or null.
 
- 
setDescriptionSets the description of the event, including related parameters or tolerances.- Parameters:
- newValue- the new description.
 
- 
getRationaleReturns the requirement or purpose for the process step.- Specified by:
- getRationalein interface- ProcessStep
- Returns:
- requirement or purpose for the process step, or null.
 
- 
setRationaleSets the requirement or purpose for the process step.- Parameters:
- newValue- the new rationale.
 
- 
getStepDateTimeReturns 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
 
- 
setStepDateTimeSets 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
 
- 
getDateDeprecated.As of ISO 19115-1:2014, replaced bygetStepDateTime().Returns the date and time or range of date and time on or over which the process step occurred.- Specified by:
- getDatein interface- ProcessStep
- Returns:
- date on or over which the process step occurred, or null.
 
- 
setDateDeprecated.As of ISO 19115-1:2014, replaced bysetStepDateTime(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.
 
- 
getProcessorsReturns 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,ResponsiblePartyis replaced by theResponsibilityparent interface. This change may be applied in GeoAPI 4.0.- Specified by:
- getProcessorsin interface- ProcessStep
- Returns:
- means of communication with person(s) and organization(s) associated with the process step.
 
- 
setProcessorsIdentification 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,ResponsiblePartyis replaced by theResponsibilityparent 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<Citation> getReferences()Returns the process step documentation.- Returns:
- process step documentation.
- Since:
- 0.5
 
- 
setReferencesSets the process step documentation.- Parameters:
- newValues- the new documentation.
- Since:
- 0.5
 
- 
getScopeReturns the type of resource and / or extent to which the process step applies.- Returns:
- type of resource, or nullif none.
- Since:
- 0.5
 
- 
setScopeSets the type of resource and / or extent to which the process step applies.- Parameters:
- newValue- the new type of resource.
- Since:
- 0.5
 
- 
getSourcesReturns the information about the source data used in creating the data specified by the scope.- Specified by:
- getSourcesin interface- ProcessStep
- Returns:
- information about the source data used in creating the data.
 
- 
setSourcesInformation about the source data used in creating the data specified by the scope.- Parameters:
- newValues- the new sources.
 
- 
getOutputsReturns the description of the product generated as a result of the process step.- Specified by:
- getOutputsin interface- ProcessStep
- Returns:
- product generated as a result of the process step.
 
- 
setOutputsSets the description of the product generated as a result of the process step.- Parameters:
- newValues- the new output values.
 
- 
getProcessingInformationReturns 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:
- getProcessingInformationin interface- ProcessStep
- Returns:
- procedure by which the algorithm was applied to derive geographic data, or null.
 
- 
setProcessingInformationSets 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.
 
- 
getReportsReturns the report generated by the process step.- Specified by:
- getReportsin interface- ProcessStep
- Returns:
- report generated by the process step.
 
- 
setReportsSets the report generated by the process step.- Parameters:
- newValues- the new process step report values.
 
 
- 
getStepDateTime().