Class DefaultScopeDescription

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultScopeDescription

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object, Scope­Description

public class DefaultScopeDescription
extends ISOMetadata
implements 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:

MD_Scope­Description ├─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.

ISO 19115 defines Scope­Description 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 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­Scope­Description()	Creates an initially empty scope description.
Default­Scope­Description(Scope­Description object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
static Default­Scope­Description	cast­Or­Copy(Scope­Description object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Set<Attribute­Type>	get­Attribute­Instances()	Returns the attribute instances to which the information applies.
Set<Attribute­Type>	get­Attributes()	Returns the attribute types to which the information applies.
String	get­Dataset()	Returns the dataset to which the information applies.
Set<Feature­Type>	get­Feature­Instances()	Returns the feature instances to which the information applies.
Set<Feature­Type>	get­Features()	Returns the feature types to which the information applies.
Scope­Code	get­Level()	Returns an indication of which property is set, or null if unknown.
String	get­Other()	Returns the class of information that does not fall into the other categories to which the information applies.
void	set­Attribute­Instances(Set<? extends Attribute­Type> new­Values)	Sets the attribute instances to which the information applies.
void	set­Attributes(Set<? extends Attribute­Type> new­Values)	Sets the attribute types to which the information applies.
void	set­Dataset(String new­Value)	Sets the dataset to which the information applies.
void	set­Feature­Instances(Set<? extends Feature­Type> new­Values)	Sets the feature instances to which the information applies.
void	set­Features(Set<? extends Feature­Type> new­Values)	Sets the feature types to which the information applies.
void	set­Level­Description(Scope­Code level, Set<? extends Char­Sequence> new­Values)	Dispatches the given values to a setter method determined by the given hierarchical level.
void	set­Other(String new­Value)	Sets the class of information that does not fall into the other categories to which the information applies.

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

DefaultScopeDescription

public DefaultScopeDescription()

Creates an initially empty scope description.

DefaultScopeDescription

public DefaultScopeDescription(ScopeDescription 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.

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 null if none.

See Also:

• cast­Or­Copy(Scope­Description)

Method Details

castOrCopy

public static DefaultScopeDescription castOrCopy(ScopeDescription 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­Scope­Description, then it is returned unchanged.
• Otherwise a new Default­Scope­Description 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.

getLevel

public ScopeCode getLevel()

Returns an indication of which property is set, or null if unknown. This method returns one of the following values depending which property has been set:

hierarchical level of the data

Scope code	Getter method
DATASET	getDataset()
FEATURE_TYPE	getFeatures()
ATTRIBUTE_TYPE	getAttributes()
FEATURE	getFeatureInstances()
ATTRIBUTE	getAttributeInstances()

Returns:

an identification of the property which is set, or null if unknown.

Since:

1.0

See Also:

• set­Level­Description(Scope­Code, Set)

getDataset

public String getDataset()

Returns 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 at Scope­Code.DATASET level with a Administrative area A, B & C description.

Specified by:

get­Dataset in interface Scope­Description

Returns:

dataset to which the information applies, or null.

setDataset

public void setDataset(String newValue)

Sets the dataset to which the information applies.

Effect on other properties

If and only if the new­Value is non-null, then this method automatically discards all other properties.

Parameters:

new­Value - the new dataset.

getFeatures

public Set<FeatureType> getFeatures()

Returns 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 at Scope­Code.FEATURE_TYPE level with a Administrative area A — Road network description.

Conditions

This 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 to Set<Char­Sequence> for ISO 19115:2014 conformance. See GEO-238 for more information.

Specified by:

get­Features in interface Scope­Description

Returns:

feature types to which the information applies.

setFeatures

public void setFeatures(Set<? extends FeatureType> newValues)

Sets the feature types to which the information applies.

Effect on other properties

If and only if the new­Value is non-empty, then this method automatically discards all other properties.

Upcoming API change: The type of this property may be changed to Set<Char­Sequence> for ISO 19115:2014 conformance. See GEO-238 for more information.

Parameters:

new­Values - the new feature types.

getAttributes

public Set<AttributeType> getAttributes()

Returns 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 at Scope­Code.ATTRIBUTE_TYPE level with a Administrative area A — Overhead clearance description.

Conditions

This 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 to Set<Char­Sequence> for ISO 19115:2014 conformance. See GEO-238 for more information.

Specified by:

get­Attributes in interface Scope­Description

Returns:

attribute types to which the information applies.

setAttributes

public void setAttributes(Set<? extends AttributeType> newValues)

Sets the attribute types to which the information applies.

Effect on other properties

If and only if the new­Value is non-empty, then this method automatically discards all other properties.

Upcoming API change: The type of this property may be changed to Set<Char­Sequence> for ISO 19115:2014 conformance. See GEO-238 for more information.

Parameters:

new­Values - the new attribute types.

getFeatureInstances

public Set<FeatureType> getFeatureInstances()

Returns the feature instances to which the information applies.

Example

If a new bridge is constructed in a road network, the change can be recorded at Scope­Code.FEATURE level with a Administrative area A — New bridge description.

Conditions

This 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 to Set<Char­Sequence> for ISO 19115:2014 conformance. See GEO-238 for more information.

Specified by:

get­Feature­Instances in interface Scope­Description

Returns:

feature instances to which the information applies.

setFeatureInstances

public void setFeatureInstances(Set<? extends FeatureType> newValues)

Sets the feature instances to which the information applies.

Effect on other properties

If and only if the new­Value is non-empty, then this method automatically discards all other properties.

Upcoming API change: The type of this property may be changed to Set<Char­Sequence> for ISO 19115:2014 conformance. See GEO-238 for more information.

Parameters:

new­Values - the new feature instances.

getAttributeInstances

public Set<AttributeType> getAttributeInstances()

Returns 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 at Scope­Code.ATTRIBUTE level with a Administrative area A — New bridge — Overhead clearance description.

Conditions

This 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 to Set<Char­Sequence> for ISO 19115:2014 conformance. See GEO-238 for more information.

Specified by:

get­Attribute­Instances in interface Scope­Description

Returns:

attribute instances to which the information applies.

setAttributeInstances

public void setAttributeInstances(Set<? extends AttributeType> newValues)

Sets the attribute instances to which the information applies.

Effect on other properties

If and only if the new­Value is non-empty, then this method automatically discards all other properties.

Upcoming API change: The type of this property may be changed to Set<Char­Sequence> for ISO 19115:2014 conformance. See GEO-238 for more information.

Parameters:

new­Values - the new attribute instances.

getOther

public String getOther()

Returns 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 to International­String for ISO 19115:2014 conformance. See GEO-221 for more information.

Specified by:

get­Other in interface Scope­Description

Returns:

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

setOther

public void setOther(String newValue)

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

Effect on other properties

If and only if the new­Value is non-null, then this method automatically discards all other properties.

Upcoming API change: The type of this property may be changed to International­String for ISO 19115:2014 conformance. See GEO-221 for more information.

Parameters:

new­Value - Other class of information.

setLevelDescription

public void setLevelDescription(ScopeCode level,
 Set<? extends CharSequence> newValues)

Dispatches the given values to a setter method determined by the given hierarchical level. The mapping between scope codes and Scope­Description properties is documented in the get­Level() 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 null if unknown.

new­Values - the values to set, or null if none.

Since:

1.0

See Also:

• get­Level()