Class DefaultScopeDescription
Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
DefaultScopeDescription
- All Implemented Interfaces:
- Serializable,- Emptiable,- LenientComparable,- IdentifiedObject,- ScopeDescription
Description of the class of information covered by the information.
 The following properties are mandatory or conditional (i.e. mandatory under some circumstances)
 in a well-formed metadata according ISO 19115:
 
 ISO 19115 defines 
MD_ScopeDescription
   ├─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.ScopeDescription as an union (in the C/C++ sense):
 only one of the properties in this class can be set to a non-empty value.
 Setting any property to a non-empty value discard all the other ones.
 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:
Defined in the sis-metadata module
- 
Nested Class SummaryNested classes/interfaces inherited from class ModifiableMetadataModifiableMetadata.State
- 
Field SummaryFields inherited from class ISOMetadataidentifiers
- 
Constructor SummaryConstructorsConstructorDescriptionCreates an initially empty scope description.Constructs a new instance initialized with the values from the specified metadata object.
- 
Method SummaryModifier and TypeMethodDescriptionstatic DefaultScopeDescriptioncastOrCopy(ScopeDescription object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Returns the attribute instances to which the information applies.Returns the attribute types to which the information applies.Returns the dataset to which the information applies.Returns the feature instances to which the information applies.Returns the feature types to which the information applies.Returns an indication of which property is set, ornullif unknown.Returns the class of information that does not fall into the other categories to which the information applies.voidsetAttributeInstances(Set<? extends AttributeType> newValues) Sets the attribute instances to which the information applies.voidsetAttributes(Set<? extends AttributeType> newValues) Sets the attribute types to which the information applies.voidsetDataset(String newValue) Sets the dataset to which the information applies.voidsetFeatureInstances(Set<? extends FeatureType> newValues) Sets the feature instances to which the information applies.voidsetFeatures(Set<? extends FeatureType> newValues) Sets the feature types to which the information applies.voidsetLevelDescription(ScopeCode level, Set<? extends CharSequence> newValues) Dispatches the given values to a setter method determined by the given hierarchical level.voidSets the class of information that does not fall into the other categories to which the information applies.Methods inherited from class ISOMetadatagetIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionToMethods inherited from class ModifiableMetadatacheckWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSetMethods inherited from class AbstractMetadataasMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
- 
Constructor Details- 
DefaultScopeDescriptionpublic DefaultScopeDescription()Creates an initially empty scope description.
- 
DefaultScopeDescriptionConstructs 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.If the given object contains more than one value, then the first non-null element in the following list has precedence (from wider scope to smaller scope): dataset, features, attributes, feature instances, attribute instances and other. - Parameters:
- object- the metadata to copy values from, or- nullif none.
- See Also:
 
 
- 
- 
Method Details- 
castOrCopyReturns 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
       DefaultScopeDescription, then it is returned unchanged.
- Otherwise a new DefaultScopeDescriptioninstance 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- nullif 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 
- 
getLevelReturns an indication of which property is set, ornullif unknown. This method returns one of the following values depending which property has been set:hierarchical level of the data Scope code Getter method DATASETgetDataset()FEATURE_TYPEgetFeatures()ATTRIBUTE_TYPEgetAttributes()FEATUREgetFeatureInstances()ATTRIBUTEgetAttributeInstances()- Returns:
- an identification of the property which is set, or nullif unknown.
- Since:
- 1.0
- See Also:
 
- 
getDatasetReturns the 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 atScopeCode.DATASETlevel with a “Administrative area A, B & C” description.- Specified by:
- getDatasetin interface- ScopeDescription
- Returns:
- dataset to which the information applies, or null.
 
- 
setDatasetSets the dataset to which the information applies.Effect on other propertiesIf and only if thenewValueis non-null, then this method automatically discards all other properties.- Parameters:
- newValue- the new dataset.
 
- 
getFeaturesReturns the 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 atScopeCode.FEATURE_TYPElevel with a “Administrative area A — Road network” description.ConditionsThis method returns a modifiable collection only if no other property is set. Otherwise, this method returns an unmodifiable empty collection.Upcoming API change: The type of this property may be changed toSet<CharSequence>for ISO 19115:2014 conformance. See GEO-238 for more information.- Specified by:
- getFeaturesin interface- ScopeDescription
- Returns:
- feature types to which the information applies.
 
- 
setFeaturesSets the feature types to which the information applies.Effect on other propertiesIf and only if thenewValueis non-empty, then this method automatically discards all other properties.Upcoming API change: The type of this property may be changed toSet<CharSequence>for ISO 19115:2014 conformance. See GEO-238 for more information.- Parameters:
- newValues- the new feature types.
 
- 
getAttributesReturns the 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 atScopeCode.ATTRIBUTE_TYPElevel with a “Administrative area A — Overhead clearance” description.ConditionsThis method returns a modifiable collection only if no other property is set. Otherwise, this method returns an unmodifiable empty collection.Upcoming API change: The type of this property may be changed toSet<CharSequence>for ISO 19115:2014 conformance. See GEO-238 for more information.- Specified by:
- getAttributesin interface- ScopeDescription
- Returns:
- attribute types to which the information applies.
 
- 
setAttributesSets the attribute types to which the information applies.Effect on other propertiesIf and only if thenewValueis non-empty, then this method automatically discards all other properties.Upcoming API change: The type of this property may be changed toSet<CharSequence>for ISO 19115:2014 conformance. See GEO-238 for more information.- Parameters:
- newValues- the new attribute types.
 
- 
getFeatureInstancesReturns the feature instances to which the information applies.Example: If a new bridge is constructed in a road network, the change can be recorded atScopeCode.FEATURElevel with a “Administrative area A — New bridge” description.ConditionsThis method returns a modifiable collection only if no other property is set. Otherwise, this method returns an unmodifiable empty collection.Upcoming API change: The type of this property may be changed toSet<CharSequence>for ISO 19115:2014 conformance. See GEO-238 for more information.- Specified by:
- getFeatureInstancesin interface- ScopeDescription
- Returns:
- feature instances to which the information applies.
 
- 
setFeatureInstancesSets the feature instances to which the information applies.Effect on other propertiesIf and only if thenewValueis non-empty, then this method automatically discards all other properties.Upcoming API change: The type of this property may be changed toSet<CharSequence>for ISO 19115:2014 conformance. See GEO-238 for more information.- Parameters:
- newValues- the new feature instances.
 
- 
getAttributeInstancesReturns the attribute instances to which the information applies.Example: If the overhead clearance of a new bridge was wrongly recorded, the correction can be recorded atScopeCode.ATTRIBUTElevel with a “Administrative area A — New bridge — Overhead clearance” description.ConditionsThis method returns a modifiable collection only if no other property is set. Otherwise, this method returns an unmodifiable empty collection.Upcoming API change: The type of this property may be changed toSet<CharSequence>for ISO 19115:2014 conformance. See GEO-238 for more information.- Specified by:
- getAttributeInstancesin interface- ScopeDescription
- Returns:
- attribute instances to which the information applies.
 
- 
setAttributeInstancesSets the attribute instances to which the information applies.Effect on other propertiesIf and only if thenewValueis non-empty, then this method automatically discards all other properties.Upcoming API change: The type of this property may be changed toSet<CharSequence>for ISO 19115:2014 conformance. See GEO-238 for more information.- Parameters:
- newValues- the new attribute instances.
 
- 
getOtherReturns the class of information that does not fall into the other categories to which the information applies.Upcoming API change: The type of this property may be changed toInternationalStringfor ISO 19115:2014 conformance. See GEO-221 for more information.- Specified by:
- getOtherin interface- ScopeDescription
- Returns:
- class of information that does not fall into the other categories, or null.
 
- 
setOtherSets the class of information that does not fall into the other categories to which the information applies.Effect on other propertiesIf and only if thenewValueis non-null, then this method automatically discards all other properties.Upcoming API change: The type of this property may be changed toInternationalStringfor ISO 19115:2014 conformance. See GEO-221 for more information.- Parameters:
- newValue- Other class of information.
 
- 
setLevelDescriptionDispatches the given values to a setter method determined by the given hierarchical level. The mapping between scope codes andScopeDescriptionproperties is documented in thegetLevel()method. If the given scope code is not one of the listed codes, then the "other" property is used.- Parameters:
- level- an identification of the property which is set, or- nullif unknown.
- newValues- the values to set, or- nullif none.
- Since:
- 1.0
- See Also:
 
 
-