Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
DefaultSource
- All Implemented Interfaces:
Serializable,Emptiable,LenientComparable,IdentifiedObject,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:
According ISO 19115, at least one of description and
source extents shall be provided.
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.
└─levelDescription…………………… Detailed description about the level of the data specified by the scope.
├─attributeInstances…… Attribute instances to which the information applies.
├─attributes………………………… Attributes to which the information applies.
├─dataset………………………………… Dataset to which the information applies.
├─featureInstances………… 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.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:
-
Nested Class Summary
Nested classes/interfaces inherited from class ModifiableMetadata
ModifiableMetadata.State -
Field Summary
Fields inherited from class ISOMetadata
identifiers -
Constructor Summary
ConstructorsConstructorDescriptionCreates an initially empty source.DefaultSource(CharSequence description) Creates a source initialized with the given description.DefaultSource(Source object) Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultSourcecastOrCopy(Source object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Returns a detailed description of the level of the source data.Returns the processing level of the source data.Returns the distance between consistent parts (centre, left side, right side) of two adjacent pixels.Deprecated.Return the type and / or extent of the source.Returns the recommended reference to be used for the source data.Deprecated.As of ISO 19115:2014, moved toDefaultScope.getExtents().Returns the references to metadata for the source.Returns the spatial reference system used by the source data.Returns the spatial resolution expressed as a scale factor, an angle or a level of detail.Returns information about process steps in which this source was used.voidsetDescription(InternationalString newValue) Sets a detailed description of the level of the source data.voidsetProcessedLevel(Identifier newValue) Sets the processing level of the source data.voidsetResolution(NominalResolution newValue) Sets the distance between consistent parts (centre, left side, right side) of two adjacent pixels.voidsetScaleDenominator(RepresentativeFraction newValue) Deprecated.As of ISO 19115:2014, moved toDefaultResolution.setEquivalentScale(RepresentativeFraction).voidSets the type and / or extent of the source.voidsetSourceCitation(Citation newValue) Sets the recommended reference to be used for the source data.voidsetSourceExtents(Collection<? extends Extent> newValues) Deprecated.As of ISO 19115:2014, moved toDefaultScope.setExtents(Collection).voidsetSourceMetadata(Collection<? extends Citation> newValues) Sets the references to metadata for the source.voidsetSourceReferenceSystem(ReferenceSystem newValue) Sets the spatial reference system used by the source data.voidsetSourceSpatialResolution(Resolution newValue) Sets the spatial resolution expressed as a scale factor, an angle or a level of detail.voidsetSourceSteps(Collection<? extends ProcessStep> newValues) Sets information about process steps in which this source was used.Methods inherited from class ISOMetadata
getIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionToMethods inherited from class ModifiableMetadata
checkWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSetMethods inherited from class AbstractMetadata
asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
-
Constructor Details
-
DefaultSource
public DefaultSource()Creates an initially empty source. -
DefaultSource
Creates a source initialized with the given description.- Parameters:
description- a detailed description of the level of the source data, ornull.
-
DefaultSource
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, ornullif none.- See Also:
-
-
Method Details
-
castOrCopy
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 returnsnull. - Otherwise if the given object is already an instance of
DefaultSource, then it is returned unchanged. - Otherwise a new
DefaultSourceinstance 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, ornullif 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
-
getDescription
Returns a detailed description of the level of the source data.- Specified by:
getDescriptionin interfaceSource- Returns:
- description of the level of the source data, or
null.
-
setDescription
Sets a detailed description of the level of the source data.- Parameters:
newValue- 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
nullif none. - Since:
- 0.5
-
setSourceSpatialResolution
Sets the spatial resolution expressed as a scale factor, an angle or a level of detail.- Parameters:
newValue- the new spatial resolution.- Since:
- 0.5
-
getScaleDenominator
Deprecated.As of ISO 19115:2014, moved toDefaultResolution.getEquivalentScale().Returns the denominator of the representative fraction on a source map. This method fetches the value from the source spatial resolution.- Specified by:
getScaleDenominatorin interfaceSource- Returns:
- representative fraction on a source map, or
null.
-
setScaleDenominator
Deprecated.As of ISO 19115:2014, moved toDefaultResolution.setEquivalentScale(RepresentativeFraction).Sets the denominator of the representative fraction on a source map. This method stores the value in the source spatial resolution.- Parameters:
newValue- the new scale denominator.
-
getSourceReferenceSystem
Returns the spatial reference system used by the source data.- Specified by:
getSourceReferenceSystemin interfaceSource- Returns:
- spatial reference system used by the source data, or
null.
-
setSourceReferenceSystem
Sets the spatial reference system used by the source data.- Parameters:
newValue- the new reference system.
-
getSourceCitation
Returns the recommended reference to be used for the source data.- Specified by:
getSourceCitationin interfaceSource- Returns:
- recommended reference to be used for the source data, or
null.
-
setSourceCitation
Sets the recommended reference to be used for the source data.- Parameters:
newValue- 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
Sets the references to metadata for the source.- Parameters:
newValues- the new references.- Since:
- 0.5
-
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
nullif none. - Since:
- 0.5
-
setScope
Sets the type and / or extent of the source.- Parameters:
newValue- the new type and / or extent of the source.- Since:
- 0.5
-
getSourceExtents
Deprecated.As of ISO 19115:2014, moved toDefaultScope.getExtents().Returns the information about the spatial, vertical and temporal extent of the source data. This method fetches the values from the scope.- Specified by:
getSourceExtentsin interfaceSource- Returns:
- information about the extent of the source data.
-
setSourceExtents
Deprecated.As of ISO 19115:2014, moved toDefaultScope.setExtents(Collection).Information about the spatial, vertical and temporal extent of the source data. This method stores the values in the scope.- Parameters:
newValues- the new source extents.
-
getSourceSteps
Returns information about process steps in which this source was used.- Specified by:
getSourceStepsin interfaceSource- Returns:
- information about process steps in which this source was used.
-
setSourceSteps
Sets information about process steps in which this source was used.- Parameters:
newValues- the new process steps.
-
getProcessedLevel
Returns the processing level of the source data.nullif unspecified.- Specified by:
getProcessedLevelin interfaceSource- Returns:
- processing level of the source data, or
null.
-
setProcessedLevel
Sets the processing level of the source data.- Parameters:
newValue- the new processed level value.
-
getResolution
Returns the distance between consistent parts (centre, left side, right side) of two adjacent pixels.- Specified by:
getResolutionin interfaceSource- Returns:
- distance between consistent parts of two adjacent pixels, or
null.
-
setResolution
Sets the distance between consistent parts (centre, left side, right side) of two adjacent pixels.- Parameters:
newValue- the new nominal resolution value.
-
DefaultResolution.getEquivalentScale().