org.apache.sis.metadata.iso.lineage

Class DefaultLineage

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultLineage

All Implemented Interfaces:

Serializable, Cloneable, Emptiable, LenientComparable, IdentifiedObject, Lineage

public class DefaultLineage
extends ISOMetadata
implements Lineage

Information about the events or source data used in constructing the data specified by the scope or lack of knowledge about lineage.

Relationship between properties

At least one of statement, process steps and sources shall be provided.

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

Defined in the sis-metadata module

Field Summary

Fields inherited from class ISOMetadata

identifiers, LOGGER

Constructor Summary

Constructors

Constructor and Description
DefaultLineage() Constructs an initially empty lineage.
DefaultLineage(Lineage object) Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Methods

Modifier and Type	Method and Description
static DefaultLineage	castOrCopy(Lineage object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Collection<Citation>	getAdditionalDocumentation() Returns additional documentation.
Collection<ProcessStep>	getProcessSteps() Returns the information about about events in the life of a resource specified by the scope.
Scope	getScope() Returns the type of resource and / or extents to which the lineage information applies.
Collection<Source>	getSources() Returns information about the source data used in creating the data specified by the scope.
InternationalString	getStatement() Returns the general explanation of the data producer's knowledge about the lineage of a dataset.
void	setAdditionalDocumentation(Collection<? extends Citation> newValues) Sets additional documentation.
void	setProcessSteps(Collection<? extends ProcessStep> newValues) Sets information about events in the life of a resource specified by the scope.
void	setScope(Scope newValue) Sets the type of resource and / or extents to which the lineage information applies.
void	setSources(Collection<? extends Source> newValues) Sets information about the source data used in creating the data specified by the scope.
void	setStatement(InternationalString newValue) Sets the general explanation of the data producer’s knowledge about the lineage of a dataset.

Methods inherited from class ISOMetadata

getIdentifierMap, getIdentifiers, getStandard

Methods inherited from class ModifiableMetadata

checkWritePermission, clone, collectionType, copyCollection, copyList, copySet, freeze, isModifiable, nonNullCollection, nonNullList, nonNullSet, singleton, unmodifiable, writeCollection, writeList, writeSet

Methods inherited from class AbstractMetadata

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

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultLineage

public DefaultLineage()

Constructs an initially empty lineage.

DefaultLineage

public DefaultLineage(Lineage object)

Constructs a new instance initialized with the values from the specified metadata object. This is a shallow copy constructor, since 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:

castOrCopy(Lineage)

Method Detail

castOrCopy

public static DefaultLineage castOrCopy(Lineage 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 DefaultLineage, then it is returned unchanged.
• Otherwise a new DefaultLineage instance is created using the copy constructor and returned. Note that this is a shallow copy operation, since 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.

getStatement

public InternationalString getStatement()

Returns the general explanation of the data producer's knowledge about the lineage of a dataset. Can be provided only if scope level is DATASET or SERIES.

Specified by:

getStatement in interface Lineage

Returns:

Explanation of the data producer's knowledge about the lineage, or null.

setStatement

public void setStatement(InternationalString newValue)

Sets the general explanation of the data producer’s knowledge about the lineage of a dataset.

Parameters:

newValue - The new statement.

getScope

Returns the type of resource and / or extents to which the lineage information applies.

Returns:

Type of resource and / or extents to which the lineage information applies.

Since:

0.5

setScope

public void setScope(Scope newValue)

Sets the type of resource and / or extents to which the lineage information applies.

Parameters:

newValue - The new type of resource.

Since:

0.5

getAdditionalDocumentation

Returns additional documentation.

Returns:

Additional documentation.

Since:

0.5

setAdditionalDocumentation

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

Sets additional documentation.

Parameters:

newValues - Additional documentation.

Since:

0.5

getProcessSteps

public Collection<ProcessStep> getProcessSteps()

Returns the information about about events in the life of a resource specified by the scope.

Specified by:

getProcessSteps in interface Lineage

Returns:

Information about events in the life of a resource.

setProcessSteps

public void setProcessSteps(Collection<? extends ProcessStep> newValues)

Sets information about events in the life of a resource specified by the scope.

Parameters:

newValues - The new process steps.

getSources

public Collection<Source> getSources()

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

Specified by:

getSources in interface Lineage

Returns:

Information about the source data.

setSources

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

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

Parameters:

newValues - The new sources.