Module org.opengis.geoapi

Package org.opengis.metadata.maintenance

Interface ScopeDescription

@Classifier(UNION)
@UML(identifier="MD_ScopeDescription",
     specification=ISO_19115)
public interface ScopeDescription

Description of the class of information covered by the information. Exactly one of the attributes, features, featureInstances, attributeInstances, dataset and other properties shall be provided.

Since:

2.0

Method Summary

Modifier and Type	Method	Description
default Set<? extends AttributeType>	getAttributeInstances()	Attribute instances to which the information applies.
default Set<? extends AttributeType>	getAttributes()	Attribute types to which the information applies.
default String	getDataset()	Dataset to which the information applies.
default Set<? extends FeatureType>	getFeatureInstances()	Feature instances to which the information applies.
default Set<? extends FeatureType>	getFeatures()	Feature types to which the information applies.
default String	getOther()	Class of information that does not fall into the other categories to which the information applies.

Method Details

getDataset

@UML(identifier="dataset",
     obligation=CONDITIONAL,
     specification=ISO_19115)
default String getDataset()

Dataset to which the information applies.

Example: if a geographic data provider is generating vector mapping for the administrative areas and if the data were processed in the same way, then the provider could record the bulk of initial data at ScopeCode.DATASET level with a Administrative area A, B & C description.

Returns:

dataset to which the information applies, or null.

See Also:

• ScopeCode.DATASET

Condition:

features, attributes, featureInstances, attributeInstances and other not provided.

getFeatures

@UML(identifier="features",
     obligation=CONDITIONAL,
     specification=ISO_19115,
     version=2003)
default Set<? extends FeatureType> getFeatures()

Feature types to which the information applies.

Example: if an administrative area performs a complete re-survey of the road network, the change can be recorded at ScopeCode.FEATURE_TYPE level with a Administrative area A — Road network description.

Upcoming API change
As of ISO 19115:2014, the type become Set<? extends CharSequence>. This change may be applied in GeoAPI 4.0.

Returns:

feature types to which the information applies.

See Also:

• ScopeCode.FEATURE_TYPE

Condition:

attributes, featureInstances, attributeInstances, dataset and other not provided.

getAttributes

@UML(identifier="attributes",
     obligation=CONDITIONAL,
     specification=ISO_19115,
     version=2003)
default Set<? extends AttributeType> getAttributes()

Attribute types to which the information applies.

Example: if an administrative area detects an anomaly in all overhead clearance of the road survey, the correction can be recorded at ScopeCode.ATTRIBUTE_TYPE level with a Administrative area A — Overhead clearance description.

Upcoming API change
As of ISO 19115:2014, the type become Set<? extends CharSequence>. This change may be applied in GeoAPI 4.0.

Returns:

attribute types to which the information applies.

See Also:

• ScopeCode.ATTRIBUTE_TYPE

Condition:

features, featureInstances, attributeInstances, dataset and other not provided.

getFeatureInstances

@UML(identifier="featureInstances",
     obligation=CONDITIONAL,
     specification=ISO_19115,
     version=2003)
default Set<? extends FeatureType> getFeatureInstances()

Feature instances to which the information applies.

Example: if a new bridge is constructed in a road network, the change can be recorded at ScopeCode.FEATURE level with a Administrative area A — New bridge description.

Upcoming API change
As of ISO 19115:2014, the type become Set<? extends CharSequence>. This change may be applied in GeoAPI 4.0.

Returns:

feature instances to which the information applies.

See Also:

• ScopeCode.FEATURE

Condition:

features, attributes, attributeInstances, dataset and other not provided.

getAttributeInstances

@UML(identifier="attributeInstances",
     obligation=CONDITIONAL,
     specification=ISO_19115,
     version=2003)
default Set<? extends AttributeType> getAttributeInstances()

Attribute instances to which the information applies.

Example: if the overhead clearance of a new bridge was wrongly recorded, the correction can be recorded at ScopeCode.ATTRIBUTE level with a Administrative area A — New bridge — Overhead clearance description.

Upcoming API change
As of ISO 19115:2014, the type become Set<? extends CharSequence>. This change may be applied in GeoAPI 4.0.

Returns:

attribute instances to which the information applies.

See Also:

• ScopeCode.ATTRIBUTE

Condition:

features, attributes, featureInstances, dataset and other not provided.

getOther

@UML(identifier="other",
     obligation=CONDITIONAL,
     specification=ISO_19115)
default String getOther()

Class of information that does not fall into the other categories to which the information applies.

Upcoming API change — internationalization
The return type will be changed from String to InternationalString in GeoAPI 4.0.

Returns:

class of information that does not fall into the other categories, or null.

Condition:

features, attributes, featureInstances, attributeInstances and dataset not provided.