org.geotoolkit.metadata.iso.quality
Class DefaultScope

Object
  AbstractMetadata
      ModifiableMetadata
          MetadataEntity
              DefaultScope

All Implemented Interfaces:

Serializable, Cloneable, LenientComparable, IdentifiedObject, Scope

@ThreadSafe
public class DefaultScope
extends MetadataEntity
implements Scope

Description of the data specified by the scope.

Since:

2.1

Version:

3.19

Author:

Martin Desruisseaux (IRD, Geomatys), Touraïvane (IRD)

See Also:

Serialized Form

Module:

metadata/geotk-metadata (download)

View source code for this class

Field Summary

Fields inherited from class MetadataEntity

identifiers

Fields inherited from class AbstractMetadata

LOGGER

Constructor Summary

DefaultScope()
Constructs an initially empty scope.

DefaultScope(Scope source)
Constructs a metadata entity initialized with the values from the specified metadata.

DefaultScope(ScopeCode level)
Creates a scope initialized to the given level.

Method Summary

static DefaultScope	castOrCopy(Scope object) Returns a Geotk metadata implementation with the same values than the given arbitrary implementation.
Extent	getExtent() Information about the spatial, vertical and temporal extent of the data specified by the scope.
ScopeCode	getLevel() Returns the hierarchical level of the data specified by the scope.
Collection<ScopeDescription>	getLevelDescription() Returns detailed descriptions about the level of the data specified by the scope.
void	setExtent(Extent newValue) Sets information about the spatial, vertical and temporal extent of the data specified by the scope.
void	setLevel(ScopeCode newValue) Sets the hierarchical level of the data specified by the scope.
void	setLevelDescription(Collection<? extends ScopeDescription> newValues) Sets detailed descriptions about the level of the data specified by the scope.

Methods inherited from class MetadataEntity

getIdentifier, getIdentifierMap, getIdentifiers, getStandard

Methods inherited from class ModifiableMetadata

checkWritePermission, clone, collectionType, copyCollection, copyList, copySet, freeze, isModifiable, nonNullCollection, nonNullList, nonNullSet, prune, unmodifiable

Methods inherited from class AbstractMetadata

asMap, asTree, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, parse, toString

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultScope

public DefaultScope()

Constructs an initially empty scope.

DefaultScope

public DefaultScope(Scope source)

Constructs a metadata entity initialized with the values from the specified metadata.

Parameters:

source - The metadata to copy, or null if none.

Since:

2.4

DefaultScope

public DefaultScope(ScopeCode level)

Creates a scope initialized to the given level.

Parameters:

level - The hierarchical level of the data specified by the scope.

Method Detail

castOrCopy

public static DefaultScope castOrCopy(Scope object)

Returns a Geotk metadata implementation with the same values than the given arbitrary implementation. If the given object is null, then this method returns null. Otherwise if the given object is already a Geotk implementation, then the given object is returned unchanged. Otherwise a new Geotk implementation is created and initialized to the attribute values of the given object, using a shallow copy operation (i.e. attributes are not cloned).

Parameters:

object - The object to get as a Geotk implementation, or null if none.

Returns:

A Geotk implementation containing the values of the given object (may be the given object itself), or null if the argument was null.

Since:

3.18

getLevel

public ScopeCode getLevel()

Returns the hierarchical level of the data specified by the scope.

Specified by:

getLevel in interface Scope

setLevel

public void setLevel(ScopeCode newValue)

Sets the hierarchical level of the data specified by the scope.

Parameters:

newValue - The new level.

getLevelDescription

public Collection<ScopeDescription> getLevelDescription()

Returns detailed descriptions about the level of the data specified by the scope. Should be defined only if the level is not equal to DATASET or SERIES.

Specified by:

getLevelDescription in interface Scope

Since:

2.4

setLevelDescription

public void setLevelDescription(Collection<? extends ScopeDescription> newValues)

Sets detailed descriptions about the level of the data specified by the scope.

Parameters:

newValues - The new level description.

Since:

2.4

getExtent

public Extent getExtent()

Information about the spatial, vertical and temporal extent of the data specified by the scope.

Specified by:

getExtent in interface Scope

setExtent

public void setExtent(Extent newValue)

Sets information about the spatial, vertical and temporal extent of the data specified by the scope.

Parameters:

newValue - The new extent.