Class DefaultLineage

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultLineage

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object, Lineage

@TitleProperty(name="statement")
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. The following properties are mandatory or conditional (i.e. mandatory under some circumstances) in a well-formed metadata according ISO 19115:

LI_Lineage ├─statement…………………………………………………………… General explanation of the data producer's knowledge about the lineage of a dataset. ├─process­Step……………………………………………………… Information about an event in the creation process for the data specified by the scope. │ └─description…………………………………………… Description of the event, including related parameters or tolerances. └─source…………………………………………………………………… Information about the source data used in creating the data specified by the scope. ├─description…………………………………………… Detailed description of the level of the source data. └─scope…………………………………………………………… Type and / or extent of the source. ├─level………………………………………………… Hierarchical level of the data specified by the scope. └─level­Description…………………… Detailed description about the level of the data specified by the scope. ├─attribute­Instances…… Attribute instances to which the information applies. ├─attributes………………………… Attributes to which the information applies. ├─dataset………………………………… Dataset to which the information applies. ├─feature­Instances………… Feature instances to which the information applies. ├─features……………………………… Features to which the information applies. └─other……………………………………… Class of information that does not fall into the other categories.

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

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­Lineage()	Constructs an initially empty lineage.
Default­Lineage(Lineage object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
static Default­Lineage	cast­Or­Copy(Lineage object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Collection<Citation>	get­Additional­Documentation()	Returns additional documentation.
Collection<Process­Step>	get­Process­Steps()	Returns the information about about events in the life of a resource specified by the scope.
Scope	get­Scope()	Returns the type of resource and / or extents to which the lineage information applies.
Collection<Source>	get­Sources()	Returns information about the source data used in creating the data specified by the scope.
International­String	get­Statement()	Returns the general explanation of the data producer's knowledge about the lineage of a dataset.
void	set­Additional­Documentation(Collection<? extends Citation> new­Values)	Sets additional documentation.
void	set­Process­Steps(Collection<? extends Process­Step> new­Values)	Sets information about events in the life of a resource specified by the scope.
void	set­Scope(Scope new­Value)	Sets the type of resource and / or extents to which the lineage information applies.
void	set­Sources(Collection<? extends Source> new­Values)	Sets information about the source data used in creating the data specified by the scope.
void	set­Statement(International­String new­Value)	Sets the general explanation of the data producer's knowledge about the lineage of a dataset.

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

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, 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(Lineage)

Method Details

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 Default­Lineage, then it is returned unchanged.
• Otherwise a new Default­Lineage 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.

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:

get­Statement 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:

new­Value - the new statement.

getScope

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

new­Value - the new type of resource.

Since:

0.5

getAdditionalDocumentation

@UML(identifier="additionalDocumentation",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Collection<Citation> getAdditionalDocumentation()

Returns additional documentation.

Returns:

additional documentation.

Since:

0.5

setAdditionalDocumentation

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

Sets additional documentation.

Parameters:

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

get­Process­Steps 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:

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

get­Sources 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:

new­Values - the new sources.