Class DefaultSource

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultSource

All Implemented Interfaces:

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

@TitleProperty(name="description")
public class DefaultSource
extends ISOMetadata
implements Source

Information about the source data used in creating the data specified by the scope. The following properties are mandatory or conditional (i.e. mandatory under some circumstances) in a well-formed metadata according ISO 19115:

LI_Source ├─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 to which the information applies.

According ISO 19115, at least one of description and source extents 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­Source()	Creates an initially empty source.
Default­Source(Char­Sequence description)	Creates a source initialized with the given description.
Default­Source(Source object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
static Default­Source	cast­Or­Copy(Source object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
International­String	get­Description()	Returns a detailed description of the level of the source data.
Identifier	get­Processed­Level()	Returns the processing level of the source data.
Nominal­Resolution	get­Resolution()	Returns the distance between consistent parts (centre, left side, right side) of two adjacent pixels.
Representative­Fraction	get­Scale­Denominator()	Deprecated. As of ISO 19115:2014, moved to Default­Resolution.get­Equivalent­Scale().
Scope	get­Scope()	Return the type and / or extent of the source.
Citation	get­Source­Citation()	Returns the recommended reference to be used for the source data.
Collection<Extent>	get­Source­Extents()	Deprecated. As of ISO 19115:2014, moved to Default­Scope.get­Extents().
Collection<Citation>	get­Source­Metadata()	Returns the references to metadata for the source.
Reference­System	get­Source­Reference­System()	Returns the spatial reference system used by the source data.
Resolution	get­Source­Spatial­Resolution()	Returns the spatial resolution expressed as a scale factor, an angle or a level of detail.
Collection<Process­Step>	get­Source­Steps()	Returns information about process steps in which this source was used.
void	set­Description(International­String new­Value)	Sets a detailed description of the level of the source data.
void	set­Processed­Level(Identifier new­Value)	Sets the processing level of the source data.
void	set­Resolution(Nominal­Resolution new­Value)	Sets the distance between consistent parts (centre, left side, right side) of two adjacent pixels.
void	set­Scale­Denominator(Representative­Fraction new­Value)	Deprecated. As of ISO 19115:2014, moved to Default­Resolution.set­Equivalent­Scale(Representative­Fraction).
void	set­Scope(Scope new­Value)	Sets the type and / or extent of the source.
void	set­Source­Citation(Citation new­Value)	Sets the recommended reference to be used for the source data.
void	set­Source­Extents(Collection<? extends Extent> new­Values)	Deprecated. As of ISO 19115:2014, moved to Default­Scope.set­Extents(Collection).
void	set­Source­Metadata(Collection<? extends Citation> new­Values)	Sets the references to metadata for the source.
void	set­Source­Reference­System(Reference­System new­Value)	Sets the spatial reference system used by the source data.
void	set­Source­Spatial­Resolution(Resolution new­Value)	Sets the spatial resolution expressed as a scale factor, an angle or a level of detail.
void	set­Source­Steps(Collection<? extends Process­Step> new­Values)	Sets information about process steps in which this source was used.

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

DefaultSource

public DefaultSource()

Creates an initially empty source.

DefaultSource

public DefaultSource(CharSequence description)

Creates a source initialized with the given description.

Parameters:

description - a detailed description of the level of the source data, or null.

DefaultSource

public DefaultSource(Source 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(Source)

Method Details

castOrCopy

public static DefaultSource castOrCopy(Source 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­Source, then it is returned unchanged.
• Otherwise a new Default­Source 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 a detailed description of the level of the source data.

Specified by:

get­Description in interface Source

Returns:

description of the level of the source data, or null.

setDescription

public void setDescription(InternationalString newValue)

Sets a detailed description of the level of the source data.

Parameters:

new­Value - the new description.

getSourceSpatialResolution

@UML(identifier="sourceSpatialResolution",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Resolution getSourceSpatialResolution()

Returns the spatial resolution expressed as a scale factor, an angle or a level of detail.

Returns:

spatial resolution expressed as a scale factor, an angle or a level of detail, or null if none.

Since:

0.5

setSourceSpatialResolution

public void setSourceSpatialResolution(Resolution newValue)

Sets the spatial resolution expressed as a scale factor, an angle or a level of detail.

Parameters:

new­Value - the new spatial resolution.

Since:

0.5

getScaleDenominator

@Deprecated(since="1.0")
public RepresentativeFraction getScaleDenominator()

Deprecated.

As of ISO 19115:2014, moved to Default­Resolution.get­Equivalent­Scale().

Returns the denominator of the representative fraction on a source map. This method fetches the value from the source spatial resolution.

Specified by:

get­Scale­Denominator in interface Source

Returns:

representative fraction on a source map, or null.

setScaleDenominator

@Deprecated(since="1.0")
public void setScaleDenominator(RepresentativeFraction newValue)

Deprecated.

As of ISO 19115:2014, moved to Default­Resolution.set­Equivalent­Scale(Representative­Fraction).

Sets the denominator of the representative fraction on a source map. This method stores the value in the source spatial resolution.

Parameters:

new­Value - the new scale denominator.

getSourceReferenceSystem

public ReferenceSystem getSourceReferenceSystem()

Returns the spatial reference system used by the source data.

Specified by:

get­Source­Reference­System in interface Source

Returns:

spatial reference system used by the source data, or null.

setSourceReferenceSystem

public void setSourceReferenceSystem(ReferenceSystem newValue)

Sets the spatial reference system used by the source data.

Parameters:

new­Value - the new reference system.

getSourceCitation

public Citation getSourceCitation()

Returns the recommended reference to be used for the source data.

Specified by:

get­Source­Citation in interface Source

Returns:

recommended reference to be used for the source data, or null.

setSourceCitation

public void setSourceCitation(Citation newValue)

Sets the recommended reference to be used for the source data.

Parameters:

new­Value - the new source citation.

getSourceMetadata

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

Returns the references to metadata for the source.

Returns:

references to metadata for the source.

Since:

0.5

setSourceMetadata

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

Sets the references to metadata for the source.

Parameters:

new­Values - the new references.

Since:

0.5

getScope

@UML(identifier="scope",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public Scope getScope()

Return the type and / or extent of the source. This information should be provided if the description is not provided.

Returns:

type and / or extent of the source, or null if none.

Since:

0.5

setScope

public void setScope(Scope newValue)

Sets the type and / or extent of the source.

Parameters:

new­Value - the new type and / or extent of the source.

Since:

0.5

getSourceExtents

@Deprecated(since="1.0")
public Collection<Extent> getSourceExtents()

Deprecated.

As of ISO 19115:2014, moved to Default­Scope.get­Extents().

Returns the information about the spatial, vertical and temporal extent of the source data. This method fetches the values from the scope.

Specified by:

get­Source­Extents in interface Source

Returns:

information about the extent of the source data.

setSourceExtents

@Deprecated(since="1.0")
public void setSourceExtents(Collection<? extends Extent> newValues)

Deprecated.

As of ISO 19115:2014, moved to Default­Scope.set­Extents(Collection).

Information about the spatial, vertical and temporal extent of the source data. This method stores the values in the scope.

Parameters:

new­Values - the new source extents.

getSourceSteps

public Collection<ProcessStep> getSourceSteps()

Returns information about process steps in which this source was used.

Specified by:

get­Source­Steps in interface Source

Returns:

information about process steps in which this source was used.

setSourceSteps

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

Sets information about process steps in which this source was used.

Parameters:

new­Values - the new process steps.

getProcessedLevel

public Identifier getProcessedLevel()

Returns the processing level of the source data. null if unspecified.

Specified by:

get­Processed­Level in interface Source

Returns:

processing level of the source data, or null.

setProcessedLevel

public void setProcessedLevel(Identifier newValue)

Sets the processing level of the source data.

Parameters:

new­Value - the new processed level value.

getResolution

public NominalResolution getResolution()

Returns the distance between consistent parts (centre, left side, right side) of two adjacent pixels.

Specified by:

get­Resolution in interface Source

Returns:

distance between consistent parts of two adjacent pixels, or null.

setResolution

public void setResolution(NominalResolution newValue)

Sets the distance between consistent parts (centre, left side, right side) of two adjacent pixels.

Parameters:

new­Value - the new nominal resolution value.