Class DefaultProcessStep

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultProcessStep

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object, Process­Step

@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_Process­Step └─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

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ModifiableMetadata

Modifiable­Metadata.State

Modifier and Type	Class	Description
static enum	Modifiable­Metadata.State	Whether the metadata is still editable or has been made final.

Field Summary

Fields inherited from class ISOMetadata

identifiers

Modifier and Type	Field	Description
protected Collection<Identifier>	identifiers	All identifiers associated with this metadata, or null if none.

Constructor Summary

Constructors

Constructor	Description
Default­Process­Step()	Creates an initially empty process step.
Default­Process­Step(Char­Sequence description)	Creates a process step initialized to the given description.
Default­Process­Step(Process­Step object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
static Default­Process­Step	cast­Or­Copy(Process­Step object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Date	get­Date()	Deprecated. As of ISO 19115-1:2014, replaced by get­Step­Date­Time().
International­String	get­Description()	Returns the description of the event, including related parameters or tolerances.
Collection<Source>	get­Outputs()	Returns the description of the product generated as a result of the process step.
Processing	get­Processing­Information()	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<Responsible­Party>	get­Processors()	Returns the identification of, and means of communication with, person(s) and organization(s) associated with the process step.
International­String	get­Rationale()	Returns the requirement or purpose for the process step.
Collection<Citation>	get­References()	Returns the process step documentation.
Collection<Process­Step­Report>	get­Reports()	Returns the report generated by the process step.
Scope	get­Scope()	Returns the type of resource and / or extent to which the process step applies.
Collection<Source>	get­Sources()	Returns the information about the source data used in creating the data specified by the scope.
Temporal­Primitive	get­Step­Date­Time()	Returns the date, time or range of date and time over which the process step occurred.
void	set­Date(Date new­Value)	Deprecated. As of ISO 19115-1:2014, replaced by set­Step­Date­Time(Temporal­Primitive).
void	set­Description(International­String new­Value)	Sets the description of the event, including related parameters or tolerances.
void	set­Outputs(Collection<? extends Source> new­Values)	Sets the description of the product generated as a result of the process step.
void	set­Processing­Information(Processing new­Value)	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	set­Processors(Collection<? extends Responsible­Party> new­Values)	Identification of, and means of communication with, person(s) and organization(s) associated with the process step.
void	set­Rationale(International­String new­Value)	Sets the requirement or purpose for the process step.
void	set­References(Collection<? extends Citation> new­Values)	Sets the process step documentation.
void	set­Reports(Collection<? extends Process­Step­Report> new­Values)	Sets the report generated by the process step.
void	set­Scope(Scope new­Value)	Sets the type of resource and / or extent to which the process step applies.
void	set­Sources(Collection<? extends Source> new­Values)	Information about the source data used in creating the data specified by the scope.
void	set­Step­Date­Time(Temporal­Primitive new­Value)	Sets the date, time or range of date and time over which the process step occurred.

Methods inherited from class ISOMetadata

get­Identifier, get­Identifier­Map, get­Identifiers, get­Standard, set­Identifier

Modifier and Type	Method	Description
protected Identifier	get­Identifier()	Returns the first identifier which is presumed to be defined by ISO 19115 conceptual model.
Identifier­Map	get­Identifier­Map()	A map view of the identifiers collection as (authority, code) entries.
Collection<Identifier>	get­Identifiers()	Returns all identifiers associated with this object (from conceptual model and from XML document).
Metadata­Standard	get­Standard()	Returns the metadata standard implemented by subclasses, which is ISO 19115.
protected void	set­Identifier(Identifier new­Value)	Sets the identifier for metadata objects that are expected to contain at most one ISO 19115 identifier.

Methods inherited from class ModifiableMetadata

check­Write­Permission, copy­Collection, copy­List, copy­Map, copy­Set, deep­Copy, merge, non­Null­Collection, non­Null­List, non­Null­Map, non­Null­Set, singleton, state, write­Collection, write­List, write­Map, write­Set

Modifier and Type	Method	Description
protected void	check­Write­Permission(Object current)	Checks if changes in the metadata are allowed.
protected static <E> Collection<E>	copy­Collection(Collection<? extends E> source, Class<E> element­Type)	Creates a list or set with the content of the source collection, or returns null if the source is null or empty.
protected static <E> List<E>	copy­List(Collection<? extends E> source, Class<E> element­Type)	Creates a list with the content of the source collection, or returns null if the source is null or empty.
protected static <K,V> Map<K,V>	copy­Map(Map<? extends K, ? extends V> source, Class<K> key­Type)	Creates a map with the content of the source map, or returns null if the source is null or empty.
protected static <E> Set<E>	copy­Set(Collection<? extends E> source, Class<E> element­Type)	Creates a set with the content of the source collection, or returns null if the source is null or empty.
Modifiable­Metadata	deep­Copy(Modifiable­Metadata.State target)	Copies (if necessary) this metadata and all its children.
void	merge(Object source)	Merges the data from the given source into this metadata.
protected final <E> Collection<E>	non­Null­Collection(Collection<E> current, Class<E> element­Type)	Returns the specified collection, or a new one if current is null.
protected final <E> List<E>	non­Null­List(List<E> current, Class<E> element­Type)	Returns the specified list, or a new one if current is null.
protected final <K,V> Map<K,V>	non­Null­Map(Map<K,V> current, Class<K> key­Type)	Returns the specified map, or a new one if current is null.
protected final <E> Set<E>	non­Null­Set(Set<E> current, Class<E> element­Type)	Returns the specified set, or a new one if current is null.
protected static <E> Collection<E>	singleton(E value, Class<E> element­Type)	Creates a singleton list or set containing only the given value, if non-null.
Modifiable­Metadata.State	state()	Tells whether this instance of metadata is editable.
protected final <E> Collection<E>	write­Collection(Collection<? extends E> source, Collection<E> target, Class<E> element­Type)	Writes the content of the source collection into the target list or set, creating it if needed.
protected final <E> List<E>	write­List(Collection<? extends E> source, List<E> target, Class<E> element­Type)	Writes the content of the source collection into the target list, creating it if needed.
protected final <K,V> Map<K,V>	write­Map(Map<? extends K, ? extends V> source, Map<K,V> target, Class<K> key­Type)	Writes the content of the source map into the target map, creating it if needed.
protected final <E> Set<E>	write­Set(Collection<? extends E> source, Set<E> target, Class<E> element­Type)	Writes the content of the source collection into the target set, creating it if needed.

Methods inherited from class AbstractMetadata

as­Map, as­Tree­Table, clone, equals, equals, get­Interface, get­Standard­Type, hash­Code, is­Empty, nil­Reasons, prune, to­String

Modifier and Type	Method	Description
Map<String,Object>	as­Map()	Returns a view of the property values in a Map.
Tree­Table	as­Tree­Table()	Returns the property types and values as a tree table.
protected Abstract­Metadata	clone()	Returns a shallow clone of this metadata.
final boolean	equals(Object object)	Performs a strict comparison of this metadata with the given object.
boolean	equals(Object object, Comparison­Mode mode)	Compares this metadata with the specified object for equality.
final Class<?>	get­Interface()	Deprecated, for removal: This API element is subject to removal in a future version. Renamed Abstract­Metadata.get­Standard­Type() for integration with Lenient­Comparable.
Type	get­Standard­Type()	Returns the metadata interface implemented by this class.
int	hash­Code()	Computes a hash code value for this metadata using Java reflection.
boolean	is­Empty()	Returns true if this metadata contains only null, nil or empty properties.
Map<String, Nil­Reason>	nil­Reasons()	Returns a view of the reasons why some properties are missing.
void	prune()	Removes all references to empty properties.
String	to­String()	Returns a string representation of this metadata.

Methods inherited from class Object

finalize, get­Class, notify, notify­All, wait, wait, wait

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(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:

• cast­Or­Copy(Process­Step)

Method Details

castOrCopy

public static DefaultProcessStep castOrCopy(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 Default­Process­Step, then it is returned unchanged.
• Otherwise a new Default­Process­Step 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 InternationalString getDescription()

Returns the description of the event, including related parameters or tolerances.

Specified by:

get­Description in interface Process­Step

Returns:

description of the event, or null.

setDescription

public void setDescription(InternationalString newValue)

Sets the description of the event, including related parameters or tolerances.

Parameters:

new­Value - the new description.

getRationale

public InternationalString getRationale()

Returns the requirement or purpose for the process step.

Specified by:

get­Rationale in interface Process­Step

Returns:

requirement or purpose for the process step, or null.

setRationale

public void setRationale(InternationalString newValue)

Sets the requirement or purpose for the process step.

Parameters:

new­Value - the new rationale.

getStepDateTime

public 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(TemporalPrimitive newValue)

Sets the date, time or range of date and time over which the process step occurred.

Parameters:

new­Value - the new date, time or period.

Since:

1.0

getDate

@Deprecated(since="1.0")
public Date getDate()

Deprecated.

As of ISO 19115-1:2014, replaced by get­Step­Date­Time().

Returns the date and time or range of date and time on or over which the process step occurred.

Specified by:

get­Date in interface Process­Step

Returns:

date on or over which the process step occurred, or null.

setDate

@Deprecated(since="1.0")
public void setDate(Date newValue)

Deprecated.

As of ISO 19115-1:2014, replaced by set­Step­Date­Time(Temporal­Primitive).

Sets the date and time or range of date and time on or over which the process step occurred.

Parameters:

new­Value - 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.

Upcoming API change — generalization
As of ISO 19115:2014, Responsible­Party is replaced by the Responsibility parent interface. This change may be applied in GeoAPI 4.0.

Specified by:

get­Processors in interface Process­Step

Returns:

means of communication with person(s) and organization(s) associated with the process step.

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.

Upcoming API change — generalization
As of ISO 19115:2014, Responsible­Party is replaced by the Responsibility parent interface. This change may be applied in GeoAPI 4.0.

Parameters:

new­Values - 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

setReferences

public void setReferences(Collection<? extends Citation> newValues)

Sets the process step documentation.

Parameters:

new­Values - the new documentation.

Since:

0.5

getScope

@UML(identifier="scope",
     obligation=OPTIONAL,
     specification=ISO_19115)
public 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(Scope newValue)

Sets the type of resource and / or extent to which the process step applies.

Parameters:

new­Value - the new type of resource.

Since:

0.5

getSources

public Collection<Source> getSources()

Returns the information about the source data used in creating the data specified by the scope.

Specified by:

get­Sources in interface Process­Step

Returns:

information about the source data used in creating the data.

setSources

public void setSources(Collection<? extends Source> newValues)

Information about the source data used in creating the data specified by the scope.

Parameters:

new­Values - the new sources.

getOutputs

public Collection<Source> getOutputs()

Returns the description of the product generated as a result of the process step.

Specified by:

get­Outputs in interface Process­Step

Returns:

product generated as a result of the process step.

setOutputs

public void setOutputs(Collection<? extends Source> newValues)

Sets the description of the product generated as a result of the process step.

Parameters:

new­Values - the new output values.

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.

Specified by:

get­Processing­Information in interface Process­Step

Returns:

procedure by which the algorithm was applied to derive geographic data, or null.

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:

new­Value - the new processing information value.

getReports

public Collection<ProcessStepReport> getReports()

Returns the report generated by the process step.

Specified by:

get­Reports in interface Process­Step

Returns:

report generated by the process step.

setReports

public void setReports(Collection<? extends ProcessStepReport> newValues)

Sets the report generated by the process step.

Parameters:

new­Values - the new process step report values.